GET api/GetHouseholdMembers?OnlineAppId={OnlineAppId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OnlineAppId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Pair of Collection of HouseholdMembersModels [key] and boolean [value]Response Formats
application/json, text/json
Sample:
{
"Key": [
{
"Name": "sample string 1",
"OnlineHouseholdId": 1,
"IsStudent": true,
"IncomeType": "sample string 2",
"IncomeAmount": "sample string 3",
"Frequency": "sample string 4",
"PFD": "sample string 5",
"IsApplicant": true,
"PFDAmounts": true,
"LoadApp": true,
"FirstName": "sample string 6",
"LastName": "sample string 7",
"MiddleName": "sample string 8",
"HasIncome": true,
"PFDPreviousyear": true,
"PFDCurrentyear": true,
"householdIncome": [
{
"OnlineAppIncomeId": 1,
"OnlineHouseholdId": 1,
"IncomeType": 1,
"Amount": 1.0,
"IncomePeriodCd": "sample string 1",
"IncomeTypeDescription": "sample string 2",
"IncomeFrequency": "sample string 3"
},
{
"OnlineAppIncomeId": 1,
"OnlineHouseholdId": 1,
"IncomeType": 1,
"Amount": 1.0,
"IncomePeriodCd": "sample string 1",
"IncomeTypeDescription": "sample string 2",
"IncomeFrequency": "sample string 3"
}
],
"FrequencyDescription": "sample string 9"
},
{
"Name": "sample string 1",
"OnlineHouseholdId": 1,
"IsStudent": true,
"IncomeType": "sample string 2",
"IncomeAmount": "sample string 3",
"Frequency": "sample string 4",
"PFD": "sample string 5",
"IsApplicant": true,
"PFDAmounts": true,
"LoadApp": true,
"FirstName": "sample string 6",
"LastName": "sample string 7",
"MiddleName": "sample string 8",
"HasIncome": true,
"PFDPreviousyear": true,
"PFDCurrentyear": true,
"householdIncome": [
{
"OnlineAppIncomeId": 1,
"OnlineHouseholdId": 1,
"IncomeType": 1,
"Amount": 1.0,
"IncomePeriodCd": "sample string 1",
"IncomeTypeDescription": "sample string 2",
"IncomeFrequency": "sample string 3"
},
{
"OnlineAppIncomeId": 1,
"OnlineHouseholdId": 1,
"IncomeType": 1,
"Amount": 1.0,
"IncomePeriodCd": "sample string 1",
"IncomeTypeDescription": "sample string 2",
"IncomeFrequency": "sample string 3"
}
],
"FrequencyDescription": "sample string 9"
}
],
"Value": true
}
application/xml, text/xml
Sample:
<KeyValuePairOfArrayOfHouseholdMembersModelsboolean3Hsy9yPL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<key xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.HouseholdMembers">
<d2p1:HouseholdMembersModels>
<d2p1:FirstName>sample string 6</d2p1:FirstName>
<d2p1:Frequency>sample string 4</d2p1:Frequency>
<d2p1:FrequencyDescription>sample string 9</d2p1:FrequencyDescription>
<d2p1:HasIncome>true</d2p1:HasIncome>
<d2p1:IncomeAmount>sample string 3</d2p1:IncomeAmount>
<d2p1:IncomeType>sample string 2</d2p1:IncomeType>
<d2p1:IsApplicant>true</d2p1:IsApplicant>
<d2p1:IsStudent>true</d2p1:IsStudent>
<d2p1:LastName>sample string 7</d2p1:LastName>
<d2p1:LoadApp>true</d2p1:LoadApp>
<d2p1:MiddleName>sample string 8</d2p1:MiddleName>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
<d2p1:PFD>sample string 5</d2p1:PFD>
<d2p1:PFDAmounts>true</d2p1:PFDAmounts>
<d2p1:PFDCurrentyear>true</d2p1:PFDCurrentyear>
<d2p1:PFDPreviousyear>true</d2p1:PFDPreviousyear>
<d2p1:householdIncome>
<d2p1:HouseholdIncome>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:IncomeFrequency>sample string 3</d2p1:IncomeFrequency>
<d2p1:IncomePeriodCd>sample string 1</d2p1:IncomePeriodCd>
<d2p1:IncomeType>1</d2p1:IncomeType>
<d2p1:IncomeTypeDescription>sample string 2</d2p1:IncomeTypeDescription>
<d2p1:OnlineAppIncomeId>1</d2p1:OnlineAppIncomeId>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
</d2p1:HouseholdIncome>
<d2p1:HouseholdIncome>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:IncomeFrequency>sample string 3</d2p1:IncomeFrequency>
<d2p1:IncomePeriodCd>sample string 1</d2p1:IncomePeriodCd>
<d2p1:IncomeType>1</d2p1:IncomeType>
<d2p1:IncomeTypeDescription>sample string 2</d2p1:IncomeTypeDescription>
<d2p1:OnlineAppIncomeId>1</d2p1:OnlineAppIncomeId>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
</d2p1:HouseholdIncome>
</d2p1:householdIncome>
</d2p1:HouseholdMembersModels>
<d2p1:HouseholdMembersModels>
<d2p1:FirstName>sample string 6</d2p1:FirstName>
<d2p1:Frequency>sample string 4</d2p1:Frequency>
<d2p1:FrequencyDescription>sample string 9</d2p1:FrequencyDescription>
<d2p1:HasIncome>true</d2p1:HasIncome>
<d2p1:IncomeAmount>sample string 3</d2p1:IncomeAmount>
<d2p1:IncomeType>sample string 2</d2p1:IncomeType>
<d2p1:IsApplicant>true</d2p1:IsApplicant>
<d2p1:IsStudent>true</d2p1:IsStudent>
<d2p1:LastName>sample string 7</d2p1:LastName>
<d2p1:LoadApp>true</d2p1:LoadApp>
<d2p1:MiddleName>sample string 8</d2p1:MiddleName>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
<d2p1:PFD>sample string 5</d2p1:PFD>
<d2p1:PFDAmounts>true</d2p1:PFDAmounts>
<d2p1:PFDCurrentyear>true</d2p1:PFDCurrentyear>
<d2p1:PFDPreviousyear>true</d2p1:PFDPreviousyear>
<d2p1:householdIncome>
<d2p1:HouseholdIncome>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:IncomeFrequency>sample string 3</d2p1:IncomeFrequency>
<d2p1:IncomePeriodCd>sample string 1</d2p1:IncomePeriodCd>
<d2p1:IncomeType>1</d2p1:IncomeType>
<d2p1:IncomeTypeDescription>sample string 2</d2p1:IncomeTypeDescription>
<d2p1:OnlineAppIncomeId>1</d2p1:OnlineAppIncomeId>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
</d2p1:HouseholdIncome>
<d2p1:HouseholdIncome>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:IncomeFrequency>sample string 3</d2p1:IncomeFrequency>
<d2p1:IncomePeriodCd>sample string 1</d2p1:IncomePeriodCd>
<d2p1:IncomeType>1</d2p1:IncomeType>
<d2p1:IncomeTypeDescription>sample string 2</d2p1:IncomeTypeDescription>
<d2p1:OnlineAppIncomeId>1</d2p1:OnlineAppIncomeId>
<d2p1:OnlineHouseholdId>1</d2p1:OnlineHouseholdId>
</d2p1:HouseholdIncome>
</d2p1:householdIncome>
</d2p1:HouseholdMembersModels>
</key>
<value>true</value>
</KeyValuePairOfArrayOfHouseholdMembersModelsboolean3Hsy9yPL>