Web services listing
Web service documentation  -  Management  -  Keys/Add/v1.10

Management/Keys/Add (v 1.10)

Adds a new key to the account.

SOAP WSDL

Standard HTTP
http://services.postcodeanywhere.co.uk/Management
/keys/Add/v1.10/wsdlnew.ws

Secure HTTPS
https://services.postcodeanywhere.co.uk/Management
/keys/Add/v1.10/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

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
Name String Name for the new key.     Accounts Department
DailyLimit * Integer The maximum number of transactions which are permitted on the key per day.     100
DailyIPLimit * Integer The maximum number of transactions which are permitted per IP address per day (only when using client side endpoints). Ignored if DailyIPLimitEnabled is unset. Set to 0 to disable. 0   0
DailyIPLimitExclusions * Array of String List of IPs that are ignored from the IP limiter (ie when DailyIPLimit>0). Can be single IP addresses and ranges.     194.75.186.2
Type * String The type of key to create. Normal|Management   Normal
LimitedWebServices * Array of String List of web services that this key will be limited to. Leave the list empty to enable access to all services.     Management/Keys/Add
LimitedURLs * Array of String List of URLs that this key will be limited to (only when using client side endpoints). Leave the list empty to enable access from ann URLs. NOTE: the URL must include the protocol (e.g. http://).     http://www.postcodea
nywhere.co.uk
LimitedIPs * Array of String List of IPs that this key will be limited to. Leave the list empty to enable access from all URLs. Individual IPs (e.g. 217.10.139.200) or ranges (e.g. 217.10.139.200-217.10.139.210) are permitted.     194.75.186.1-194.75.
186
DataLevel * Array of String The data level that should be applied to this key. Selects between premises and streets. Only relevant for Postcode Anywhere address capture services using Royal Mail data. Address Address | Street Address
DataLocation * Array of String The location the data will be used in. Selects between internal and website credits. Only relevant for Postcode Anywhere address capture services using Royal Mail data. Website Website | Internal Website

* 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
Key String The key's unique ID.   BB11-BB11-BB11-BB11
Name String The name of the key.   Customers
DailyLimit Integer The maximum number of transactions permitted per day.   10
DailyIPLimit Integer The maximum number of transactions which are permitted per IP address per day.   10
DailyIPLimitExclusions String List of IPs that are ignored from the IP limiter (ie when DailyIPLimit>0). Comma separated.   10
Type String The type of key.   Normal
LimitedWebServices String List of web services that this key will be limited to. Comma separated.   Management/Keys/Add/v1.00
LimitedURLs String List of URLs that this key will be limited to (only when using client side endpoints). Comma separated.   http://www.postcodeanywhere.co.uk
LimitedIPs String List of IPs that this key will be limited to. Leave the list empty to enable access from all URLs. Comma separated.   10.0.0.1-10.0.0.255,10.0.1.1

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: Standard Free!  

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 Name Required No Name was supplied. Please supply a valid Name and try again.
1002 DailyLimit Invalid DailyLimit must be a positive integer. Please supply a valid DailyLimit and try again.
1003 DailyIPLimit Invalid DailyIPLimit must be a positive integer. Please supply a valid DailyIPLimit and try again.
1004 Type Invalid Valid types are Normal and Management. Please supply a valid Type and try again.
1005 DataLevel Invalid Permitted values for DataLevel are Address and Street. Please supply a valid DataLevel and try again.
1006 DataLocation Invalid Permitted values for DataLocation are Website and Internal. Please supply a valid DataLocation 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.
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.
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.