[POST] …/v1/Firm/get
Возвращает информацию о предприятии
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id предприятий |
parent_ids | array of int64 | Необязательный | Массив id групп предприятий |
deleted_mark | bool | Необязательный | Метка об удалении |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
search | string | Необязательный | Строка поиска по полю name |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id предприятия), Name (Наименование предприятия), Fullname (Полное наименование), Bossname (ФИО руководителя), Address (Адрес), Phones (Телефоны), Inn (ИНН), BankName (Наименование банка), Mfo (МФО), Rs (Расчетный счет), Oked (ОКЭД), VatIndex (НДС),LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,2],
"parent_ids":[1],
"sort_orders":
[
{
"column":'Name',
"direction":'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | array of Firm | Обязательный | Массив объектов Firm |
Пример ответа
{
"ok": true,
"result":
[
{
"id": 5,
"group":
{
"id": 82,
"parent_id": 0,
"name": "Apple",
"last_update": 1533619909
},
"deleted_mark": false,
"last_update": 1533714741,
"name": "Megamarket",
"fullname": null,
"address": null,
"phones": null,
"description": null,
"inn": null,
"bank_name": null,
"mfo": null,
"rs": null,
"oked": null
}
],
"next_offset": 0,
"total": 2
}