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[].pointLon |
Longitude. | Number | |
directionRows[].pointLat |
Latitude. | Number | |
directionRows[].pointRadius |
Radius. | Number | |
directionRows[].pointCountryBorder |
Search within the borders of the country. | Boolean | |
directionType |
Enumerated direction type "DEFAULT, POINT" (deprecated). | String | |
point.countryStrict |
Allowance beyond country borders in radius search. | Boolean | |
point.countryStrictSign |
Country sign for radius search. | String | |
point.lat |
Latitude. | Number | |
point.lon |
Longitude. | Number | |
point.radius |
Radius. | Number | |
point.townId |
City identifier. | Number | |
countrySigns |
List of countries (deprecated). | Array of strings | + |
regionIds |
List of region identifiers (deprecated). | Array of numbers | |
areaIds |
List of area identifiers (deprecated). | Array of numbers | |
towns.townId |
City identifier (deprecated). | Number | |
towns.name |
City name (deprecated). | String | |
towns.postalCodes |
List of postal codes (deprecated). | Array of strings | |
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 | |
excludeTowns.townId |
City identifier from the reference book (deprecated). | Number | |
excludeTowns.name |
City name (deprecated). | String |
Example
JSON
{
"directionRows": [
{
"countrySign": "",
"regionId": 0,
"areaId": 0,
"townId": 0,
"postalCode": "",
"postalZone": "",
"pointLon": 0.0,
"pointLat": 0.0,
"pointRadius": 0,
"pointCountryBorder": false
}
],
"point": {
"countryStrict": false,
"countryStrictSign": "",
"lat": 0.0,
"lon": 0.0,
"radius": 0.0,
"townId": 0
},
"excludeСountries": [],
"excludeRegionIds": [],
"excludeAreaIds": [],
"excludeTownIds": []
}