POST ShortApplication/C21UpsertIncome

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Income		C21Income	None.
Sa_ApplicationID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Income": {
    "DisplayName": "sample string 1",
    "DisplayAmount": "sample string 2",
    "IncomeID": 3,
    "IncomeType": 4,
    "Type": 5,
    "EmployerName": "sample string 6",
    "Amount": 1.0,
    "Frequency": 7,
    "ApplicantID": {
      "label": "sample string 1",
      "value": 2
    },
    "PropertyID": 1,
    "Status": 8
  },
  "Sa_ApplicationID": 1
}

application/xml, text/xml

Sample:

<C21UpsertIncomeInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <Income>
    <Amount>1</Amount>
    <ApplicantID>
      <label>sample string 1</label>
      <value>2</value>
    </ApplicantID>
    <DisplayAmount>sample string 2</DisplayAmount>
    <DisplayName>sample string 1</DisplayName>
    <EmployerName>sample string 6</EmployerName>
    <Frequency>7</Frequency>
    <IncomeID>3</IncomeID>
    <IncomeType>4</IncomeType>
    <PropertyID>1</PropertyID>
    <Status>8</Status>
    <Type>5</Type>
  </Income>
  <Sa_ApplicationID>1</Sa_ApplicationID>
</C21UpsertIncomeInput>

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

Response Information

Resource Description

C21UpsertIncomeOutput

Name	Description	Type	Additional information
Income		C21Income	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Income": {
    "DisplayName": "sample string 1",
    "DisplayAmount": "sample string 2",
    "IncomeID": 3,
    "IncomeType": 4,
    "Type": 5,
    "EmployerName": "sample string 6",
    "Amount": 1.0,
    "Frequency": 7,
    "ApplicantID": {
      "label": "sample string 1",
      "value": 2
    },
    "PropertyID": 1,
    "Status": 8
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<C21UpsertIncomeOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <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>
  <Income>
    <Amount>1</Amount>
    <ApplicantID>
      <label>sample string 1</label>
      <value>2</value>
    </ApplicantID>
    <DisplayAmount>sample string 2</DisplayAmount>
    <DisplayName>sample string 1</DisplayName>
    <EmployerName>sample string 6</EmployerName>
    <Frequency>7</Frequency>
    <IncomeID>3</IncomeID>
    <IncomeType>4</IncomeType>
    <PropertyID>1</PropertyID>
    <Status>8</Status>
    <Type>5</Type>
  </Income>
</C21UpsertIncomeOutput>