Datasets, layouts, and prompt sets

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.
   
2. Click Try it out in the upper-right corner.
3. In the Parameter section:
   • Enter the dataset code in the dataset_code field.
4. Click Execute to send the request to the API.
5. 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.

Test format against layout and dataset

To test your layout against a particular dataset to see how it will be formatted:

1. Go to our your swagger editor and click the GET /address/layouts/v1, so that it expands.
   
2. Click Try it out in the upper-right corner.
3. In the Parameter section:
   • Enter the dataset code in the dataset_code field.
   • Enter the engine in the engine field.
   • (Optional) Enter the layout name in the layout field.
4. Click Execute to send the request to the API.
5. View the response returned by the API under Responses. This will tell you whether this combination of dataset, engine and layout will work (either Success or ???). 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.

An address can be submitted as one or as many fields; the prompt_set property defines which address elements can be entered in each field, for example a field might be constrained so that it only accepts postcodes. The prompt set definition depends on the search type used.

The available values are:

• OneLine - All search text to be submitted upon a single line.
• Default - The default prompt set for the engine.
• Generic - A general data-independent prompt set.
• Optimal - Requires the minimum possible amount of search text to perform a search.
• Alternate - An extended country-specific set for where the information required for an optimal search is not available.
• Alternate2 - A different alternative prompt set (USA only).
• Alternate3 - A different alternative prompt set where not all address elements are present.

To see the prompt set definitions:

1. Go to our your swagger editor and click the GET /address/layouts/v1, so that it expands.
   
2. Click Try it out in the upper-right corner.
3. In the Parameter section:
   • Enter the dataset code in the dataset_code field.
   • Enter the engine in the engine field.
   • (Optional )Enter the prompt_set in the prompt_set field.
4. Click Execute to send the request to the API.
5. 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.

To test if the given dataset, engine and layout are available for you to use for a given search:

1. Go to our your swagger editor and click the GET /address/layouts/v1, so that it expands.
   
2. Click Try it out in the upper-right corner.
3. In the Parameter section:
   • Enter the dataset code in the dataset_code field.
   • Enter the engine in the engine field.
   • (Optional) Enter the layout name in the layout field.
4. Click Execute to send the request to the API.
5. View the response returned by the API under Responses. This will tell you whether this combination of dataset, engine and layout will work ( Success). 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.