на главную страницу программы "Водяной"

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

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


rest_s

Это старая версия документа!


В запросах чтения можно использовать отборы:
offset (int) - сдвиг
limit (int)- кол-во извлекаемых записей
(Примечание: записи выбираются в порядке внутреннего кода)
created_gte - Только созданные >= этой даты
created_lte - Только созданные < = этой даты
updated_gte - Только измененные >= этой даты
updated_lte - Только измененные < = этой даты
gr - Признак группы. 0 - только записи без групп, 1- группы и записи, 2- только группы. Другие значения недопустимы. По умолчанию - 0.
roditel - Код группы- родителя, если задан, то возвращаются только записи, входящие в указанную группу.

Клиенты и адреса - получение записи или списка

Создать дополнительный адрес
POST http://127.0.0.1:10400/api/addresses/

тело запроса (JSON):

{"kontragent":1000000000061,
"telefon":"7123456789 Маша, 79181231231 Ира",
"ulica":1000000000042,
"dom":"55",
"kv":"2",
"etoof":1,
"commvod":"ПРОПУСК!!!",
"commdisp":"Если не отвечают, везти без звонка"
}

Примечание: kontragent - ссылка на клиента, которому следует добавить адрес

ответ

{"result": 1000000000085}

Здесь 1000000000085 - код нового адреса.

Изменить реквизиты клиента

PATCH /clients/:id Пример

http://127.0.0.1:10400/api/clients/1000000000060

Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы).

{"naimenovanie":"Торговый дом 'Сидоров и сыновья'", "dop_sv":"Проверка API", "NEVYGRV1C":"1}

ответ

OK
Изменить реквизиты адреса

PATCH /adresses/:id Пример

http://127.0.0.1:10400/api/addresses/1000000000086

Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы).

{"telefon":"7123456799 Маша, 79181231222 Ира",
"ulica":1000000000033,"dom":"1","kv":"2","etoof":1,
"commdisp":"Пропуск накануне!"}

ответ

OK
Получить запись адреса по коду

GET /addresses/:id Пример

GET http://127.0.0.1:10400/api/addresses/1000000000086

ответ

{
    "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"
    }
}
Получить запись адреса по номеру телефона

GET /addresses/?tel=номер Пример

GET http://127.0.0.1:10400/api/addresses?tel=7123456799

ответ

{
    "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"
    }
}
Получить массив адресов по коду клиента

GET /addresses?kontr=1000000000125 Пример

GET http://127.0.0.1:10400/api/addresses/1000000000055

ответ

{
    "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
}

Вспомогательные справочники

Получить список сотрудников

GET /employees
Пример: список сотрудников, отредактированных после 8 утра 23.03.2020:

GET http://127.0.0.1:10400/api/employees?updated_gte="23.03.2020 08:00:00"

ответ

{
    "result": [{
            "ID": "1000000000005",
            "NAIMENOVANIE": "Зарулин",
            "IMJA": "Водитель",
            "DOLJNOST": "1000000000005",
            "VIDDOLJN": "0",
            "DSZD": "24.03.2019 8:59:35",
            "DATAIZM": "23.03.2020 16:04:06"}
    ],
    "total": 1
}

DOLJNOST- код в справочнике должностей
VIDDOLJN - вид должности, если заполнен в справочнике должностей (перечисление: 0 -водитель, 1-экспедитор, 2- диспетчер, 3- помощник экспедитора, 4 -персональный менеджер, 5- Мастер по ремонту)

Список записей справочника "оборотная тара"

GET /packings Запрос:

http://127.0.0.1:10400/api/packings

ответ

{"result": [{  "ID": "1000000000001",
            "NAIMENOVANIE": "Бутыль 19л",
            "DSZD": "23.03.2019 21:39:13",
            "DATAIZM": "25.01.2020 7:19:54"
        }],
    "total": 1}
Список автомобилей

GET /cars

Список смен

GET /shift-types

http://127.0.0.1:10400/api/shift-types

ответ

{
    "result": [
        {
            "ID": "1000000000002",
            "NAIMENOVANIE": "08-13",
            "VREM_NACH": "8.0",
            "VREM_OKON": "13.0",
            "DSZD": "23.09.2019 13:03:45",
            "DATAIZM": "03.03.2020 8:10:50"
        },
        {
            "ID": "1000000000003",
            "NAIMENOVANIE": "14-20",
            "VREM_NACH": "14.0",
            "VREM_OKON": "20.0",
            "DSZD": "23.09.2019 13:03:47",
            "DATAIZM": "03.03.2020 8:10:54"
        }
    ],
    "total": 2
}
Список товаров

GET /products Пример - получить, из числа созданных с начала года, один товар, пропустив первые 3.

http://127.0.0.1:10400/api/products?created_gte="01.01.2020"&limit=1&offset=3

Ответ

{
    "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
}

Здесь KRNAIM - наименование для ведомости или мобильного приложения,
EDINICA - код из справочника единиц измерения
OKEI - код единицы по общероссийскому классификатору
TARA - код из справочника «оборотная тара», для товаров в одноразовой упаковке отсутствует.
NDS - процент НДС, если указан в справочнике. Если не задан, применяется основная ставка фирмы. Для фирм, работающих без НДС, значения не имеет (при отгрузке всегда применяется ставка «Без НДС»).

Дополнительные примеры
http://127.0.0.1:10400/api/clients?gr=2

Вернет все группы из справочника контрагентов

http://127.0.0.1:10400/api/clients?roditel=1000000000030

Все записи контрагентов, входящие в группу с кодом 1000000000030.

REST-интерфейс для внешних систем

rest_s.1666076620.txt.gz · Последние изменения: 2022/10/18 10:03 — timofeev