Integr8 Web Services Overview

Integr8 is a collection of data web services. Many features are common across all the web service methods; these common features are described below. For details on individual web services, see the service-specific sections below.

Web Services

• Address Capture - retrieve full address details from a postcode or partial address
• Email Validation - check if an e-mail address is valid
• Goneaway & Movers - check if a person has moved from their address
• Location - get grid references and longitude/latitude for an address
• Mailing Preference Service (MPS) - check if a person is registered on the MPS
• Telephone Preference Service (TPS) - check if a telephone number is registered on the TPS
• Telephone Capture - get a telephone number from a name and address
• Telephone Directory - browse the telphone directory
• Telephone Validation - check if a telephone number is valid
• Electoral Roll - find the residents living at an address

Overview

All methods have a "username" and "password" parameter at the start of the parameter list. These should be supplied as the username and password you used to register on the Data8 website.

All methods also have an "options" parameter at the end of the parameter list, which can accept any number of custom options that can affect how the method operates. This parameter can be set to null to use the default settings. The xxxSimple variation on each method is the same as the main version of the method, but without the “options” parameter. This allows the xxxSimple version to be used directly from a web browser, whilst the main version can only be called from code.

Because these parameters are the same for all methods, they are not described in further detail in the reference documentation.

You must have a licence to use each service individually, due to the varying licence restrictions from the data providers. Please contact your Data8 account manager or email info@data-8.co.uk to arrange access to any services you wish to use.

Each method returns a structure that includes a Status object as well as the requested data. This Status object includes the following important information:

• Success. This value indicates whether the method call succeeded or not. If this is false, the other data included in the results returned from the method are potentially invalid and should be ignored.
• ErrorMessage. If Success is false, this value will contain a human-readable description of why the method call failed. This could be because your username or password was incorrect, or your account is not set up with the appropriate licence to access the requested service. It could also be that your account has run out of credits, or there was some problem with the parameters supplied to the method.
• CreditsRemaining. If Success is true, this value will indicate how many credits you have left for future use of this service. When this reaches zero, you will no longer be able to access the service until you add more credits to your account.

Many services use data of a common type. These types are described in more detail in the common types area.