Web services listing
Web service documentation  -  Postcode Anywhere  -  Interactive/RetrieveChanges/v1.00

PostcodeAnywhere/Interactive/RetrieveChanges (v 1.00)

Lists the changes that have happened to the database over the given period of time.

SOAP WSDL

Standard HTTP
http://services.postcodeanywhere.co.uk/PostcodeAnywhere
/interactive/RetrieveChanges/v1.00/wsdlnew.ws

Secure HTTPS
https://services.postcodeanywhere.co.uk/PostcodeAnywhere
/interactive/RetrieveChanges/v1.00/wsdlnew.ws

REST code samples & end points

We have sample code available for most development environments. Choose a language below and click the button to view the code.

View

We're more than just a SOAP service. Select an end point below and click the button to view an example.

View

Try it

Enter your values in the form below to try the service for yourself.

Name Value Type Description Default Example
FromDate Date Start the report at this date.   20 October 2010
ToDate * Date Finish the report at this date. If not supplied, today is assumed.   21 October 2010
   

* Optional - if left blank the default is used.

Parameters

Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which was generated when you registered. You can create any number of keys, each of which can be reported on individually and have specific security settings.

Name Type Description Default Values Example
Key String The key to use to authenticate to the service.     AA11-AA11-AA11-AA11
FromDate Date Start the report at this date.     20 October 2010
ToDate * Date Finish the report at this date. If not supplied, today is assumed.     21 October 2010
UserName * String The username associated with the Royal Mail license (not required for click licenses).     David

* Optional - if left blank the default is used.

Fields

The response from the web service is a table with the specification below. Where no items are found, the response will be empty (although all endpoints specify the columns). If an error occurs, the response will not follow this format. Instead the response will be an error table (see general and specific errors).

Name Type Description Values Example
ChangedOn Date The date the change was actioned.    
ChangeType String The type of change. Addition | Update | Deletion | Unknown  
ReasonForChange String The reason for the change. NewPostcodeOrAddress | ErrorCorrection | PostcodeOrAddressDeleted | LocalityOrPostcodeOrStreetChanged | OrganisationNameChanged | StatusChange | LargeUserMovingOrCeased | BuildingChanged | LargeUserAdddressChanged | Unknown  
Udprn Integer The Royal Mail UDPRN (Unique Delivery Point Reference Number) for the address.   26742632
Company String The name of the company.   Postcode Anywhere (Europe) Ltd
Department String Department name (rarely used).    
Line1 String Line 1 of the address.   Enigma House
Line2 String Line 2 of the address.   Elgar Business Centre
Line3 String Line 3 of the address (rarely used).   Moseley Road
Line4 String Line 4 of the address (rarely used).   Hallow
Line5 String Line 5 of the address (rarely used).    
PostTown String The post town for the address.   Worcester
County String The postal county for the address.   Worcestershire
Postcode String The postcode for the address.   WR2 6NJ
Mailsort Integer The mailsort code for the address.   70122
Barcode String The barcode for the address.   (WR26NJ3UT)
Type String The type of address. Residential | SmallBusiness | LargeBusiness | Unknown SmallBusiness
DeliveryPointSuffix String The 2 character delivery point suffix.   3U
SubBuilding String The name of the sub building (flat / unit etc).   Enigma House
BuildingName String The building name if present.   Elgar Business Centre
BuildingNumber String The number (or number range) of the building.    
PrimaryStreet String The primary thoroughfare name.   Moseley Road
SecondaryStreet String The secondary thoroughfare name. Usually a small street off the primary.    
DoubleDependentLocality String The least significant locality (rarely used), possibly a hamlet.    
DependentLocality String Less significant locality name, possibly a village.   Hallow
PoBox String The number of the PO Box if present (may contain non numeric items).    
PrimaryStreetName String The name of the primary street (e.g. High in High Street).    
PrimaryStreetType String The type of the primary street (e.g. Street in High Street).    
SecondaryStreetName String The name of the secondary street (e.g. High in High Street).    
SecondaryStreetType String The type of the secondary street (e.g. Street in High Street).    
CountryName String The name of the country. England | Scotland | Wales | Northern Ireland | Isle of Man | Channel Islands | Unknown England

