rest_s
Различия
Показаны различия между двумя версиями страницы.
| Предыдущая версия справа и слеваПредыдущая версияСледующая версия | Предыдущая версия | ||
| rest_s [2022/10/17 12:38] – timofeev | rest_s [2024/12/01 10:42] (текущий) – timofeev | ||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| + | ===Работа со справочниками через REST API=== | ||
| В запросах чтения можно использовать отборы: | В запросах чтения можно использовать отборы: | ||
| offset (int) - сдвиг\\ | offset (int) - сдвиг\\ | ||
| Строка 10: | Строка 11: | ||
| roditel - Код группы- родителя, | roditel - Код группы- родителя, | ||
| - | ===Клиенты и адреса=== | + | [[rest_cl|Работа с контрагентами - получение записи или |
| - | ==- получить список клиентов== | + | |
| - | Пример запроса (записи не более 2 клиентов, созданных | + | |
| - | < | + | |
| - | GET http:// | + | |
| - | </ | + | |
| - | Ответ: | + | [[rest_adr|Работа с адресами]] |
| - | < | + | |
| - | { | + | |
| - | " | + | |
| - | { | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | }, | + | |
| - | { | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | } | + | |
| - | ], | + | |
| - | " | + | |
| - | " | + | |
| - | } | + | |
| - | </ | + | |
| - | Поля: | + | |
| - | ID - Уникальный идентификатор (код записи)\\ | + | |
| - | NAIMENOVANIE - Имя/Наименование клиента\\ | + | |
| - | TELEFON - Номер телефона (общий по клиенту)\\ | + | |
| - | DOP_SC - Дополнительные сведения (комментарий по клиенту)\\ | + | |
| - | EMAIL - Электронная почта\\ | + | |
| - | DSZD - Дата | + | |
| - | DATAIZM - Дата последнего обновления \\ | + | |
| - | DISP - ответственный за клиента (код из справочника сотрудников)\\ | + | |
| - | Состав полей | + | |
| - | ==Получить реквизиты контрагента | + | [[rest_tov|Данные |
| - | GET / | + | |
| - | Пример | + | |
| - | < | + | |
| - | GET http:// | + | |
| - | </ | + | |
| - | Ответ | + | |
| - | < | + | |
| - | { " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | " | + | |
| - | </ | + | |
| - | ==Получить задолженность контрагента== | ||
| - | |||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | GET http:// | ||
| - | </ | ||
| - | Ответ | ||
| - | < | ||
| - | {" | ||
| - | </ | ||
| - | Возвращаемое значение - ДОЛГ клиента на утро текущего дня (без учета отгрузок и платежей, | ||
| - | |||
| - | ==Получить данные контрагента по номеру телефона== | ||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | Ответ | ||
| - | < | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | Возвращаемое значение - данные контрагента и того адреса доставки (кроме кода) , к которому относится телефон.\\ | ||
| - | |||
| - | ==Получить данные контрагента по паролю или контрольной сумме во внешнем приложении== | ||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | |||
| - | Если клиент найден, | ||
| - | |||
| - | < | ||
| - | { " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | </ | ||
| - | |||
| - | |||
| - | Если подходящего клиента нет, возвращается 404 и пустая запись. | ||
| - | < | ||
| - | { " | ||
| - | </ | ||
| - | |||
| - | |||
| - | |||
| - | ==Создать контрагента и основной адрес== | ||
| - | < | ||
| - | POST http:// | ||
| - | </ | ||
| - | |||
| - | тело запроса (JSON): | ||
| - | < | ||
| - | {" | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | |||
| - | ответ | ||
| - | < | ||
| - | {" | ||
| - | </ | ||
| - | Здесь 1000000000092 - код нового контрагента, | ||
| - | Если передан параметр psw, будет сохранен хэш от этого значения для поиска клиента при вызове метода | ||
| - | |||
| - | |||
| - | ==Создать дополнительный адрес== | ||
| - | |||
| - | < | ||
| - | POST http:// | ||
| - | </ | ||
| - | тело запроса (JSON): | ||
| - | < | ||
| - | {" | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | </ | ||
| - | Примечание: | ||
| - | |||
| - | ответ | ||
| - | < | ||
| - | {" | ||
| - | </ | ||
| - | |||
| - | Здесь 1000000000085 - код нового адреса. | ||
| - | |||
| - | ==Изменить реквизиты клиента== | ||
| - | PATCH / | ||
| - | Пример | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы). | ||
| - | < | ||
| - | {" | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | OK | ||
| - | </ | ||
| - | |||
| - | ==Изменить реквизиты адреса== | ||
| - | PATCH / | ||
| - | Пример | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы). | ||
| - | < | ||
| - | {" | ||
| - | " | ||
| - | " | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | OK | ||
| - | </ | ||
| - | ==Получить запись адреса по коду== | ||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | GET http:// | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | |||
| - | ==Получить запись адреса по номеру телефона== | ||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | GET http:// | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | |||
| - | |||
| - | ==Получить массив адресов по коду клиента== | ||
| - | GET / | ||
| - | Пример | ||
| - | < | ||
| - | GET http:// | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | { | ||
| - | " | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | }, | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | ], | ||
| - | " | ||
| - | } | ||
| - | </ | ||
| ===Вспомогательные справочники=== | ===Вспомогательные справочники=== | ||
| Строка 397: | Строка 44: | ||
| VIDDOLJN - вид должности, | VIDDOLJN - вид должности, | ||
| - | ==Список записей справочника " | ||
| - | GET / | ||
| - | Запрос: | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | ответ | ||
| - | < | ||
| - | {" | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | }], | ||
| - | " | ||
| - | </ | ||
| ==Список автомобилей== | ==Список автомобилей== | ||
| Строка 444: | Строка 76: | ||
| " | " | ||
| }</ | }</ | ||
| - | |||
| - | ==Список товаров== | ||
| - | GET /products | ||
| - | Пример - получить, | ||
| - | < | ||
| - | http:// | ||
| - | </ | ||
| - | Ответ | ||
| - | < | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| - | ], | ||
| - | " | ||
| - | } | ||
| - | </ | ||
| - | Здесь KRNAIM - наименование для ведомости или мобильного приложения, | ||
| - | EDINICA - код из справочника единиц измерения\\ | ||
| - | OKEI - код единицы по общероссийскому классификатору\\ | ||
| - | TARA - код из справочника " | ||
| - | NDS - процент НДС, если указан в справочнике. Если не задан, применяется основная ставка фирмы. Для фирм, работающих без НДС, значения не имеет (при отгрузке всегда применяется ставка " | ||
| Строка 488: | Строка 89: | ||
| </ | </ | ||
| Все записи контрагентов, | Все записи контрагентов, | ||
| + | |||
| + | |||
| + | [[rest_dnidostavki|Получение доступных для заказа дней и смен доставки]] | ||
| [[rest|REST-интерфейс для внешних систем]] | [[rest|REST-интерфейс для внешних систем]] | ||
rest_s.1666010317.txt.gz · Последнее изменение: — timofeev