GET 17.0/app/utilityswitching/addresslookup/{addressid}

Description

Gets address details for the passed address id

URI Parameters
Name Description Type Additional information
addressId

Id of the address to retrieve details for

 integer

Required

None.

None.

An address model populated with the full details of the address

Address
Name Description Type Additional information
CountryCode

integer

None.
PostCode

string

None.
PropertyName

string

None.
Street

string

None.
Locality

string

None.
Town

string

None.
Region

string

None.
Country

string

None.

application/json, text/json
Sample: 
{
  "countryCode": 1,
  "postCode": "sample string 2",
  "propertyName": "sample string 3",
  "street": "sample string 4",
  "locality": "sample string 5",
  "town": "sample string 6",
  "region": "sample string 7",
  "country": "sample string 8"
}

application/xml, text/xml
Sample: 
<Address xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CountryCode>1</CountryCode>
  <PostCode>sample string 2</PostCode>
  <PropertyName>sample string 3</PropertyName>
  <Street>sample string 4</Street>
  <Locality>sample string 5</Locality>
  <Town>sample string 6</Town>
  <Region>sample string 7</Region>
  <Country>sample string 8</Country>
</Address>