Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
rest_s [2020/03/23 16:54] timofeev |
rest_s [2022/10/18 10:03] timofeev |
||
---|---|---|---|
Строка 7: | Строка 7: | ||
updated_gte - Только измененные >= этой даты\\ | updated_gte - Только измененные >= этой даты\\ | ||
updated_lte - Только измененные < = этой даты\\ | updated_lte - Только измененные < = этой даты\\ | ||
- | Даты должны иметь формат ДД.ММ.ГГГ ЧЧ.ММ.СС:мс. | + | gr - Признак группы. 0 - только записи без групп, 1- группы и записи, 2- только группы. Другие значения недопустимы. По умолчанию - 0.\\ |
+ | roditel - Код группы- родителя, если задан, то возвращаются только записи, входящие в указанную группу.\\ | ||
- | ===Клиенты и адреса=== | + | [[rest_cl|Клиенты и адреса - получение записи или списка]] |
- | ==- получить список клиентов== | + | |
- | Пример запроса (записи не более 2 клиентов, созданных или обновленных после 1 января 2020 г.): | + | |
- | <code> | + | |
- | GET http://127.0.0.1:10400/api/clients?updated_gte="01.01.2020"&limit=2 | + | |
- | </code> | + | |
- | + | ||
- | Ответ: | + | |
- | <code> | + | |
- | { | + | |
- | "result": [ | + | |
- | { | + | |
- | "ID": "1000000000001", | + | |
- | "NAIMENOVANIE": "Буняковский Виктор Яковлевич ИП", | + | |
- | "TELEFON": "71112223311", | + | |
- | "DSZD": "24.03.2019 9:39:30", | + | |
- | "DATAIZM": "12.01.2020 14:16:25", | + | |
- | "DISP": "1000000000010" | + | |
- | }, | + | |
- | { | + | |
- | "ID": "1000000000002", | + | |
- | "NAIMENOVANIE": "Андрей - Научная ул,24, кв.41", | + | |
- | "TELEFON": "78881112233", | + | |
- | "DSZD": "24.03.2019 9:40:45", | + | |
- | "DATAIZM": "02.03.2020 14:54:11", | + | |
- | "DISP": "1000000000010" | + | |
- | } | + | |
- | ], | + | |
- | "limit": 2, | + | |
- | "total": 2 | + | |
- | } | + | |
- | </code> | + | |
- | Поля: | + | |
- | ID - Уникальный идентификатор (код записи)\\ | + | |
- | NAIMENOVANIE - Имя/Наименование клиента\\ | + | |
- | TELEFON - Номер телефона (общий по клиенту)\\ | + | |
- | DOP_SC - Дополнительные сведения (комментарий по клиенту)\\ | + | |
- | EMAIL - Электронная почта\\ | + | |
- | DSZD - Дата создания\\ | + | |
- | DATAIZM - Дата последнего обновления \\ | + | |
- | DISP - ответственный за клиента (код из справочника сотрудников)\\ | + | |
- | Состав полей может отличаться от приведенного, пустые значения не передаются.\\ | + | |
- | + | ||
- | ==Получить реквизиты контрагента по его коду== | + | |
- | GET /clients/:id | + | |
- | Пример | + | |
- | <code> | + | |
- | GET http://127.0.0.1:10400/api/clients/1000000000048 | + | |
- | </code> | + | |
- | Ответ | + | |
- | <code> | + | |
- | { "result": {"ID": "1000000000048", | + | |
- | "NAIMENOVANIE": "339-й Стрелковой Дивизии ул,123, кв.33", | + | |
- | "TELEFON": "78124243353", | + | |
- | "DSZD": "30.11.2019 11:30:19", | + | |
- | "DATAIZM": "21.01.2020 7:27:43", | + | |
- | "DISP": "1000000000001"}} | + | |
- | </code> | + | |
- | + | ||
- | ==Получить задолженность контрагента== | + | |
- | + | ||
- | GET /clients/:id/balance | + | |
- | Пример | + | |
- | <code> | + | |
- | GET http://127.0.0.1:10400/api/clients/1000000000048/balance | + | |
- | </code> | + | |
- | Ответ | + | |
- | <code> | + | |
- | {"result": 100.00} | + | |
- | </code> | + | |
- | Возвращаемое значение - ДОЛГ клиента на утро текущего дня (без учета отгрузок и платежей, проведенных текущим днем). Отрицательное значение возвращается, если есть предоплата. | + | |
- | + | ||
- | + | ||
- | ==Создать контрагента и основной адрес== | + | |
- | <code> | + | |
- | POST http://127.0.0.1:10400/api/clients | + | |
- | </code> | + | |
- | + | ||
- | тело запроса (JSON): | + | |
- | <code> | + | |
- | {"naimenovanie":"Иванов Иван Иванович", | + | |
- | "dop_sv":"один хороший человек", | + | |
- | "telefon":"78632171717 Иван Иванович, 79182323121 Елена Петровна", | + | |
- | "ulica":1000000000011, | + | |
- | "dom":"22Б стр.3", | + | |
- | "korpus":"1", | + | |
- | "kv":"1", | + | |
- | "email":"ivanov@test.tt", | + | |
- | "etoof":0, | + | |
- | "commvod":"зеленые ворота у 'А&Б'", | + | |
- | "commdisp":"звонить строго до 21-00!!!" | + | |
- | } | + | |
- | </code> | + | |
- | + | ||
- | + | ||
- | ответ | + | |
- | <code> | + | |
- | {"result": 1000000000092","adr":1000000000084} | + | |
- | </code> | + | |
- | Здесь 1000000000092 - код нового контрагента, 1000000000084 - код его основного адреса | + | |
Строка 192: | Строка 94: | ||
"DATAIZM": "23.03.2020 16:00:58" | "DATAIZM": "23.03.2020 16:00:58" | ||
} | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | |||
+ | ==Получить запись адреса по номеру телефона== | ||
+ | GET /addresses/?tel=номер | ||
+ | Пример | ||
+ | <code> | ||
+ | GET http://127.0.0.1:10400/api/addresses?tel=7123456799 | ||
+ | </code> | ||
+ | ответ | ||
+ | <code> | ||
+ | { | ||
+ | "result": { | ||
+ | "ID": "1000000000086", | ||
+ | "OSNTABL_ID": "1000000000055", | ||
+ | "NAIMENOVANIE": "12-я линия ул,1, оф.2", | ||
+ | "GOROD": "1000000000004", | ||
+ | "ULICA": "1000000000033", | ||
+ | "DOM": "1", | ||
+ | "KV": "2", | ||
+ | "ET": "0", | ||
+ | "TELEFON": "7123456799 Маша", | ||
+ | "COMMENT": "Пропуск накануне!", | ||
+ | "DOP_SV": "Если не отвечают, внутренний 2-15 ", | ||
+ | "DSZD": "23.03.2020 11:13:17", | ||
+ | "DATAIZM": "23.03.2020 16:00:58" | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | |||
+ | |||
+ | ==Получить массив адресов по коду клиента== | ||
+ | GET /addresses?kontr=1000000000125 | ||
+ | Пример | ||
+ | <code> | ||
+ | GET http://127.0.0.1:10400/api/addresses/1000000000055 | ||
+ | </code> | ||
+ | ответ | ||
+ | <code> | ||
+ | { | ||
+ | "result": [ | ||
+ | { | ||
+ | "id": "1000000000134", | ||
+ | "osntabl_id": "1000000000125", | ||
+ | "naimenovanie": "1-й Газонный пер, 2", | ||
+ | "gorod": "1000000000004", | ||
+ | "ulica": "1000000001587", | ||
+ | "dom": "2", | ||
+ | "korpus": "null", | ||
+ | "kv": "null", | ||
+ | "et": "null", | ||
+ | "pod": "null", | ||
+ | "telefon": "null", | ||
+ | "comment": "null", | ||
+ | "dop_sv": "null", | ||
+ | "shirota": "47.326330", | ||
+ | "dolgota": "39.748235", | ||
+ | "dszd": "19.04.2021 13:03:52", | ||
+ | "dataizm": "null", | ||
+ | "smena": "null", | ||
+ | "vrem": "null", | ||
+ | "vrem_okon": "null" | ||
+ | }, | ||
+ | { | ||
+ | "id": "1000000000116", | ||
+ | "osntabl_id": "1000000000125", | ||
+ | "naimenovanie": "Красных Партизан ул,17 корп.2, оф.33", | ||
+ | "gorod": "1000000000006", | ||
+ | "ulica": "1000000005283", | ||
+ | "dom": "17", | ||
+ | "korpus": "2", | ||
+ | "kv": "33", | ||
+ | "et": "0", | ||
+ | "pod": "", | ||
+ | "telefon": "22122", | ||
+ | "comment": "null", | ||
+ | "dop_sv": "null", | ||
+ | "shirota": "44.493984", | ||
+ | "dolgota": "34.137527", | ||
+ | "dszd": "26.01.2021 11:30:39", | ||
+ | "dataizm": "null", | ||
+ | "smena": "null", | ||
+ | "vrem": "0:00:00", | ||
+ | "vrem_okon": "14:30:00" | ||
+ | } | ||
+ | ], | ||
+ | "total": 2 | ||
} | } | ||
</code> | </code> | ||
Строка 301: | Строка 292: | ||
+ | ==Дополнительные примеры== | ||
+ | |||
+ | <code> | ||
+ | http://127.0.0.1:10400/api/clients?gr=2 | ||
+ | </code> | ||
+ | Вернет все группы из справочника контрагентов | ||
+ | |||
+ | <code> | ||
+ | http://127.0.0.1:10400/api/clients?roditel=1000000000030 | ||
+ | </code> | ||
+ | Все записи контрагентов, входящие в группу с кодом 1000000000030. | ||
+ | |||
+ | [[rest|REST-интерфейс для внешних систем]] | ||