AddressLookupService

<back to all web services

AddressRequest

Requires Authentication
The following routes are available for this service:
GET/2.0/address/{Postcode}
GET/2.0/address/{Postcode}/{HouseNo}
AddressRequest Parameters:
NameParameterData TypeRequiredDescription
VersionqueryintNo
PostcodepathstringYesUsing a Postcode to return addresses.
HouseNopathstringNoOptional input value to limit the return data to a specific address.
LookupResult Parameters:
NameParameterData TypeRequiredDescription
AddressesformAddress[]No
errormsgformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
CountyformstringNo
IdformintNo
LocalityformstringNo
OrganisationformstringNo
PostcodeformstringNo
PropertyformstringNo
RAPPPremiseIdformintNo
StreetformstringNo
TownformstringNo
FullAddressformstringNo

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

HTTP + JSV

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

GET /2.0/address/{Postcode} HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Addresses: 
	[
		{
			County: String,
			Id: 0,
			Locality: String,
			Organisation: String,
			Postcode: String,
			Property: String,
			RAPPPremiseId: 0,
			Street: String,
			Town: String,
			FullAddress: "String, String, String, String, String, String"
		}
	],
	errormsg: String
}