POST ShortApplication/LoadCanadaPostResults

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Id		string	None.
SiteID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "SiteID": "sample string 2"
}

application/xml, text/xml

Sample:

<LoadCanadaPostResultsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Geocode">
  <Id>sample string 1</Id>
  <SiteID>sample string 2</SiteID>
</LoadCanadaPostResultsInput>

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

Response Information

Resource Description

LoadCanadaPostResultsOutput

Name	Description	Type	Additional information
Addr		AddressDetailsModel	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Addr": {
    "_id": "000000000000000000000000",
    "CanadaPostID": "sample string 1",
    "CountryTypeDD": 2,
    "ProvinceDD": 1,
    "StreetNumber": "sample string 3",
    "PostalFsa": "sample string 4",
    "PostalLdu": "sample string 5",
    "City": "sample string 6",
    "StreetName": "sample string 7",
    "StreetTypeDD": 1,
    "StreetDirectionDD": 1,
    "Unit": "sample string 8",
    "Text": "sample string 9"
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<LoadCanadaPostResultsOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Geocode">
  <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>
  <Addr>
    <CanadaPostID>sample string 1</CanadaPostID>
    <City>sample string 6</City>
    <CountryTypeDD>2</CountryTypeDD>
    <PostalFsa>sample string 4</PostalFsa>
    <PostalLdu>sample string 5</PostalLdu>
    <ProvinceDD>1</ProvinceDD>
    <StreetDirectionDD>1</StreetDirectionDD>
    <StreetName>sample string 7</StreetName>
    <StreetNumber>sample string 3</StreetNumber>
    <StreetTypeDD>1</StreetTypeDD>
    <Text>sample string 9</Text>
    <Unit>sample string 8</Unit>
    <_id xmlns:d3p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
      <d3p1:_a>0</d3p1:_a>
      <d3p1:_b>0</d3p1:_b>
      <d3p1:_c>0</d3p1:_c>
    </_id>
  </Addr>
</LoadCanadaPostResultsOutput>