POST dosconnect/NewApplicantAddress

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantID	integer	None.
Address	UpdateAddressModel	None.
MonthsAtAddress	integer	None.
ResidentialStatusDD	integer	None.
ApplicantAddressTypeDD	integer	None.
Rent	decimal number	None.
AddressStatusDD	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "Address": {
    "AddressID": 1,
    "UnitNumber": "sample string 2",
    "StreetNumber": "sample string 3",
    "StreetName": "sample string 4",
    "StreetTypeDD": 1,
    "StreetDirectionDD": 1,
    "City": "sample string 5",
    "ProvinceDD": 1,
    "InternationalPostalCode": "sample string 6",
    "PostalFsa": "sample string 7",
    "PostalLdu": "sample string 8",
    "CountryTypeDD": 1
  },
  "MonthsAtAddress": 1,
  "ResidentialStatusDD": 1,
  "ApplicantAddressTypeDD": 1,
  "Rent": 1.0,
  "AddressStatusDD": 1
}

application/xml, text/xml

Sample:

<NewApplicantAddressInput 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>
  <Address>
    <AddressID>1</AddressID>
    <City>sample string 5</City>
    <CountryTypeDD>1</CountryTypeDD>
    <InternationalPostalCode>sample string 6</InternationalPostalCode>
    <PostalFsa>sample string 7</PostalFsa>
    <PostalLdu>sample string 8</PostalLdu>
    <ProvinceDD>1</ProvinceDD>
    <StreetDirectionDD>1</StreetDirectionDD>
    <StreetName>sample string 4</StreetName>
    <StreetNumber>sample string 3</StreetNumber>
    <StreetTypeDD>1</StreetTypeDD>
    <UnitNumber>sample string 2</UnitNumber>
  </Address>
  <AddressStatusDD>1</AddressStatusDD>
  <ApplicantAddressTypeDD>1</ApplicantAddressTypeDD>
  <ApplicantID>2</ApplicantID>
  <MonthsAtAddress>1</MonthsAtAddress>
  <Rent>1</Rent>
  <ResidentialStatusDD>1</ResidentialStatusDD>
</NewApplicantAddressInput>

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

Response Information

Resource Description

NewApplicantAddressOutput

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<NewApplicantAddressOutput 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>
  <ApplicantAddressID>1</ApplicantAddressID>
</NewApplicantAddressOutput>