POST dosconnect/NewOtherIncome

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicationGroupID	integer	None.
Income	UpdateIncomeModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicationGroupID": 2,
  "Income": {
    "IncomeTypeDD": 1,
    "IncomePeriodDD": 1,
    "IncomeAmount": 1.0,
    "AnnualIncomeAmount": 2.0,
    "IncomeDescription": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<NewOtherIncomeInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <ApplicationGroupID>2</ApplicationGroupID>
  <Income>
    <AnnualIncomeAmount>2</AnnualIncomeAmount>
    <IncomeAmount>1</IncomeAmount>
    <IncomeDescription>sample string 3</IncomeDescription>
    <IncomePeriodDD>1</IncomePeriodDD>
    <IncomeTypeDD>1</IncomeTypeDD>
  </Income>
</NewOtherIncomeInput>

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 'NewOtherIncomeInput'.

Response Information

Resource Description

NewOtherIncomeOutput

Name	Description	Type	Additional information
IncomeID		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "IncomeID": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<NewOtherIncomeOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <IncomeID>1</IncomeID>
</NewOtherIncomeOutput>