Terminals for the selected location
General information
The service allows receiving the list of terminals for the selected city.
Terminals for the selected location
Method request
Request example
Method address: https://api.dellin.ru/v1/public/request_terminals.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "code":"7800000000000000000000000", "cityid":"2423", "direction":"derival" }
Method address: https://api.dellin.ru/v1/public/request_terminals.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <code>7800000000000000000000000</code> <cityid>2423</cityid> <direction>derival</direction> </request>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sessionID | No | string | To get the session ID, use the User Authorization method |
code | No* | string | City CLADR code (1). See "Using CLADR codes" page *One of the excluding parameters must be passed in the request: "code" or "cityID" |
cityID | No* | integer | City ID from the "Places" directory. *One of the excluding parameters must be passed in the request: "code" or "cityID" |
direction | No | string | Terminals function. Possible values:
|
Note:
|
Method response
Response example
{ "terminals":[ { "id":1, "city":"Санкт-Петербург", "cityID":1, "city_code":"7800000000000000000000000", "name":"Санкт-Петербург-Парнас", "address":"Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б", "default":true, "express":true } ] }
<response> <terminals> <id>1</id> <city>Санкт-Петербург</city> <cityID>1</cityID> <city_code>7800000000000000000000000</city_code> <name>Санкт-Петербург-Парнас</name> <address>Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б</address> <default>true</default> <express>true</express> </terminals> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
terminals | array of Terminals | The list of terminals located in the city and in the nearest locations (if any). If there are no terminals in the indicated city, the list of the terminals for the nearest location is provided. The list is not ordered - the terminals are listed in accordance with their order in DB |
terminals.id | integer | Terminal ID from "Terminals" directory |
terminals.city | string | Terminal city |
terminals.cityID | integer | Terminal city ID from "Places" dirctory |
terminals.city_code | string | Terminal city CLADR (1) code |
terminals.name | string | Terminal name |
terminals.address | string | Terminal address |
terminals.default | boolean | Flag indicating that the terminal is the default city terminal. Each location present in the response has one default terminal |
terminals.express | boolean | Flag indicating that the terminal accepts express cargoes |
Notes:
|