GET api/GetIncomeSurveyHouseholdMemberList?surveyId={surveyId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of IncomeSurveyHouseholdMemberModel
NameDescriptionTypeAdditional information
SurveyId

integer

None.
Name

string

None.
NoIncome

boolean

None.
PersonId

globally unique identifier

None.
IncomeTypeId

integer

None.
Amount

decimal number

None.
IncomePeriodCd

string

None.
IsActive

boolean

None.
AddedBy

integer

None.
SurveyHHMemberId

integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "SurveyId": 1,
    "Name": "sample string 2",
    "NoIncome": true,
    "PersonId": "c954e4fd-ccc5-485f-8a0d-d9d656b85bf7",
    "IncomeTypeId": 5,
    "Amount": 6.0,
    "IncomePeriodCd": "sample string 7",
    "IsActive": true,
    "AddedBy": 9,
    "SurveyHHMemberId": 1
  },
  {
    "SurveyId": 1,
    "Name": "sample string 2",
    "NoIncome": true,
    "PersonId": "c954e4fd-ccc5-485f-8a0d-d9d656b85bf7",
    "IncomeTypeId": 5,
    "Amount": 6.0,
    "IncomePeriodCd": "sample string 7",
    "IsActive": true,
    "AddedBy": 9,
    "SurveyHHMemberId": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfIncomeSurveyHouseholdMemberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.IncomeSurveys">
  <IncomeSurveyHouseholdMemberModel>
    <AddedBy>9</AddedBy>
    <Amount>6</Amount>
    <IncomePeriodCd>sample string 7</IncomePeriodCd>
    <IncomeTypeId>5</IncomeTypeId>
    <IsActive>true</IsActive>
    <Name>sample string 2</Name>
    <NoIncome>true</NoIncome>
    <PersonId>c954e4fd-ccc5-485f-8a0d-d9d656b85bf7</PersonId>
    <SurveyHHMemberId>1</SurveyHHMemberId>
    <SurveyId>1</SurveyId>
  </IncomeSurveyHouseholdMemberModel>
  <IncomeSurveyHouseholdMemberModel>
    <AddedBy>9</AddedBy>
    <Amount>6</Amount>
    <IncomePeriodCd>sample string 7</IncomePeriodCd>
    <IncomeTypeId>5</IncomeTypeId>
    <IsActive>true</IsActive>
    <Name>sample string 2</Name>
    <NoIncome>true</NoIncome>
    <PersonId>c954e4fd-ccc5-485f-8a0d-d9d656b85bf7</PersonId>
    <SurveyHHMemberId>1</SurveyHHMemberId>
    <SurveyId>1</SurveyId>
  </IncomeSurveyHouseholdMemberModel>
</ArrayOfIncomeSurveyHouseholdMemberModel>