PostcodeServices13
Click here for a complete list of operations.
ReturnPremise_ByPostcode
This function is used to return a complete list of premises for a search on a Postcode. A single credit is taken on lookup.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /uk/postcodeservices13.asmx HTTP/1.1 Host: ws.epostcode.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://ws.epostcode.com/uk/ReturnPremise_ByPostcode" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ReturnPremise_ByPostcode xmlns="http://ws.epostcode.com/uk/"> <sPostcode>string</sPostcode> <AccountName>string</AccountName> <LicenceID>string</LicenceID> <MachineID>string</MachineID> </ReturnPremise_ByPostcode> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ReturnPremise_ByPostcodeResponse xmlns="http://ws.epostcode.com/uk/"> <ReturnPremise_ByPostcodeResult> <List> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> </List> <IsError>boolean</IsError> <ErrorMessage>string</ErrorMessage> </ReturnPremise_ByPostcodeResult> </ReturnPremise_ByPostcodeResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /uk/postcodeservices13.asmx HTTP/1.1 Host: ws.epostcode.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ReturnPremise_ByPostcode xmlns="http://ws.epostcode.com/uk/"> <sPostcode>string</sPostcode> <AccountName>string</AccountName> <LicenceID>string</LicenceID> <MachineID>string</MachineID> </ReturnPremise_ByPostcode> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ReturnPremise_ByPostcodeResponse xmlns="http://ws.epostcode.com/uk/"> <ReturnPremise_ByPostcodeResult> <List> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> </List> <IsError>boolean</IsError> <ErrorMessage>string</ErrorMessage> </ReturnPremise_ByPostcodeResult> </ReturnPremise_ByPostcodeResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /uk/postcodeservices13.asmx/ReturnPremise_ByPostcode?sPostcode=string&AccountName=string&LicenceID=string&MachineID=string HTTP/1.1 Host: ws.epostcode.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ListAddressPremises xmlns="http://ws.epostcode.com/uk/"> <List> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> </List> <IsError>boolean</IsError> <ErrorMessage>string</ErrorMessage> </ListAddressPremises>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /uk/postcodeservices13.asmx/ReturnPremise_ByPostcode HTTP/1.1 Host: ws.epostcode.com Content-Type: application/x-www-form-urlencoded Content-Length: length sPostcode=string&AccountName=string&LicenceID=string&MachineID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ListAddressPremises xmlns="http://ws.epostcode.com/uk/"> <List> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> <ListAddressPremise> <List_Address>string</List_Address> <Unique_Delivery_Point>string</Unique_Delivery_Point> <Return_Code>string</Return_Code> </ListAddressPremise> </List> <IsError>boolean</IsError> <ErrorMessage>string</ErrorMessage> </ListAddressPremises>