GET api/GetVerificationHouseholdMembers?applicationId={applicationId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicationId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of VerificationHouseholdMemberModel
NameDescriptionTypeAdditional information
HouseholdMemberId

integer

None.
ApplicationId

integer

None.
Name

string

None.
HasName

boolean

None.
NoIncome

boolean

None.
PersonId

globally unique identifier

None.
PreviousYearMember

boolean

None.
CurrentYearMember

boolean

None.
UploadDocument

integer

None.
IsFosterChild

string

None.
VerificationHouseholdMemberIncome

Collection of VerificationHouseholdMemberIncomeModel

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "HouseholdMemberId": 1,
    "ApplicationId": 1,
    "Name": "sample string 1",
    "HasName": true,
    "NoIncome": true,
    "PersonId": "eb137c0f-9725-4ee3-a13c-5b9e95d7fb40",
    "PreviousYearMember": true,
    "CurrentYearMember": true,
    "UploadDocument": 2,
    "IsFosterChild": "sample string 3",
    "VerificationHouseholdMemberIncome": [
      {
        "HouseholdMemberIncomeId": 1,
        "HouseholdMemberId": 1,
        "IncomeTypeId": 1,
        "IncomeTypeDescription": "sample string 1",
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 2"
      },
      {
        "HouseholdMemberIncomeId": 1,
        "HouseholdMemberId": 1,
        "IncomeTypeId": 1,
        "IncomeTypeDescription": "sample string 1",
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 2"
      }
    ]
  },
  {
    "HouseholdMemberId": 1,
    "ApplicationId": 1,
    "Name": "sample string 1",
    "HasName": true,
    "NoIncome": true,
    "PersonId": "eb137c0f-9725-4ee3-a13c-5b9e95d7fb40",
    "PreviousYearMember": true,
    "CurrentYearMember": true,
    "UploadDocument": 2,
    "IsFosterChild": "sample string 3",
    "VerificationHouseholdMemberIncome": [
      {
        "HouseholdMemberIncomeId": 1,
        "HouseholdMemberId": 1,
        "IncomeTypeId": 1,
        "IncomeTypeDescription": "sample string 1",
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 2"
      },
      {
        "HouseholdMemberIncomeId": 1,
        "HouseholdMemberId": 1,
        "IncomeTypeId": 1,
        "IncomeTypeDescription": "sample string 1",
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVerificationHouseholdMemberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.VerificationResponse">
  <VerificationHouseholdMemberModel>
    <ApplicationId>1</ApplicationId>
    <CurrentYearMember>true</CurrentYearMember>
    <HasName>true</HasName>
    <HouseholdMemberId>1</HouseholdMemberId>
    <IsFosterChild>sample string 3</IsFosterChild>
    <Name>sample string 1</Name>
    <NoIncome>true</NoIncome>
    <PersonId>eb137c0f-9725-4ee3-a13c-5b9e95d7fb40</PersonId>
    <PreviousYearMember>true</PreviousYearMember>
    <UploadDocument>2</UploadDocument>
    <VerificationHouseholdMemberIncome>
      <VerificationHouseholdMemberIncomeModel>
        <Amount>1</Amount>
        <HouseholdMemberId>1</HouseholdMemberId>
        <HouseholdMemberIncomeId>1</HouseholdMemberIncomeId>
        <IncomePeriodCd>sample string 2</IncomePeriodCd>
        <IncomeTypeDescription>sample string 1</IncomeTypeDescription>
        <IncomeTypeId>1</IncomeTypeId>
      </VerificationHouseholdMemberIncomeModel>
      <VerificationHouseholdMemberIncomeModel>
        <Amount>1</Amount>
        <HouseholdMemberId>1</HouseholdMemberId>
        <HouseholdMemberIncomeId>1</HouseholdMemberIncomeId>
        <IncomePeriodCd>sample string 2</IncomePeriodCd>
        <IncomeTypeDescription>sample string 1</IncomeTypeDescription>
        <IncomeTypeId>1</IncomeTypeId>
      </VerificationHouseholdMemberIncomeModel>
    </VerificationHouseholdMemberIncome>
  </VerificationHouseholdMemberModel>
  <VerificationHouseholdMemberModel>
    <ApplicationId>1</ApplicationId>
    <CurrentYearMember>true</CurrentYearMember>
    <HasName>true</HasName>
    <HouseholdMemberId>1</HouseholdMemberId>
    <IsFosterChild>sample string 3</IsFosterChild>
    <Name>sample string 1</Name>
    <NoIncome>true</NoIncome>
    <PersonId>eb137c0f-9725-4ee3-a13c-5b9e95d7fb40</PersonId>
    <PreviousYearMember>true</PreviousYearMember>
    <UploadDocument>2</UploadDocument>
    <VerificationHouseholdMemberIncome>
      <VerificationHouseholdMemberIncomeModel>
        <Amount>1</Amount>
        <HouseholdMemberId>1</HouseholdMemberId>
        <HouseholdMemberIncomeId>1</HouseholdMemberIncomeId>
        <IncomePeriodCd>sample string 2</IncomePeriodCd>
        <IncomeTypeDescription>sample string 1</IncomeTypeDescription>
        <IncomeTypeId>1</IncomeTypeId>
      </VerificationHouseholdMemberIncomeModel>
      <VerificationHouseholdMemberIncomeModel>
        <Amount>1</Amount>
        <HouseholdMemberId>1</HouseholdMemberId>
        <HouseholdMemberIncomeId>1</HouseholdMemberIncomeId>
        <IncomePeriodCd>sample string 2</IncomePeriodCd>
        <IncomeTypeDescription>sample string 1</IncomeTypeDescription>
        <IncomeTypeId>1</IncomeTypeId>
      </VerificationHouseholdMemberIncomeModel>
    </VerificationHouseholdMemberIncome>
  </VerificationHouseholdMemberModel>
</ArrayOfVerificationHouseholdMemberModel>