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:
- Go to our your swagger editor and click the GET /address/layouts/v1, so that it expands.
- Click Try it out in the upper-right corner.
- Click Execute to send the request to the API.
- 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.
Response body parameters
Name |
Type |
Description |
name |
string |
The name of the layout. |
countries |
string |
The country information including layout line type. |
license |
string |
Information regarding the license elements. |
Layout lines types
Type |
Description |
address |
This line contains any address information. |
name |
This line contains a name. |
data_plus |
This line contains DataPlus information. |
ancillary |
This line contains Ancillary information. |
Licenses
Name |
Type |
Description |
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. |