| 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. |
/** @description 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. */
// @Api(Description="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.")
// @ApiResponse(Description="Bad Request: Try formatting the request differently. See the /swagger-ui/ documentation for more details", StatusCode=400)
// @ApiResponse(Description="Something went wrong here. Please contact your administrator or servicedesk@uk.rapp.com for more details.", StatusCode=500)
// @ApiResponse(Description="Request Accepted", StatusCode=202)
// @ApiResponse(Description="No content returned", StatusCode=204)
export class PostcodeLookupRequest
{
/** @description Using a Postcode to return addresses. */
// @ApiMember(DataType="string", Description="Using a Postcode to return addresses.", IsRequired=true, Name="Postcode")
public Postcode: string;
/** @description 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")
public HouseNo: string;
public constructor(init?: Partial<PostcodeLookupRequest>) { (Object as any).assign(this, init); }
}
TypeScript PostcodeLookupRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"Postcode":"String","HouseNo":"String"}