POST dosconnect/UpdateAddress

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
AddressID	integer	None.
UnitNumber	string	None.
StreetNumber	string	None.
StreetName	string	None.
StreetTypeDD	integer	None.
StreetDirectionDD	integer	None.
City	string	None.
ProvinceDD	integer	None.
InternationalPostalCode	string	None.
PostalFsa	string	None.
PostalLdu	string	None.
CountryTypeDD	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "AddressID": 2,
  "UnitNumber": "sample string 3",
  "StreetNumber": "sample string 4",
  "StreetName": "sample string 5",
  "StreetTypeDD": 1,
  "StreetDirectionDD": 1,
  "City": "sample string 6",
  "ProvinceDD": 1,
  "InternationalPostalCode": "sample string 7",
  "PostalFsa": "sample string 8",
  "PostalLdu": "sample string 9",
  "CountryTypeDD": 1
}

application/xml, text/xml

Sample:

<UpdateAddressInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <AddressID>2</AddressID>
  <City>sample string 6</City>
  <CountryTypeDD>1</CountryTypeDD>
  <InternationalPostalCode>sample string 7</InternationalPostalCode>
  <PostalFsa>sample string 8</PostalFsa>
  <PostalLdu>sample string 9</PostalLdu>
  <ProvinceDD>1</ProvinceDD>
  <StreetDirectionDD>1</StreetDirectionDD>
  <StreetName>sample string 5</StreetName>
  <StreetNumber>sample string 4</StreetNumber>
  <StreetTypeDD>1</StreetTypeDD>
  <UnitNumber>sample string 3</UnitNumber>
  <APIKey>sample string 1</APIKey>
</UpdateAddressInput>

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

Response Information

Resource Description

UpdateBaseOutput

Name	Description	Type	Additional information
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<UpdateBaseOutput 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>
</UpdateBaseOutput>