AddressServer - REST API

To utilise the API you will require an AddressServer in the Cloud account. If you don't already have an account, then please register on-line or alternatively contact us.

Contents

Introduction

The Hopewiser AtlasLive API is a web service that can be used to perform address lookup and verification operations over the internet. It follows RESTful principles - accepting HTTP requests and returning either JSON or XML response documents.

Intended Audience

This documentation is aimed at developers who wish to utilise the Hopewiser AtlasLive service to embed address lookup functionality within a client application.

Authentication

Authentication is achieved using HTTP Basic Authentication, where both the username and password are supplied in the HTTP header. To secure this information all requests should use the https:// protocol, in preference to standard http:// .

How do I discover my available Master Address Files?

To discover the Master Address Files (MAFs) that are configured for the authenticated user, supply a URL of the form.

https://cloud.hopewiser.com/atlaslive/output

where

  • output indicates the required output format - either json or xml

This will return a list of available MAF identities (for example).

JSON

{
  "Status": "OK",
  "Results": {
    "MAFs": [
      {
        "ID": "uk-nspd-paf-internal"
      },
      {
        "ID": "uk-rm-paf-internal"
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <MAFs>
      <ID>uk-nspd-paf-internal</ID>
    </MAFs>
    <MAFs>
      <ID>uk-rm-paf-internal</ID>
    </MAFs>
  </Results>
</Response>

How do I look up an address?

An address lookup is initiated by supplying a URL of the form.

https://cloud.hopewiser.com/atlaslive/output/maf?parameters

where

  • output indicates the required output format - either json or xml
  • maf is the identity of the Master Address File to which the lookup is applied
  • parameters is a set of request parameters

Only a single request parameter is required - the query string. All other parameters are optional and should only be supplied when a non-default setting is required. As is standard with URLs, each parameter must be separated by an ampersand (&) character.

The mandatory query string is denoted by a single 'q' character. This is the address search criteria, which could be a postcode, full or partial address. Both single character (?) and multi character (*) wild-cards are supported. Please note that the search criteria must be URL encoded.

Please refer to the Lookup Parameters section for a full list of available options.

Example address lookup request for "Downing Street,London".

https://cloud.hopewiser.com/atlaslive/json/uk-rm-paf-internal?q=Downing%20Street%2CLondon

This will return a pick-list of possible matches, which the client program would most likely reformat and present to the end user as a list or tree.

JSON

{
  "Status": "OK",
  "Results": {
    "NumItems": 1,
    "Items": [
      {
        "Sid": "00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o",
        "ItemText": "+ Downing Street,London SW1A",
        "IsExpandable": true,
        "IsComplete": false,
        "Selected": false
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <NumItems>1</NumItems>
    <Items>
      <Sid>00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o</Sid>
      <ItemText>+ Downing Street,London SW1A</ItemText>
      <IsExpandable>true</IsExpandable>
      <IsComplete>false</IsComplete>
      <Selected>false</Selected>
    </Items>
  </Results>
</Response>

When an item is selected the client program should continue the address lookup by specifying the item's Sid (search identity) in the q (query) parameter, along with any non-default options. Please note that the Sid is already URL encoded.

https://cloud.hopewiser.com/atlaslive/json/uk-rm-paf-internal?q=00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o

The previous two steps should be repeated until a single item is returned with the Selected field value true. When the Selected field is true the address lookup is complete and the requested output fields will be returned.

JSON

{
  "Status": "OK",
  "Results": {
    "NumItems": 1,
    "Items": [
      {
        "Sid": "00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8",
        "IsExpandable": false,
        "IsComplete": true,
        "Selected": true,
        "Label1": "Prime Minister & First Lord of The Treasury",
        "Label2": "10 Downing Street",
        "Label3": "LONDON",
        "Label4": "SW1A 2AA"
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <NumItems>1</NumItems>
    <Items>
      <Sid>00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8</Sid>
      <IsExpandable>false</IsExpandable>
      <IsComplete>true</IsComplete>
      <Selected>true</Selected>
      <Label1>Prime Minister &amp; First Lord of The Treasury</Label1>
      <Label2>10 Downing Street</Label2>
      <Label3>LONDON</Label3>
      <Label4>SW1A 2AA</Label4>
    </Items>
  </Results>
</Response>

Each item in a pick-list contains three control flags.

  • IsExpandable is true when the item can be expanded
  • IsComplete is true when the item contains a complete address
  • Selected is true when a single item has been selected and the requested output fields have been returned

Please note that an item can be both expandable and complete.

Additional Address Lookup Features

The SelectItem parameter can be used to obtain output fields for any pick-list item, even when that item does not contain a complete address (for example).

https://cloud.hopewiser.com/atlaslive/json/uk-rm-paf-internal?q=00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o&SelectItem=true

Please note that the response will only contain the output fields that have a value.

JSON

{
  "Status": "OK",
  "Results": {
    "NumItems": 1,
    "Items": [
      {
        "Sid": "00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o",
        "IsExpandable": true,
        "IsComplete": false,
        "Selected": true,
        "Label1": "Downing Street",
        "Label2": "LONDON",
        "Label3": "SW1A"
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <NumItems>1</NumItems>
    <Items>
      <Sid>00000000000%24%40sid%5E%25%2B0%25DOWNING%20STREET%7C%7CLONDON9o</Sid>
      <IsExpandable>true</IsExpandable>
      <IsComplete>false</IsComplete>
      <Selected>true</Selected>
      <Label1>Downing Street</Label1>
      <Label2>LONDON</Label2>
      <Label3>SW1A</Label3>
    </Items>
  </Results>
</Response>

How do I customise an address label?

The AtlasLive service defaults to return a free format address label, which may contain up to seven address lines. The town is presented in uppercase and the county is always included in the label.

If this does not meet your requirements, then you can customise the layout. For example to increase the number of address lines to eight add the URL parameter "OutputFields=Label8". To fix the last address line for the postcode add the parameter "LabelFormat=FixedPostcode".

https://cloud.hopewiser.com/atlaslive/json/uk-rm-paf-internal?q=00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8&OutputFields=Label8&LabelFormat=FixedPostcode

Please refer to the Label Parameters section for a full list of customisation options.

How do I get individual address fields or data fields?

Each Master Address File (MAF) allows for the retrieval of individual address fields and common data. Some MAFs contain extra information beyond that common to all MAFs, such as National Statistics Postcode Directory (NSPD) data.

To discover the available MAF fields, specify ListOutputs as the q (query) parameter value.

https://cloud.hopewiser.com/atlaslive/output/maf?q=ListOutputs

where

  • output indicates the required output format - either json or xml
  • maf is the identity of the Master Address File

This will return a list of all possible output fields, which are grouped on TableName. Fields with a TableName value of either Address Label, Address Fields or Data are common to all MAFs. Those with the TableName value Extra Data are MAF specific. Please note that a ToolTip is only provided for the common fields.

JSON

{
  "Status": "OK",
  "Results": {
    "NamesAvailable": 0,
    "Outputs": [
      {
        "Name": "Label1",
        "TableName": "Address Label",
        "Tooltip": "The first line of a formatted address label"
      },
          
      etc...      
      
      {
        "Name": "Extra_ADDRESS_KEY",
        "TableName": "Extra Data"
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <NamesAvailable>0</NamesAvailable>
    <Outputs>
      <Name>Label1</Name>
      <TableName>Address Label</TableName>
      <Tooltip>The first line of a formatted address label</Tooltip>
    </Outputs>
    
    etc...
    
    <Outputs>
      <Name>Extra_ADDRESS_KEY</Name>
      <TableName>Extra Data</TableName>
    </Outputs>
  </Results>
</Response>

Please refer to the Common Output Fields section for a full list of the standard fields.

Required fields can then be requested by specifying their names as a comma separated list in the OutputFields parameter. The shorthand value Extra_ can be used to specify all Extra Data fields. Please note that adding the OutputFields parameter to the request removes its default value. Hence an appropriate label (Label1..Label9) must be included in the comma separated list when a formatted address label is required.

Example to return a seven line formatted label, plus the country and all MAF specific extra data fields.

https://cloud.hopewiser.com/atlaslive/json/uk-rm-paf-internal?q=00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8&OutputFields=Label7,Country,Extra_

When the address lookup is complete (i.e. the Selected field is true) or a specific pick-list item has been selected, then the requested output fields will be returned. It is possible for multiple values to exist per Extra Data field. Hence the Extra Data fields are grouped into records, where the first set of values comprise the first record, the second set comprise the next record, etc. Please note that only output fields containing a value will be returned.

JSON

{
  "Status": "OK",
  "Results": {
    "NumItems": 1,
    "Items": [
      {
        "Sid": "00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8",
        "IsExpandable": false,
        "IsComplete": true,
        "Selected": true,
        "Label1": "Prime Minister & First Lord of The Treasury",
        "Label2": "10 Downing Street",
        "Label3": "LONDON",
        "Label4": "SW1A 2AA",
        "Country": "UNITED KINGDOM",
        "Extra": {
          "Records": [
            {
              "Extra_ADDRESS_KEY": "01626260"
            }
          ]
        }
      }
    ]
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <NumItems>1</NumItems>
    <Items>
      <Sid>00000000000%24%40sid%5E%25%2B2%2B0%25DOWNING%20STREET%7C%7CLONDONi8</Sid>
      <IsExpandable>false</IsExpandable>
      <IsComplete>true</IsComplete>
      <Selected>true</Selected>
      <Label1>Prime Minister &amp; First Lord of The Treasury</Label1>
      <Label2>10 Downing Street</Label2>
      <Label3>LONDON</Label3>
      <Label4>SW1A 2AA</Label4>
      <Country>UNITED KINGDOM</Country>
      <Extra>
        <Records>
          <Extra_ADDRESS_KEY>01626260</Extra_ADDRESS_KEY>         
        </Records>
      </Extra>
    </Items>
  </Results>
</Response>

How do I get version information?

To discover the service version information, specify ListVersions as the q (query) parameter value.

https://cloud.hopewiser.com/atlaslive/output/maf?q=ListVersions

where

  • output indicates the required output format - either json or xml
  • maf is the identity of the Master Address File

This will return the service and underlying library versions, plus the version of the specified MAF.

JSON

{
  "Status": "OK",
  "Results": {
    "Versions": {
      "ATLASLIVESERVERVersion": "0.0.5",
      "ATLASLIVEVersion": "1.26.0",
      "ATLASVersion": "Atlas Version: 3.53.70 (fh:3.5.0 xfh:2.0.0)",
      "MAFVersion": "MAF Version 49 (UU) UNITED KINGDOM Built 20130627"
    }
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>OK</Status>
  <Results>
    <Versions>
      <ATLASLIVESERVERVersion>0.0.5</ATLASLIVESERVERVersion>
      <ATLASLIVEVersion>1.26.0</ATLASLIVEVersion>
      <ATLASVersion>Atlas Version: 3.53.70 (fh:3.5.0 xfh:2.0.0)</ATLASVersion>
      <MAFVersion>MAF Version 49 (UU)  UNITED KINGDOM  Built 20130627</MAFVersion>
    </Versions>
  </Results>
</Response>

Lookup Parameters

Option Description
DisplayResults

Select how to display the results. Allowed values are AsATree (the default) or AsAList

The value AsATree will return a pick-list for each level of the lookup, allowing the end user to drill down a specific search path.

The value AsAList will automatically expand each level of the lookup to provide a single fully flattened pick-list.
PostcodeResultLevel

Set how the results from postcode lookups are structured. Allowed values are Street (the default) or Premise.

The value Street will return a pick-list at the street level, allowing the end user to drill down to the premises.

The value Premise will return a pick-list at the premise level, without needing to drill down.
ResultSorting

Specify how the pick-list items are sorted. Allowed values are Intelligent (the default) or ByPostcode.

The value Intelligent specifies that the pick-list items are ordered by the street name then premise.
StreetsOverMultipleDistricts

Specify how to handle streets that span multiple districts. Allowed values are SeparateByDistrict (the default) or NoSeparation.

The value SeparateByDistrict will expand a street that spans several districts into a pick-list of districts, allowing the end user to drill down to the premises within that district.

The value NoSeparation will expand a street into a pick-list of premises across all districts.
SubpremiseLevel

Specify how to handle listing sub-premises. Allowed values are SubpremisesOnNextLevel (the default) or SubpremisesOnSameLevel.

The value SubpremisesOnNextLevel separates premise and sub-premise details into two pick-list levels, such that the end user will need to drill down from a premise to its sub-premise details.

The value SubpremisesOnSameLevel returns both premise and sub-premise details within a single pick-list.
ResultFormatting

Specify the detail level within the pick-list item text. Allowed values are Intelligent (the default) or Fixed.

The value Intelligent specifies that the item text only contains information that has not been presented at a higher level.

The value Fixed specifies that the item text contains all available address information at each level.
IncludeCountyInPickList

Specify when counties are included within the pick-list item text. Allowed values are AsRequired (the default), Never or Always.

The value AsRequired will only include the county when appropriate, for example when it meets PTT guidelines or when it is required to disambiguate UK town names.
PostcodeInPickList Specify when postcodes are included within the pick-list item text. Allowed values are Exclude (the default) or Include.
HouseAndFlatBecomePremise Combine the house and flat as premise details in Scottish tenements. Allowed values are Never (the default) or AsRequired.
ReturnWelshAddresses

Specify that, when available, the Welsh version of an address should be returned instead of the English version (e.g. "Heol Y Porth,Caerdydd" instead of "Westgate Street,Cardiff"). Allowed values are Never (the default) or IfAvailable.

Please note that this option is only applicable when the search criteria is a postcode.

Label Parameters

Option Description
OutputFields

This parameter is used to specify the required output fields within a selected item.

It can be used to define the maximum number of lines in a formatted address label, by specifying a label value from Label1 through to Label9. The default is Label7.
LabelFormat

Select the position of the town, county and postcode within the formatted address label. Allowed values are Standard (the default), FixedPostcode or FixedTown.

The value FixedPostcode reserves the last line of the formatted address label for the postcode and forces it to be output on a separate line.

The value FixedTown reserves the last three lines of the formatted address label for the town, county and postcode and forces each value to be output on a separate line. Please note that a line is reserved for the county even if none is output.

When a fixed value is requested, the formatted address label will comprise the maximum allowed number of address lines, some of which may be empty.
ReserveOrganisationLine

Select the position of the organisation within the formatted label. Allowed values are AsRequired (the default), Always or Never.

The value AsRequired includes the organisation within the address label following standard formatting rules.

The value Always reserves the first line of the formatted address label for the organisation and forces it to be output on a separate line. If there is no organisation then the first line will be empty.

The value Never removes the organisation from the formatted address label.
IncludeCounty

Select when the county should be included within the formatted address label. Allowed values are Always (the default), Never or AsRequired.

The value AsRequired will only include the county when appropriate, for example when it meets PTT guidelines or when it is required to disambiguate UK town names.
DropCountyToFitLabel Select if the county may be dropped when it does not fit within the formatted address label. Allowed values are Never (the default) or Always.
TownFormat Select the required town format. Allowed values are Uppercase (the default) or Lowercase.

Common Output Fields

The following table lists the output fields that can be retrieved from all Master Address Files (MAFs).

Name TableName Description
Label1 .. Label9 Address Label Formatted address label comprising up to the specified number of lines.
Department Address Fields Department associated within an organisation.
Organisation Address Fields Organisation name for a delivery point.
Flat Address Fields Flat - formatted as if in a label.
Floor Address Fields Floor - formatted as if in a label.
POBox Address Fields PO Box - formatted as if in a label.
HouseName1 Address Fields Primary house name for a delivery point.
HouseName2 Address Fields Secondary house name for a delivery point.
Premise Address Fields Premise number - formatted as if in a label.
StreetName1 Address Fields First street of an address.
StreetName2 Address Fields Second street of an address.
DistrictName1 Address Fields Minor district of an address.
DistrictName2 Address Fields Major district of an address.
Town Address Fields The town name.
County Address Fields The county name.
Postcode Address Fields The postcode.
DPID Address Fields The address Delivery Point Suffix and checksum (3 characters)
or
The Delivery Point ID in Australia (8 characters).
Country Address Fields The country.
UDPRN Data Eight digit numeric code to uniquely identify a UK delivery point.
UAID Data The unique address identifier.
DedupeKey Data The deduplication key.
ExtendedDedupeKey Data The extended deduplication key.

Response Codes

The AtlasLive service will return the HTTP status 200 (OK) for all requests that it can interpret. This will be accompanied with a response document containing an application level status code.

Application Status Code Description
OK Successful.
NO_MATCH No matching address found.
LABEL_NOT_FORMATTED_ERROR The address will not fit within the size specified for formatted the address label.
TOO_MANY_MATCHES No output was returned because too many matches were found for the given search criteria.
BAD_LOOKUP Either no search criteria or invalid search criteria was provided.
BAD_SID An invalid search identity was provided.
BAD_PARAM An invalid parameter value was provided.
CANT_EXPAND The pick-list item cannot be expanded into a lower level pick-list.
OPEN_ERROR The specified Master Address File is unknown, not provisioned for the user or blocked.

For all status codes, other than OK, a textual description of the response is also provided (for example).

JSON

{
  "Status": "BAD_PARAM",
  "StatusDetails": {
    "Description": "The value of DisplayResults is not valid"
  }
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <Status>BAD_PARAM</Status>
  <StatusDetails>
    <Description>The value of DisplayResults is not valid</Description>
  </StatusDetails>
</Response>

Standard HTTP status codes are applied when the AtlasLive service cannot interpret the request. For example HTTP 401 (Unauthorised) is returned when the request does not contain user credentials or contains invalid credentials. HTTP 500 (Internal Server Error) is returned when the service encounters an unexpected failure.