GET api/GetGrandTotalIncome?IncomeFrequency={IncomeFrequency}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncomeFrequency

string

Required

Body Parameters

Collection of VerificationHouseholdMember
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.
IsFosterChild

string

None.
HouseholdMemberIncomes

Collection of VerificationHouseholdMemberIncome

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "HouseholdMemberIncomes": [
      {
        "<IncomeTypeDescription>k__BackingField": "sample string 1",
        "_householdMemberIncomeId": 1,
        "_householdMemberId": 1,
        "_incomeTypeId": 1,
        "_amount": 1.0,
        "_incomePeriodCd": "sample string 2"
      },
      {
        "<IncomeTypeDescription>k__BackingField": "sample string 1",
        "_householdMemberIncomeId": 1,
        "_householdMemberId": 1,
        "_incomeTypeId": 1,
        "_amount": 1.0,
        "_incomePeriodCd": "sample string 2"
      }
    ],
    "_householdMemberId": 1,
    "_applicationId": 1,
    "_name": "sample string 1",
    "_hasName": true,
    "_noIncome": true,
    "_personId": "7cdad98b-52e8-4aa3-a7c5-68343c92e2fb",
    "_previousYearMember": true,
    "_currentYearMember": true,
    "_isFolsterChild": "sample string 2"
  },
  {
    "HouseholdMemberIncomes": [
      {
        "<IncomeTypeDescription>k__BackingField": "sample string 1",
        "_householdMemberIncomeId": 1,
        "_householdMemberId": 1,
        "_incomeTypeId": 1,
        "_amount": 1.0,
        "_incomePeriodCd": "sample string 2"
      },
      {
        "<IncomeTypeDescription>k__BackingField": "sample string 1",
        "_householdMemberIncomeId": 1,
        "_householdMemberId": 1,
        "_incomeTypeId": 1,
        "_amount": 1.0,
        "_incomePeriodCd": "sample string 2"
      }
    ],
    "_householdMemberId": 1,
    "_applicationId": 1,
    "_name": "sample string 1",
    "_hasName": true,
    "_noIncome": true,
    "_personId": "7cdad98b-52e8-4aa3-a7c5-68343c92e2fb",
    "_previousYearMember": true,
    "_currentYearMember": true,
    "_isFolsterChild": "sample string 2"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVerificationHouseholdMember xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.FRE.Business">
  <VerificationHouseholdMember>
    <HouseholdMemberIncomes>
      <VerificationHouseholdMemberIncome>
        <_amount>1</_amount>
        <_householdMemberId>1</_householdMemberId>
        <_householdMemberIncomeId>1</_householdMemberIncomeId>
        <_incomePeriodCd>sample string 2</_incomePeriodCd>
        <_incomeTypeId>1</_incomeTypeId>
        <_x003C_IncomeTypeDescription_x003E_k__BackingField>sample string 1</_x003C_IncomeTypeDescription_x003E_k__BackingField>
      </VerificationHouseholdMemberIncome>
      <VerificationHouseholdMemberIncome>
        <_amount>1</_amount>
        <_householdMemberId>1</_householdMemberId>
        <_householdMemberIncomeId>1</_householdMemberIncomeId>
        <_incomePeriodCd>sample string 2</_incomePeriodCd>
        <_incomeTypeId>1</_incomeTypeId>
        <_x003C_IncomeTypeDescription_x003E_k__BackingField>sample string 1</_x003C_IncomeTypeDescription_x003E_k__BackingField>
      </VerificationHouseholdMemberIncome>
    </HouseholdMemberIncomes>
    <_applicationId>1</_applicationId>
    <_currentYearMember>true</_currentYearMember>
    <_hasName>true</_hasName>
    <_householdMemberId>1</_householdMemberId>
    <_isFolsterChild>sample string 2</_isFolsterChild>
    <_name>sample string 1</_name>
    <_noIncome>true</_noIncome>
    <_personId>7cdad98b-52e8-4aa3-a7c5-68343c92e2fb</_personId>
    <_previousYearMember>true</_previousYearMember>
  </VerificationHouseholdMember>
  <VerificationHouseholdMember>
    <HouseholdMemberIncomes>
      <VerificationHouseholdMemberIncome>
        <_amount>1</_amount>
        <_householdMemberId>1</_householdMemberId>
        <_householdMemberIncomeId>1</_householdMemberIncomeId>
        <_incomePeriodCd>sample string 2</_incomePeriodCd>
        <_incomeTypeId>1</_incomeTypeId>
        <_x003C_IncomeTypeDescription_x003E_k__BackingField>sample string 1</_x003C_IncomeTypeDescription_x003E_k__BackingField>
      </VerificationHouseholdMemberIncome>
      <VerificationHouseholdMemberIncome>
        <_amount>1</_amount>
        <_householdMemberId>1</_householdMemberId>
        <_householdMemberIncomeId>1</_householdMemberIncomeId>
        <_incomePeriodCd>sample string 2</_incomePeriodCd>
        <_incomeTypeId>1</_incomeTypeId>
        <_x003C_IncomeTypeDescription_x003E_k__BackingField>sample string 1</_x003C_IncomeTypeDescription_x003E_k__BackingField>
      </VerificationHouseholdMemberIncome>
    </HouseholdMemberIncomes>
    <_applicationId>1</_applicationId>
    <_currentYearMember>true</_currentYearMember>
    <_hasName>true</_hasName>
    <_householdMemberId>1</_householdMemberId>
    <_isFolsterChild>sample string 2</_isFolsterChild>
    <_name>sample string 1</_name>
    <_noIncome>true</_noIncome>
    <_personId>7cdad98b-52e8-4aa3-a7c5-68343c92e2fb</_personId>
    <_previousYearMember>true</_previousYearMember>
  </VerificationHouseholdMember>
</ArrayOfVerificationHouseholdMember>

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 'List`1'.

Response Information

Resource Description

decimal number

Response Formats

application/json, text/json

Sample: 
1.0

application/xml, text/xml

Sample: 
<decimal xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</decimal>