POST ShortApplication/GetAddressComponents

Request Information

URI Parameters

None.

Body Parameters

GetAddressComponentsInput
NameDescriptionTypeAdditional information
SiteID

string

None.

Province

string

None.

StreetType

string

None.

StreetDirection

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteID": "sample string 1",
  "Province": "sample string 2",
  "StreetType": "sample string 3",
  "StreetDirection": "sample string 4"
}

application/xml, text/xml

Sample:
<GetAddressComponentsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Geocode">
  <Province>sample string 2</Province>
  <SiteID>sample string 1</SiteID>
  <StreetDirection>sample string 4</StreetDirection>
  <StreetType>sample string 3</StreetType>
</GetAddressComponentsInput>

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

Response Information

Resource Description

GetAddressComponentsOutput
NameDescriptionTypeAdditional information
ProvinceDD

integer

None.

StreetTypeDD

integer

None.

StreetDirectionDD

integer

None.

ReturnStatus

ReturnStatusModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ProvinceDD": 1,
  "StreetTypeDD": 1,
  "StreetDirectionDD": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:
<GetAddressComponentsOutput 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>
  <ProvinceDD>1</ProvinceDD>
  <StreetDirectionDD>1</StreetDirectionDD>
  <StreetTypeDD>1</StreetTypeDD>
</GetAddressComponentsOutput>