Additional Data

Service version: 2
Last edit: 2019.03.28

On this page

Purpose

The Geometries Data Provider returns sets of coordinates that represent the outline of a city, country, or land area. The service supports batch requests of up to 20 identifiers.

Request data

HTTPS Method: GET

Generic URL format

GET https://<baseURL>/search/<versionNumber>/additionalData.<ext>?key=<Your_API_Key>&geometries=<geometryIds>[&geometriesZoom=<zoomLevel>]

Request Parameters

The following table describes the parameters that can be used in a Request.

• Required parameters must be used or the call will fail.
• Optional parameters, which are highlighted with [square brackets], may be used.
• If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

Optional Parameter: geometriesZoom

Clients can use the optional geometriesZoom parameter to control the level of detail in the returned geometry data.

• Requests with lower zoom levels return less detailed geometries, which are also smaller in data size.
• If the geometriesZoom parameter is not provided, the level of detail for that given geometry will not be changed.
• See the following Table 1 for possible geometriesZoom values and their level of detail represented as precision.
• The geometriesZoom value is applied to all the geometries in the Response.

▲ Return to top

Request Headers

Return to top

Response data

Response body

The Response will be a JSON object with the following structure:

{
  "additionalData": [
    {
      "providerID": "00004145-3100-3c00-1110-000023c34641",
      "error": "Requested geometry not found"
    },
    {
      "providerID": "00004145-3100-3c00-0000-000023c34645",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -58.618436,
                    -34.546888
                  ],
                  [
                    -58.618162,
                    -34.547092
                  ],
                  [
                    -58.617562,
                    -34.547538
                  ],
                  [
                    -58.616396,
                    -34.548406
                  ],
                  [
                    -58.615583,
                    -34.549011
                  ],
                  [
                    -58.612135,
                    -34.5516584
                  ],
                  [
                    -58.6114201,
                    -34.5526017
                  ],
                  [
                    -58.6108784,
                    -34.5530107
                  ],
                  [
                    -58.6105212,
                    -34.5532873
                  ],
                  [
                    -58.6098298,
                    -34.5537771
                  ],
                  [
                    -58.609559,
                    -34.553973
                  ],
                  [
                    -58.608954,
                    -34.5544455
                  ],
                  [
                    -58.6086543,
                    -34.5546817
                  ],
                  [
                    -58.607888,
                    -34.5552463
                  ],
                  [
                    -58.6077382,
                    -34.5553731
                  ],
                  [
                    -58.6068163,
                    -34.5561048
                  ],
                  [
                    -58.6060671,
                    -34.5566521
                  ],
                  [
                    -58.6053463,
                    -34.5571967
                  ],
                  [
                    -58.6045748,
                    -34.5577815
                  ],
                  [
                    -58.6039179,
                    -34.5582827
                  ],
                  [
                    -58.6037623,
                    -34.5584037
                  ],
                  [
                    -58.6031631,
                    -34.558905
                  ],
                  [
                    -58.6028692,
                    -34.5591125
                  ],
                  [
                    -58.618436,
                    -34.546888
                  ]
                ]
              ]
            },
            "id": "00004145-3100-3c00-0000-000023c34645"
          }
        ]
      }
    }
  ]
}

▲ Return to top

Response fields

The following table describes all of the fields that can appear in a Response. Fields are listed by the Response section they belong to and in the order that they appear in the Response.

▲ Return to top

HTTP Response codes

The following table contains Response codes signifying successful and failed requests to an API server.

▲ Return to top

Response headers

The following table contains HTTP Response headers of particular interest to Additional Data service clients.

▲ Return to top

Error Response

The error Response content type depends on the ext parameter.

Error Response example (JSON)

{
  "message":"Missing parameter 'parameterName'",
  "detailedError":{
    "code":"MissingParameter",
    "message":"Missing required parameter 'parameterName'.",
    },
  "httpStatusCode":"400"
}

▲ Return to top

Error Response fields

▲ Return to Top