AddressLookupService

AddressRequest

The following routes are available for this service:
GET	/2.0/address/{Postcode}
GET	/2.0/address/{Postcode}/{HouseNo}

import java.math.*
import java.util.*
import net.servicestack.client.*


open class AddressRequest : IHasVersion
{
    var Version:Int? = null
    /**
    * Using a Postcode to return addresses.
    */
    @ApiMember(DataType="string", Description="Using a Postcode to return addresses.", IsRequired=true, Name="Postcode", ParameterType="path")
    var Postcode:String? = null

    /**
    * Optional input value to limit the return data to a specific address.
    */
    @ApiMember(DataType="string", Description="Optional input value to limit the return data to a specific address.", Name="House Name or Number", ParameterType="path")
    var HouseNo:String? = null
}

@DataContract(Name="LookupResult", Namespace="http://schemas.datacontract.org/2004/07/PostcodeLookupService")
open class LookupResult
{
    @DataMember
    var Addresses:ArrayList<Address>? = null

    @DataMember
    var errormsg:String? = null
}

@DataContract(Name="Address", Namespace="http://schemas.datacontract.org/2004/07/PostcodeLookupService")
open class Address
{
    @DataMember
    var County:String? = null

    @DataMember
    var Id:Int? = null

    @DataMember
    var Locality:String? = null

    @DataMember
    var Organisation:String? = null

    @DataMember
    var Postcode:String? = null

    @DataMember
    var Property:String? = null

    @DataMember
    var RAPPPremiseId:Int? = null

    @DataMember
    var Street:String? = null

    @DataMember
    var Town:String? = null

    @DataMember
    var FullAddress:String? = null
}

Kotlin AddressRequest DTOs

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
}