GET api/GetIncomePeriodInfo

Request Information

URI Parameters

None.

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": "4152428d-a8e0-4b12-99d9-90b1c4cb0caa",
    "_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": "4152428d-a8e0-4b12-99d9-90b1c4cb0caa",
    "_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>4152428d-a8e0-4b12-99d9-90b1c4cb0caa</_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>4152428d-a8e0-4b12-99d9-90b1c4cb0caa</_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

IncomePeriodModel
NameDescriptionTypeAdditional information
IncomePeriodCd

string

None.
Description

string

None.
Factor

decimal number

None.
DefaultPeriod

boolean

None.
DisplayOrder

integer

None.
DisplayCharacter

string

None.
MonthlyConversionFactor

decimal number

None.
incomePeriod

decimal number

None.
GrandTotal

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IncomePeriodCd": "sample string 1",
  "Description": "sample string 2",
  "Factor": 1.0,
  "DefaultPeriod": true,
  "DisplayOrder": 1,
  "DisplayCharacter": "sample string 3",
  "MonthlyConversionFactor": 1.0,
  "incomePeriod": 4.0,
  "GrandTotal": "sample string 5"
}

application/xml, text/xml

Sample: 
<IncomePeriodModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.VerificationResponse">
  <DefaultPeriod>true</DefaultPeriod>
  <Description>sample string 2</Description>
  <DisplayCharacter>sample string 3</DisplayCharacter>
  <DisplayOrder>1</DisplayOrder>
  <Factor>1</Factor>
  <GrandTotal>sample string 5</GrandTotal>
  <IncomePeriodCd>sample string 1</IncomePeriodCd>
  <MonthlyConversionFactor>1</MonthlyConversionFactor>
  <incomePeriod>4</incomePeriod>
</IncomePeriodModel>