Data Quality user documentation
home/Address validation/Batch API/API reference (REST)/Layouts

Layouts

There are different layouts available with Pro Web. You can use a public one that is available to all users, or contact us to create your own private layout to suit your solution. To check what you have available:

  1. Go to our your swagger editor and click the GET /address/layouts/v1, so that it expands.
    GET /address/layouts/v1 swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what layouts are available to you.
    Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

Headers

Name Type Description
Configuration
(Optional)		 string Custom configuration name.

Query parameters

Name Type Description
details
(Optional)		 boolean Includes layout details in the response. Be aware that enabling this might increase the response time considerably.
layout
(Optional)		 string Submit the name of a single layout to retrieve details for or omit to retrieve details for all layouts.

Body parameters

Name Type Description
configuration_file
(Optional)		 string The name of the configuration file.
layouts collection Collection of layout information.
name string Name of the layout.
countries
(Optional)		 collection Collection of countries that this layout is defined for. See countries collection for more information on each object in the collection.

Countries collection

Each object in the countries collection contains the following items.

Name Type Description
country string The country this layout applies to.
lines
(Optional)		 collection Collection of lines in the layout.
description
(Optional)		 string A description of a layout line.
type string The type of information that is returned on this line. The possible values are:
  • address - The line contains address information.
  • name - The line contains name information.
  • data_plus - The line contains DataPlus information.
  • ancillary - The line contains ancillary information.
license
(Optional)		 string Status of the dataset license.
days_left integer The number of days left.
data_days_left integer The number of days left your dataset is available.
version string Version information.
copyright string Copyright information.

The following response codes can be returned by the API:

Status Code Reason phrase Description
200 Success Request processed successfully.
400 Bad Request Request failed due to malformed syntax.
408 Request timeout Response was not returned within the timeout allowance.
500 Internal Server Error The server has encountered an error.
Batch API

API reference (REST)