Skip to content

Structure "Directions"

This structure describes the basic parameters of the direction point.

Name Description Data type Required
directionRows[].countrySign Country sign. String
directionRows[].regionId Region identifier. Number
directionRows[].areaId Area identifier. Number
directionRows[].townId Town identifier. Number
directionRows[].postalCode Postal code. Number
directionRows[].postalZone Postal zone. Number
directionRows[].pointRadius Radius in meters. Number
directionRows[].pointCountryBorder Search within the borders of the country. Boolean
excludeСountries List of excluded country codes. Array of strings
excludeRegionIds List of excluded region identifiers. Array of numbers
excludeAreaIds List of excluded area identifiers. Array of numbers
excludeTownIds List of excluded town identifiers. Array of numbers

Example

JSON
{
    "directionRows": [
        {
            "countrySign": "",
            "regionId": 0,
            "areaId": 0,
            "townId": 0,
            "postalCode": "",
            "postalZone": "",
            "pointLon": 0.0,
            "pointLat": 0.0,
            "pointRadius": 0,
            "pointCountryBorder": false            
        }
    ],
    "excludeСountries": [],
    "excludeRegionIds": [],
    "excludeAreaIds": [],
    "excludeTownIds": []
}