POST api/HouseholdApplication/Submit
Request Information
URI Parameters
None.
Body Parameters
HouseholdApplicationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DistrictId | integer |
None. |
|
| IPAddress | string |
None. |
|
| Students | Collection of Student |
None. |
|
| Children | Collection of Child |
None. |
|
| CaseInfo | CaseInfo |
None. |
|
| ContactInfo | ContactInfo |
None. |
|
| Adults | Collection of Adult |
None. |
|
| SummaryHTML | string |
None. |
|
| LanguageId | Language |
None. |
|
| ReleaseCategories | string |
None. |
|
| AlternateIncomeFamilySize | integer |
None. |
|
| AlternateIncomeAmount | integer |
None. |
|
| AlternateIncomeEmail | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"DistrictId": 1,
"IPAddress": "sample string 2",
"Students": [
{
"SiteId": "sample string 1",
"Grade": "sample string 2",
"DOB": "sample string 3",
"StudentNumber": "sample string 4",
"Foster": true,
"RaceId": [
1,
1
],
"IsHispanic": true,
"Homeless": true,
"Migrant": true,
"Runaway": true,
"KinGap": true,
"FirstName": "sample string 10",
"LastName": "sample string 11",
"Suffix": "sample string 12",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
},
{
"SiteId": "sample string 1",
"Grade": "sample string 2",
"DOB": "sample string 3",
"StudentNumber": "sample string 4",
"Foster": true,
"RaceId": [
1,
1
],
"IsHispanic": true,
"Homeless": true,
"Migrant": true,
"Runaway": true,
"KinGap": true,
"FirstName": "sample string 10",
"LastName": "sample string 11",
"Suffix": "sample string 12",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
}
],
"Children": [
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Suffix": "sample string 3",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
},
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Suffix": "sample string 3",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
}
],
"CaseInfo": {
"CaseType": "sample string 1",
"CaseNumber": "sample string 2"
},
"ContactInfo": {
"Phone": "sample string 1",
"Email": "sample string 2",
"StreetAddress1": "sample string 3",
"StreetAddress2": "sample string 4",
"City": "sample string 1",
"State": "sample string 2",
"ZIP": "sample string 3"
},
"Adults": [
{
"isHoh": true,
"ssn": "sample string 2",
"NoSSN": true,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Suffix": "sample string 5",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
},
{
"isHoh": true,
"ssn": "sample string 2",
"NoSSN": true,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Suffix": "sample string 5",
"Income": [
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
},
{
"IncomeType": "sample string 1",
"Amount": 2.0,
"Hours": 3.0,
"Frequency": "sample string 4",
"HourlyPeriod": "sample string 5"
}
]
}
],
"SummaryHTML": "sample string 3",
"LanguageId": 1,
"ReleaseCategories": "sample string 4",
"AlternateIncomeFamilySize": 1,
"AlternateIncomeAmount": 1,
"AlternateIncomeEmail": "sample string 5"
}
application/xml, text/xml
Sample:
<HouseholdApplicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LAP.WebAPI.Models.HouseholdApplication">
<Adults>
<Adult>
<FirstName>sample string 3</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 4</LastName>
<Suffix>sample string 5</Suffix>
<NoSSN>true</NoSSN>
<isHoh>true</isHoh>
<ssn>sample string 2</ssn>
</Adult>
<Adult>
<FirstName>sample string 3</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 4</LastName>
<Suffix>sample string 5</Suffix>
<NoSSN>true</NoSSN>
<isHoh>true</isHoh>
<ssn>sample string 2</ssn>
</Adult>
</Adults>
<AlternateIncomeAmount>1</AlternateIncomeAmount>
<AlternateIncomeEmail>sample string 5</AlternateIncomeEmail>
<AlternateIncomeFamilySize>1</AlternateIncomeFamilySize>
<CaseInfo>
<CaseNumber>sample string 2</CaseNumber>
<CaseType>sample string 1</CaseType>
</CaseInfo>
<Children>
<Child>
<FirstName>sample string 1</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 2</LastName>
<Suffix>sample string 3</Suffix>
</Child>
<Child>
<FirstName>sample string 1</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 2</LastName>
<Suffix>sample string 3</Suffix>
</Child>
</Children>
<ContactInfo>
<City>sample string 1</City>
<Email>sample string 2</Email>
<Phone>sample string 1</Phone>
<State>sample string 2</State>
<StreetAddress1>sample string 3</StreetAddress1>
<StreetAddress2>sample string 4</StreetAddress2>
<ZIP>sample string 3</ZIP>
</ContactInfo>
<DistrictId>1</DistrictId>
<IPAddress>sample string 2</IPAddress>
<LanguageId>English</LanguageId>
<ReleaseCategories>sample string 4</ReleaseCategories>
<Students>
<Student>
<FirstName>sample string 10</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 11</LastName>
<Suffix>sample string 12</Suffix>
<DOB>sample string 3</DOB>
<Foster>true</Foster>
<Grade>sample string 2</Grade>
<Homeless>true</Homeless>
<IsHispanic>true</IsHispanic>
<KinGap>true</KinGap>
<Migrant>true</Migrant>
<RaceId xmlns:d4p1="http://schemas.datacontract.org/2004/07/LAP.Library">
<d4p1:General.RaceEnum>AmericanIndianOrAlaskaNative</d4p1:General.RaceEnum>
<d4p1:General.RaceEnum>AmericanIndianOrAlaskaNative</d4p1:General.RaceEnum>
</RaceId>
<Runaway>true</Runaway>
<SiteId>sample string 1</SiteId>
<StudentNumber>sample string 4</StudentNumber>
</Student>
<Student>
<FirstName>sample string 10</FirstName>
<Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
<Income>
<Amount>2</Amount>
<Frequency>sample string 4</Frequency>
<HourlyPeriod>sample string 5</HourlyPeriod>
<Hours>3</Hours>
<IncomeType>sample string 1</IncomeType>
</Income>
</Income>
<LastName>sample string 11</LastName>
<Suffix>sample string 12</Suffix>
<DOB>sample string 3</DOB>
<Foster>true</Foster>
<Grade>sample string 2</Grade>
<Homeless>true</Homeless>
<IsHispanic>true</IsHispanic>
<KinGap>true</KinGap>
<Migrant>true</Migrant>
<RaceId xmlns:d4p1="http://schemas.datacontract.org/2004/07/LAP.Library">
<d4p1:General.RaceEnum>AmericanIndianOrAlaskaNative</d4p1:General.RaceEnum>
<d4p1:General.RaceEnum>AmericanIndianOrAlaskaNative</d4p1:General.RaceEnum>
</RaceId>
<Runaway>true</Runaway>
<SiteId>sample string 1</SiteId>
<StudentNumber>sample string 4</StudentNumber>
</Student>
</Students>
<SummaryHTML>sample string 3</SummaryHTML>
</HouseholdApplicationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |