POST 17.0/app/utilityswitching/addresslookup/format

Description

Formats the passed address lookup result

URI Parameters

None.

Address lookup result to format

AddressLookupResult
Name Description Type Additional information
Result

CodeTextPair

None.
IsUniqueAddress

boolean

None.
Postcode

string

None.
AddressId

integer

None.
AddressType

CodeTextPair

None.
MatchLevel

CodeTextPair

None.
PostalAddress

Collection of string

None.
VanityAddress

Collection of string

None.
ReformattedAddressResult

CodeTextPair

None.
ReformattedAddress

Collection of string

None.
TotalOptions

integer

None.
Options

Collection of Option

None.
Links

Collection of Link

None.

application/json, text/json
Sample: 
{
  "result": {
    "code": 1,
    "text": "sample string 2"
  },
  "isUniqueAddress": true,
  "postcode": "sample string 2",
  "addressId": 3,
  "addressType": {
    "code": 1,
    "text": "sample string 2"
  },
  "matchLevel": {
    "code": 1,
    "text": "sample string 2"
  },
  "postalAddress": [
    "sample string 1",
    "sample string 2"
  ],
  "vanityAddress": [
    "sample string 1",
    "sample string 2"
  ],
  "reformattedAddressResult": {
    "code": 1,
    "text": "sample string 2"
  },
  "reformattedAddress": [
    "sample string 1",
    "sample string 2"
  ],
  "totalOptions": 4,
  "options": [
    {
      "optionType": {
        "code": 1,
        "text": "sample string 2"
      },
      "displayName": "sample string 1",
      "addressId": 2,
      "addressType": {
        "code": 1,
        "text": "sample string 2"
      },
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    },
    {
      "optionType": {
        "code": 1,
        "text": "sample string 2"
      },
      "displayName": "sample string 1",
      "addressId": 2,
      "addressType": {
        "code": 1,
        "text": "sample string 2"
      },
      "links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

application/x-www-form-urlencoded
Sample:

Sample not available.

An address model populated with formatted address data

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>