GET api/GetAddress?address={address}&orgId={orgId}&getTerritory={getTerritory}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
address

string

Required

orgId

string

Default value is

getTerritory

string

Default value is false

Body Parameters

None.

Response Information

Resource Description

AddressResult
NameDescriptionTypeAdditional information
status

string

None.

formatedAddress

string

None.

city

string

None.

state_long

string

None.

state_short

string

None.

country_long

string

None.

country_short

string

None.

postalCode

string

None.

address

string

None.

county

string

None.

latitude

string

None.

longitude

string

None.

googlePlaceId

string

None.

addressSQLId

string

None.

orignalAddressText

string

None.

territoryId

Collection of string

None.

hasOutOfAreaTerritory

boolean

None.

addressType

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "formatedAddress": "sample string 2",
  "city": "sample string 3",
  "state_long": "sample string 4",
  "state_short": "sample string 5",
  "country_long": "sample string 6",
  "country_short": "sample string 7",
  "postalCode": "sample string 8",
  "address": "sample string 9",
  "county": "sample string 10",
  "latitude": "sample string 11",
  "longitude": "sample string 12",
  "googlePlaceId": "sample string 13",
  "addressSQLId": "sample string 14",
  "orignalAddressText": "sample string 15",
  "territoryId": [
    "sample string 1",
    "sample string 2"
  ],
  "hasOutOfAreaTerritory": true,
  "addressType": "sample string 17"
}

application/xml, text/xml

Sample:
<AddressResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RouteOptimizerWebAPI.Models">
  <address>sample string 9</address>
  <addressSQLId>sample string 14</addressSQLId>
  <addressType>sample string 17</addressType>
  <city>sample string 3</city>
  <country_long>sample string 6</country_long>
  <country_short>sample string 7</country_short>
  <county>sample string 10</county>
  <formatedAddress>sample string 2</formatedAddress>
  <googlePlaceId>sample string 13</googlePlaceId>
  <hasOutOfAreaTerritory>true</hasOutOfAreaTerritory>
  <latitude>sample string 11</latitude>
  <longitude>sample string 12</longitude>
  <orignalAddressText>sample string 15</orignalAddressText>
  <postalCode>sample string 8</postalCode>
  <state_long>sample string 4</state_long>
  <state_short>sample string 5</state_short>
  <status>sample string 1</status>
  <territoryId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </territoryId>
</AddressResult>