WebAPI

<back to all web services

GetAddressByPostalCode

The following routes are available for this service:
GET/GetAddressByPostalCode/{CountryCode}/{PostalCode}Retrieve a list of addresses that are associated with the given postal code.
Parameters:
NameParameterData TypeRequiredDescription
CountryCodepathstringYes
PostalCodepathstringYes

To override the Content-type in your clients 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.

POST /jsv/reply/GetAddressByPostalCode HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	CountryCode: String,
	PostalCode: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EquifaxAddresses: 
	[
		{
			AddressInfo: 
			{
				AddressLine1: String,
				AddressLine2: String,
				City: String,
				CountyCode: String,
				PostalCode: String,
				CountryCode: String
			},
			PtcAbcCodeInfo: 
			{
				PtcAbcCode: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}