POST api/AddHouseholdMembers?OnlineAppId={OnlineAppId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OnlineAppId

integer

Required

Body Parameters

HouseholdMembersModels
NameDescriptionTypeAdditional information
Name

string

None.
OnlineHouseholdId

integer

None.
IsStudent

boolean

None.
IncomeType

string

None.
IncomeAmount

string

None.
Frequency

string

None.
PFD

string

None.
IsApplicant

boolean

None.
PFDAmounts

boolean

None.
LoadApp

boolean

None.
FirstName

string

None.
LastName

string

None.
MiddleName

string

None.
HasIncome

boolean

None.
PFDPreviousyear

boolean

None.
PFDCurrentyear

boolean

None.
householdIncome

Collection of HouseholdIncome

None.
FrequencyDescription

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "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"
}

application/xml, text/xml

Sample: 
<HouseholdMembersModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.HouseholdMembers">
  <FirstName>sample string 6</FirstName>
  <Frequency>sample string 4</Frequency>
  <FrequencyDescription>sample string 9</FrequencyDescription>
  <HasIncome>true</HasIncome>
  <IncomeAmount>sample string 3</IncomeAmount>
  <IncomeType>sample string 2</IncomeType>
  <IsApplicant>true</IsApplicant>
  <IsStudent>true</IsStudent>
  <LastName>sample string 7</LastName>
  <LoadApp>true</LoadApp>
  <MiddleName>sample string 8</MiddleName>
  <Name>sample string 1</Name>
  <OnlineHouseholdId>1</OnlineHouseholdId>
  <PFD>sample string 5</PFD>
  <PFDAmounts>true</PFDAmounts>
  <PFDCurrentyear>true</PFDCurrentyear>
  <PFDPreviousyear>true</PFDPreviousyear>
  <householdIncome>
    <HouseholdIncome>
      <Amount>1</Amount>
      <IncomeFrequency>sample string 3</IncomeFrequency>
      <IncomePeriodCd>sample string 1</IncomePeriodCd>
      <IncomeType>1</IncomeType>
      <IncomeTypeDescription>sample string 2</IncomeTypeDescription>
      <OnlineAppIncomeId>1</OnlineAppIncomeId>
      <OnlineHouseholdId>1</OnlineHouseholdId>
    </HouseholdIncome>
    <HouseholdIncome>
      <Amount>1</Amount>
      <IncomeFrequency>sample string 3</IncomeFrequency>
      <IncomePeriodCd>sample string 1</IncomePeriodCd>
      <IncomeType>1</IncomeType>
      <IncomeTypeDescription>sample string 2</IncomeTypeDescription>
      <OnlineAppIncomeId>1</OnlineAppIncomeId>
      <OnlineHouseholdId>1</OnlineHouseholdId>
    </HouseholdIncome>
  </householdIncome>
</HouseholdMembersModels>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'HouseholdMembersModels'.

Response Information

Resource Description

JsonResponseModel
NameDescriptionTypeAdditional information
Id

integer

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<JsonResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models">
  <Id>1</Id>
  <Message>sample string 2</Message>
</JsonResponseModel>