Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Последняя версия Следующая версия справа и слева | ||
rest_s [2022/10/18 10:03] timofeev |
rest_s [2022/12/14 13:06] timofeev |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
+ | ===Работа со справочниками через REST API=== | ||
В запросах чтения можно использовать отборы:\\ | В запросах чтения можно использовать отборы:\\ | ||
offset (int) - сдвиг\\ | offset (int) - сдвиг\\ | ||
Строка 10: | Строка 11: | ||
roditel - Код группы- родителя, если задан, то возвращаются только записи, входящие в указанную группу.\\ | roditel - Код группы- родителя, если задан, то возвращаются только записи, входящие в указанную группу.\\ | ||
- | [[rest_cl|Клиенты и адреса - получение записи или списка]] | + | [[rest_cl|Работа с контрагентами - получение записи или списка, создание и правка]] |
+ | [[rest_adr|Работа с адресами]] | ||
- | ==Создать дополнительный адрес== | ||
- | |||
- | <code> | ||
- | POST http://127.0.0.1:10400/api/addresses/ | ||
- | </code> | ||
- | тело запроса (JSON): | ||
- | <code> | ||
- | {"kontragent":1000000000061, | ||
- | "telefon":"7123456789 Маша, 79181231231 Ира", | ||
- | "ulica":1000000000042, | ||
- | "dom":"55", | ||
- | "kv":"2", | ||
- | "etoof":1, | ||
- | "commvod":"ПРОПУСК!!!", | ||
- | "commdisp":"Если не отвечают, везти без звонка" | ||
- | } | ||
- | </code> | ||
- | Примечание: kontragent - ссылка на клиента, которому следует добавить адрес | ||
- | |||
- | ответ | ||
- | <code> | ||
- | {"result": 1000000000085} | ||
- | </code> | ||
- | |||
- | Здесь 1000000000085 - код нового адреса. | ||
- | |||
- | ==Изменить реквизиты клиента== | ||
- | PATCH /clients/:id | ||
- | Пример | ||
- | <code> | ||
- | http://127.0.0.1:10400/api/clients/1000000000060 | ||
- | </code> | ||
- | Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы). | ||
- | <code> | ||
- | {"naimenovanie":"Торговый дом 'Сидоров и сыновья'", "dop_sv":"Проверка API", "NEVYGRV1C":"1} | ||
- | </code> | ||
- | ответ | ||
- | <code> | ||
- | OK | ||
- | </code> | ||
- | |||
- | ==Изменить реквизиты адреса== | ||
- | PATCH /adresses/:id | ||
- | Пример | ||
- | <code> | ||
- | http://127.0.0.1:10400/api/addresses/1000000000086 | ||
- | </code> | ||
- | Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы). | ||
- | <code> | ||
- | {"telefon":"7123456799 Маша, 79181231222 Ира", | ||
- | "ulica":1000000000033,"dom":"1","kv":"2","etoof":1, | ||
- | "commdisp":"Пропуск накануне!"} | ||
- | </code> | ||
- | ответ | ||
- | <code> | ||
- | OK | ||
- | </code> | ||
- | ==Получить запись адреса по коду== | ||
- | GET /addresses/:id | ||
- | Пример | ||
- | <code> | ||
- | GET http://127.0.0.1:10400/api/addresses/1000000000086 | ||
- | </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/?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> | ||
===Вспомогательные справочники=== | ===Вспомогательные справочники=== |