Различия

Здесь показаны различия между двумя версиями данной страницы.

--- rest_s [2020/03/23 16:42]
timofeev
+++ rest_s [2022/10/17 15:38]
timofeev
@@ Строка 4: / Строка 4: @@
 (Примечание: записи выбираются в порядке внутреннего кода)\\
 created_gte - Только созданные >= этой даты\\
-created_lte - Только созданные <= этой даты\\
+created_lte - Только созданные < = этой даты\\
 updated_gte - Только измененные >= этой даты\\
-updated_lte - Только измененные <= этой даты\\
+updated_lte - Только измененные < = этой даты\\
+gr - Признак группы. 0 - только записи без групп, 1- группы и записи, 2- только группы. Другие значения недопустимы. По умолчанию - 0.\\
+roditel - Код группы- родителя, если задан, то возвращаются только записи, входящие в указанную группу.\\
 ===Клиенты и адреса===
@@ Строка 80: / Строка 81: @@
 </code>
 Возвращаемое значение - ДОЛГ клиента на утро текущего дня (без учета отгрузок и платежей, проведенных текущим днем). Отрицательное значение возвращается, если есть предоплата.
+==Получить данные контрагента по номеру телефона==
+GET /clients?tel=номер
+Пример
+<code>
+http://127.0.0.1:10400/api/clients?tel=71112794311
+</code>
+Ответ
+<code>
+    "result": {
+        "id": "1000000000001",
+        "naimenovanie": "Буняковский Виктор Яковлевич ИП",
+        "vidpom": "1000000000001",
+        "pod": "55",
+        "kodpod": "111",
+        "et": "0",
+        "telefon": "71112794311",
+        "dsvpln": "Не привезли 11.03.2022 0x*Вода 19 литров",
+        "fam": "Буняковский",
+        "imja": "Виктор",
+        "otchestvo": "Яковлевич",
+        "chast": "5",
+        "posldst": "23.01.2022",
+        "pslknt": "07.11.2021",
+        "katdst": "1000000000001",
+        "klvof": "0",
+        "ochered": "1",
+        "shirota": "47.236136",
+        "dolgota": "39.833379",
+        "poslnakl": "11.02.2022",
+        "pervnakl": "30.05.2019",
+        "adrsvodnakl": "0",
+        "autor": "1000000000001",
+        "dszd": "24.03.2019 9:39:30",
+        "redakt": "1000000000002",
+        "dataizm": "08.09.2021 9:57:31",
+        "eto_gruppa": "0",
+        "vidkontr": "1000000000001",
+        "disp": "1000000000010",
+        "tipcen": "1000000000001",
+        "rekkam": "1000000000004",
+        "frmras": "1000000000001",
+        "firma": "1000000000001",
+        "polnoenaimenovanie": "Буняковский Виктор Яковлевич ИП",
+        "adresur": "Краеведческая ул,51, кв.150",
+        "adresfakt": "Краеведческая ул,51, кв.150",
+        "nomer_karty": "1",
+        "idu4sed": "1000000000001",
+        "datapech": "24.03.2019",
+        "osnt12": "основной договор",
+        "pchtkubut": "0",
+        "katptrb": "1000000000001",
+        "segmentptr": "1000000000001",
+        "statuskl": "1000000000004",
+        "pchtupdbezprosl": "0"
+    }
+}
+</code>
+Возвращаемое значение - данные контрагента и того адреса доставки (кроме кода) , к которому относится телефон.\\
+==Получить данные контрагента по паролю или контрольной сумме во внешнем приложении==
+GET /clients?psw=пароль
+Пример
+<code>
+http://127.0.0.1:10400/api/clients?psw=VGhlIHF1aWNrIGJyb3duI
+</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>
+Если подходящего клиента нет, возвращается 404 и пустая запись.
+<code>
+{    "result": {}}
+</code>
@@ Строка 99: / Строка 184: @@
 "etoof":0,
 "commvod":"зеленые ворота у 'А&Б'",
-"commdisp":"звонить строго до 21-00!!!"
+"commdisp":"звонить строго до 21-00!!!",
+"psw": "VGhlIHF1aWNrIGJyb3duI"
 }
 </code>
@@ Строка 106: / Строка 192: @@
 ответ
 <code>
-{"result": 1000000000092","adr":1000000000084}
+{"result": 1000000000092,"adr": 1000000000084}
 </code>
-Здесь 1000000000092 - код нового контрагента, 1000000000084 - код его основного адреса
+Здесь 1000000000092 - код нового контрагента, 1000000000084 - код его основного адреса \\
+Если передан параметр psw, будет сохранен хэш от этого значения для поиска клиента при вызове метода  /api/clients?psw\\
@@ Строка 195: / Строка 282: @@
 </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>
+===Вспомогательные справочники===
+==Получить список сотрудников==
 GET /employees \\
 Пример: список сотрудников, отредактированных после 8 утра 23.03.2020:
@@ Строка 267: / Строка 445: @@
 }</code>
+==Список товаров==
+GET /products
+Пример - получить, из числа созданных с начала года, один товар, пропустив первые 3.
+<code>
+http://127.0.0.1:10400/api/products?created_gte="01.01.2020"&limit=1&offset=3
+</code>
+Ответ
+<code>
+{
+    "result": [{
+            "ID": "1000000000004",
+            "NAIMENOVANIE": "Вода Алга",
+            "KRNAIM": "АЛ19",
+            "VES": "19",
+            "EDINICA": "1000000000001",
+            "TARA": "1000000000001",
+            "OKEI": "796",
+            "DSZD": "26.01.2020 16:02:24",
+            "NDS": "20",
+            "DATAIZM": "12.03.2020 18:46:00"
+        }
+    ],
+    "offset": 3,    "limit": 1,    "total": 1
+}
+</code>
+Здесь KRNAIM - наименование для ведомости или мобильного приложения,\\
+EDINICA - код из справочника единиц измерения\\
+OKEI - код единицы по общероссийскому классификатору\\
+TARA - код из справочника "оборотная тара", для товаров в одноразовой упаковке отсутствует.\\
+NDS - процент НДС, если указан в справочнике. Если не задан, применяется основная ставка фирмы. Для фирм, работающих без НДС, значения не имеет (при отгрузке всегда применяется ставка "Без НДС").\\
+==Дополнительные примеры==
+<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-интерфейс для внешних систем]]

Водяной

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы