Получение данных по офисам

post
Список офисов

https://api.lotinfo.ru/v1/OFFICES
Эта конечная точка позволяет получить списки офисов.
Request
Response
Request
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
filter
optional
object
Фильтры для поиска. Параметры "filter": - systemId (integer) - ID офиса. - cityId (integer) - ID города.
order
optional
object
Поля сортировки. Параметры "order": - id - ID офиса. - apiIdExchange (integer) - ID офиса в вашей системе. Примечание: этот параметр вы указываете при добавлении офиса по API. - addDate - Дата добавления. Значения для всех полей: asc - по возрастанию, desc - по убыванию. По умолчанию: 'id': 'asc'.
projection
optional
array
Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.
limit
optional
integer
Максимальное число выводимых офисов. По умолчанию: 3000. Максимальное значение: 3000.
offset
optional
integer
Сдвиг. По умолчанию: 0.
Response
200: OK
Пример ответа (на запрос из примера ниже).
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"name": {
"fieldName": "Название офиса",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "Лотинфо"
}
]
}
}
]
}
400: Bad Request
Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [
{
"error": 10,
"error_text": "Данного поля не существует.",
"error_field": "new_field"
}
]
}

Пример запроса

POST https://api.lotinfo.ru/v1/OFFICES?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"limit": 5,
"filter": {
"systemId": 100
},
"projection": ["name"]
}