Prices

This table will outline the costs (in credits) or required licenses for this web service. Many web services support both credits or licenses while many are free!

Option Cost Notes
Credit Pack: Internal Addresses (previously Internal Full PAF) 1 credit(s) Per response / item returned
Credit Pack: Website Addresses (previously Full PAF) 1 credit(s) Per response / item returned
License: Per user Complete addresses 1 license
License: Per user per area Complete addresses 1 license
License: Per server Complete addresses 1 license
License: Per server per area Complete addresses 1 license
License: Multi system Complete addresses 1 license
License: Per multi system per area Complete addresses 1 license
License: Per user Street addresses 1 license

Response Errors

Below are the errors which are specific to this web service (more general errors are listed below). If an error occurs, an error table like the one below will be returned (developers should test for a 4 column table with columns "Error", "Description", "Cause" and "Resolution". An error response will only contain a single row.

Error Description Cause Resolution
1001 FromDate Required No FromDate was supplied. Please supply a valid FromDate and try again.
1002 FromDate Invalid The FromDate should be a date in the past. Please supply a valid FromDate and try again.
1003 ToDate Invalid The ToDate should be greater than the FromDate. Please supply a valid ToDate and try again.

General Errors

These errors are general service errors and may be returned by any web service. Note that general errors are all below 100 while service specific errors start at 1000.

Error Description Cause Resolution
-1 Unknown error The cause of the error is unknown but details have been passed to our support staff who will investigate. These problems are typically short lived and often resolved by trying again in a few minutes.
2 Unknown key The key you are using to access the service was not found. Please check the key is correct, it should be the in form AA11-AA11-AA11-AA11.
3 Account out of credit Your account is either out of credit or has insufficient credit to service this request. Please check your account balance and top it up if necessary.
4 Request not allowed from this IP The request was disallowed from the IP address. Check the security settings on the key first. If that looks fine, please contact support as it may be from an IP addresses on our blacklist.
5 Request not allowed from this URL The request was disallowed from the URL. Check the security settings on the key first. If that looks fine, please contact support as it may be from a URL on our black list.
6 Web service not available on this key The requested web service is disallowed on this key. Check the security settings on the key first. You can limit a key to certain web services.
7 Web service not available on your plan The requested web service is not currently available on your payment plan. Some services are only available in specific regions due to licensing restrictions. Please contact us for more information.
8 Key daily limit exceeded The daily limit on the key has been exceeded. Alter the daily limit on the key if the usage seems normal. Check the usage details first though to see if it is unexpected.
9 Surge protector running The surge protector is currently enabled and has temporarily suspended access to the account. You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests. Unsuspend your account now.
10 Surge protector triggered An unusually large number of requests have been processed for your account and the surge protector has been enabled. You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests. Unsuspend your account now.
11 No valid license available The request requires a valid license but none were found. Please check your purchase history, you may be using a license that is no longer valid or of an incorrect type.
12 Management key required To use this web service you require a management key. Management can be enabled on any key but it is recommended management keys are use with care. Log onto the website and create a new management key or change an existing key.
13 Demo limit exceeded The daily demonstration limit for this service or account has been exceeded. The limit will be reset at midnight tonight or, if you would like the limit increased, please contact us.
14 Free service limit exceeded You have used too many free web services. Many of our web services are designed to operate in several stages - the first is usually a Find service followed by a Retrieve. If you use too many Finds without the corresponding number of retrieves you will receive this error. For more information, please contact us.
15 Wrong type of key The type of key you're using isn't supported by this web service. This usually happens if you're using a user or server license with a web service that only supports transactional keys. Please try another key and try again.
16 Key expired The key you are trying to use has expired. Please check that you are using the right key - a new one may have been issued if you have recently renewed your key. Please contact us if your have any questions.