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

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

POST https://api.lotinfo.ru/v1/OFFICES

Эта конечная точка позволяет получить списки офисов.

Query Parameters

NameTypeDescription

token*

string

Ваш токен.

Request Body

NameTypeDescription

encoding

integer

Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".

filter

object

Фильтры для поиска. Параметры "filter": - systemId (integer) - ID офиса. - cityId (integer) - ID города.

order

object

Поля сортировки. Параметры "order": - id - ID офиса. - apiIdExchange (integer) - ID офиса в вашей системе. Примечание: этот параметр вы указываете при добавлении офиса по API. - addDate - Дата добавления. Значения для всех полей: asc - по возрастанию, desc - по убыванию. По умолчанию: 'id': 'asc'.

projection

array

Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.

limit

integer

Максимальное число выводимых офисов. По умолчанию: 3000. Максимальное значение: 3000.

offset

integer

Сдвиг. По умолчанию: 0.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": [
    {
      "name": {
        "fieldName": "Название офиса",
        "fieldType": "value",
        "fieldMulti": "not_multi",
        "values": [
          {
            "value": "Лотинфо"
          }
        ]
      }
    }
  ]
}

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

POST https://api.lotinfo.ru/v1/OFFICES?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json

{
  "limit": 5,
  "offset": 10,
  "filter": {
    "systemId": 100
  },
  "projection": ["name"]
}

Last updated