AddressLookupService

PostcodeLookupRequest

Postcode Lookup Requests

This RESTful API returns UK Address data in both POST and GET. Input=Postcode(Mandatory), HouseNameorNumber=(Optional). You must provide valid authentication to make a request.

The following routes are available for this service:
POST	/address	Call to list addresses	POST request to search for addresses. Using Postcode and House Name/Number as input.
GET	/address/{Postcode}	Call to list addresses	GET request to search for addresses. Using Token, Postcode and House Name/Number as input.
GET	/address/{Postcode}/{HouseNo}	Call to show a specific address	GET request to search for addresses. Using Token, Postcode and House Name/Number as input.

"use strict";
export class PostcodeLookupRequest {
    /** @param {{Postcode?:string,HouseNo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Using a Postcode to return addresses. */
    Postcode;
    /**
     * @type {string}
     * @description Optional input value to limit the return data to a specific address. */
    HouseNo;
}

JavaScript PostcodeLookupRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /address HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostcodeLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostcodeLookupService.ServiceModel.Types">
  <HouseNo>String</HouseNo>
  <Postcode>String</Postcode>
</PostcodeLookupRequest>