GET 17.0/app/utilityswitching/addresslookup?query={query}

Description

Performs an address lookup for the passed query text

URI Parameters
Name Description Type Additional information
query

The text to use in the address lookup

 string

Required

None.

None.

An array of addresses that match the passed query text

Collection of AddressSummary
Name Description Type Additional information
DisplayName

string

None.
AddressId

integer

None.

application/json, text/json
Sample: 
[
  {
    "displayName": "sample string 1",
    "addressId": 2
  },
  {
    "displayName": "sample string 1",
    "addressId": 2
  }
]

application/xml, text/xml
Sample: 
<ArrayOfAddressSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AddressSummary>
    <DisplayName>sample string 1</DisplayName>
    <AddressId>2</AddressId>
  </AddressSummary>
  <AddressSummary>
    <DisplayName>sample string 1</DisplayName>
    <AddressId>2</AddressId>
  </AddressSummary>
</ArrayOfAddressSummary>