Layout details

If you want to check the details about a custom layout you have already created, follow the steps below.

Layout API

1. Go to our API specification page and click the GET /address/layouts/v2/{name}, so that it expands.
   

2. Click Try it out in the upper-right corner.

3. In the Parameter section:

   • Enter your token in the Auth-Token field.
   • Enter the name of the layout you want to view.

4. Click Execute to send the request to the API.

5. View the response returned by the API under Responses. This will give you information regarding the layout including:

   • The details for each address line
   • Settings that define, for example:
     • Element separators that are used to separate multiple address elements on the same line, e.g. a comma to separate a sub-building name from a building name
     • Elements that shoud be abbreviated
     • Elements that should be capitalised
   • All the fundamental information in /address/layouts/v2 endpoint

   Response status codes

   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.

Layout builder

1. Login to the Self Service Portal.
2. Navigate to the Layout management dashboard.
   • For more detail on accessing Layout management capabilities in the Self Service Portal, refer to the introduction to this guide.
3. Click the View details button in the Action column. This will give you configured layout information including:
   • Basic information of the layout, such as layout name, applicable country, and dataset.
   • The details for each address line:
     • Elements that shoud be abbreviated
     • Elements that should be capitalised
     • Element separators that are used to separate multiple address elements on the same line, e.g. a comma to separate a sub-building name from a building name