Для доступа используется HTTP Basic аутентификация.
Логин и пароль для доступа Евроцемент: логин_из_пилота:пароль_из_пилота
Пример URL запроса по использованию API тестовой среды:
1. Работа со справочником транспортных средств
Для работы со справочником используется URL /vehicle с методами GET, POST, PUT, DELETE
Получение списка транспортных средств, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- number - номер транспортного средства
|
|
Общее
количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание транспортного средства, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер ТС
|
number*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует
(нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найдена запись для редактирования с указанным идентификатором
(идет сопоставление с устройством из системы мониторинга ПИЛОТ и ПТМ)
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование транспортного средства, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер ТС
|
number*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление транспортного средства, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или
обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически
при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
2. Работа со справочником прицепов
Для работы со справочником используется URL /trailer с методами GET, POST, PUT, DELETE
Получение списка транспортных средств, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД.
Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- number - номер прицепа
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание транспортного средства, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер прицепа
|
number*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует
(нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найдена запись для редактирования с указанным идентификатором (идет сопоставление с устройством из системы мониторинга ПИЛОТ и ПТМ)
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование транспортного средства, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер прицепа
|
number*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически
при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление транспортного средства, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
3. Работа со справочником водителей
Для работы со справочником используется URL /driver с методами GET, POST, PUT, DELETE
Получение списка водителей, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- name - ФИО водителя
- phone - телефон водителя
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание водителя, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
ФИО водителя
|
name*
|
Строка
|
|
Телефон водителя
|
phone
|
Строка, по умолчанию NULL
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найдена запись для редактирования
с указанным идентификатором (идет сопоставление с водителями из системы мониторинга ПИЛОТ и ПТМ)
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование водителя, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
ФИО водителя
|
name*
|
Строка
|
|
Телефон водителя
|
phone
|
Строка, по умолчанию NULL
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление водителя, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
4. Работа со справочником контрагентов
Для работы со справочником используется URL /partner с методами GET, POST, PUT, DELETE
Получение списка контрагентов, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- name - короткое название
- fullName - полное назввание
- emails - email компании
- phone - телефон
- types - признак контрагента:
1 - перевозчик
2 - покупатель
3 - заказчик
4 - получатель
5 - экспедитор
6 - грузоотправитель
- entityType - тип:
1 - физическое лицо
2 - юридическое лицо
- banc - банк
- bancBic - БИК банка
- accountNumber - номер счета
- correspondentNumber - корреспондентский счет
- inn - ИНН
- kpp - КПП
- okpo - ОКПО
- addresses - адреса, Json с массивом адресов:
1 - почтовый
2 - фактический
3 - юридический
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание контрагента, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Короткое название
|
name*
|
Строка
|
|
Полное назввание
|
fullName*
|
Строка
|
|
Еmail компании
|
emails
|
Массив электронных адресов, по умолчанию NULL
|
|
Телефон
|
phone
|
Строка, по умолчанию NULL
|
|
Признак контрагента
|
types*
|
Массив типов контрагента:
1 - перевозчик
2 - покупатель
3 - заказчик
4 - получатель
5 - экспедитор
6 - грузоотправитель
|
|
Тип
|
entityType*
|
1 - физическое лицо
2 - юридическое лицо
|
|
Банк
|
banc
|
Строка, по умолчанию NULL
|
|
БИК банка
|
bancBic
|
Строка, по умолчанию NULL
|
|
Номер счета
|
accountNumber
|
Строка, по умолчанию NULL
|
|
Корреспондентский счет
|
correspondentNumber
|
Строка, по умолчанию NULL
|
|
ИНН
|
inn
|
Строка, по умолчанию NULL
|
|
КПП
|
kpp
|
Строка, по умолчанию NULL
|
|
ОКПО
|
okpo
|
Строка, по умолчанию NULL
|
|
Адреса
|
addresses*
|
Json с массивом адресов:
1 - почтовый
2 - фактический
3 - юридический
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование контрагента, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Короткое название
|
name*
|
Строка
|
|
Полное назввание
|
fullName*
|
Строка
|
|
Еmail компании
|
emails
|
Массив электронных адресов, по умолчанию NULL
|
|
Телефон
|
phone
|
Строка, по умолчанию NULL
|
|
Признак контрагента
|
types*
|
Массив типов контрагента:
1 - перевозчик
2 - покупатель
3 - заказчик
4 - получатель
5 - экспедитор
6 - грузоотправитель
|
|
Тип
|
entityType*
|
1 - физическое лицо
2 - юридическое лицо
|
|
Банк
|
banc
|
Строка, по умолчанию NULL
|
|
БИК банка
|
bancBic
|
Строка, по умолчанию NULL
|
|
Номер счета
|
accountNumber
|
Строка, по умолчанию NULL
|
|
Корреспондентский счет
|
correspondentNumber
|
Строка, по умолчанию NULL
|
|
ИНН
|
inn
|
Строка, по умолчанию NULL
|
|
КПП
|
kpp
|
Строка, по умолчанию NULL
|
|
ОКПО
|
okpo
|
Строка, по умолчанию NULL
|
|
Адреса
|
addresses*
|
Json с массивом адресов:
1 - почтовый
2 - фактический
3 - юридический
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление контрагента, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
5. Работа со справочником договоров
Для работы со справочником используется URL /contract с методами GET, POST, PUT, DELETE
Получение списка договоров, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL
(выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON,
по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически
при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- number - Номер договора
- date - Дата договора
- startDate - Начало действия
- endDate - Окончание действия
- partnerId - Контрагент
- subject - Предмет договора
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание договора, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер договора
|
number*
|
Строка
|
|
Дата договора
|
date*
|
Дата договора
|
|
Начало действия
|
startDate*
|
Дата начала действия договора (формат Y-m-d)
|
|
Окончание действия
|
endDate*
|
Дата окончания действия договора (формат Y-m-d)
|
|
Контрагент
|
🔑[partnerId*]
|
Идентификатор из справочника контрагентов
|
|
Предмет договора
|
subject
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найдена запись в связанном справочнике по передаваемому значению параметра
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование договора, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Номер договора
|
number*
|
Строка
|
|
Дата договора
|
date*
|
Дата договора
|
|
Начало действия
|
startDate*
|
Дата начала действия договора (формат Y-m-d)
|
|
Окончание действия
|
endDate*
|
Дата окончания действия договора (формат Y-m-d)
|
|
Контрагент
|
🔑[partnerId*]
|
Идентификатор из справочника контрагентов
|
|
Предмет договора
|
subject
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись в связанном справочнике по передаваемому значению параметра.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление договора, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
6. Работа со справочником регионов
Для работы со справочником используется URL /region с методами GET, POST, PUT, DELETE
Получение списка регионов, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- region - наименование региона
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание региона, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Наименование региона
|
region*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует
(нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование региона, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Наименование региона
|
region*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление региона, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
7. Работа со справочником единиц измерения
Для работы со справочником используется URL /measure с методами GET, POST, PUT, DELETE
Получение списка единиц измерения, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- measure - единица измерения
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание единицы измерения, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Единица измерения
|
measure*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует
(нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование единицы измерения, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Единица измерения
|
measure*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление единицы измерения, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
8. Работа со справочником виды отгрузок
Для работы со справочником используется URL /shipment с методами GET, POST, PUT, DELETE
Получение списка видов отгрузок, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- shipment - вид отгрузки
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание вида отгрузки, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Вид отгрузки
|
shipment*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование вида огрузки, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Вид отгрузки
|
shipment*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление вида отгрузки, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
9. Работа со справочником номенклатур
Для работы со справочником используется URL /nomenclature с методами GET, POST, PUT, DELETE
Получение списка номенклатур, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- nomenclature - название номенклатуры
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание номенклатуры, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Название номенклатуры
|
nomenclature*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование номенклатуры, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Название номенклатуры
|
nomenclature*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление номенклатуры, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
10. Работа со справочником заводов
Для работы со справочником используется URL /factory с методами GET, POST, PUT, DELETE
Получение списка заводов, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- name - название завода
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание завода, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Название завода
|
name*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует
(нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование завода, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Название завода
|
name*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление номенклатуры, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при
использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
11. Работа со справочником перевалок
Для работы со справочником используется URL /transshipment с методами GET, POST, PUT, DELETE
Получение списка перевалок, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
|
Описание
|
|
Успех
|
|
Запрос был успешно выполнен
|
|
Не авторизован
|
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС)
- name - название перевалки
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание перевалки, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Название перевалки
|
name*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование перевалки, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Название перевалки
|
name*
|
Строка
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление перевалки, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
12. Работа с заказами
Для работы используется URL /order с методами GET, POST, PUT, DELETE
Получение заказов, метод GET:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Страница
|
page
|
Номер страницы, по умолчанию 1
|
|
Начальная позиция
|
start
|
Начальная позиция для выборки, по умолчанию 0
|
|
Количество строк
|
limit
|
Количество строк для выборки, по умолчанию NULL (выбрать все записи)
|
|
Фильтр
|
filter
|
Конфигурация для фильтрации выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "operator": "=", "value": "1"}, ...],
где:
- property - название колонки (параметра) по которому выполняется фильтрация
- operator - оператор для фильтра (=, in, not_in, bt_date, null, not_null, ilike, like, >, <)
- value - значение для фильтра
|
|
Сортировка
|
sort
|
Конфигруация для сортировки выборки в формате JSON, по умолчанию NULL.
Пример конфигурации: [{"property": "id", "direction": "asc"}, ...],
где:
- property - название колонки (параметра) по которому выполняется сортировка
- direction - направление сортировки (asc, desc)
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
|
|
Параметры ответа
|
|
Название
|
Параметр
|
Описание
|
|
Данные выборки
|
items
|
Массив с данными выборки со следующими колонками:
- id - внутренний идентификатор записи
- is_deleted - флаг, обозначающий удаление записи (значение TRUE, если удалена, при выборке отсеивается)
- externalId - внешний идентификатор (id в системе ПАРУС) заказа
- status - Статус
- statusImp - Статус исполнения
- carrierId - грузоперевозчик
- trailerId - список прицепов
- driverId - список водителей
- clientId - Заказчик
- documentId - Договор
- PlantID - Завод
- recipientId - Грузополучатель
- shipperId - Грузоотправитель
- shipmentId - Вид отгрузки
- deliveryRegionId - Регион поставки
- deliveryAddress - Адрес поставки
- unloadRegionId - Регион погрузки
- unloadAddress - Адрес погрузки
- nomenclatureId - Номенклатура
- quantity - Объем заказа, т
- measureId - Единица измерения
- perioddataFrom - Дата доставки от
- perioddataTo - Дата доставки до
- periodtimeFrom - Время доставки от
- periodtimeTo - Время доставки до
- Contactname - Контактное лицо
- Contactphone - Номер телефона
- routeName - Название маршрута
- routeDistance - Километраж
|
|
Общее количество строк
|
total
|
Общее количество записей
|
|
Страница
|
page
|
Номер страницы, переданный клиентом
|
|
Сообщение
|
msg
|
Текст сообщения результата выполнения запроса
| |
Создание заказа, метод POST:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Статус
|
status
|
Строка
|
|
Статус исполнения
|
statusImp
|
Строка
|
|
Грузоперевозчик
|
[carrierId*]
|
Массив идентификаторов назначенных машин
|
|
Прицеп
|
[trailerId]
|
Массив идентификаторов назначенных прицепов или NULL
|
|
Водитель
|
[driverId*]
|
Массив идентификаторов назначенных водителей
|
|
Заказчик
|
[clientId*]
|
externalId контрагента из справочника “Контрагенты”. Основной контрагент, который управляет заказом.
|
|
Договор
|
[documentId*]
|
Идентификатор договора
|
|
Завод
|
[PlantID*]
|
Идентификатор завода
|
|
Грузополучатель
|
[recipientId*]
|
externalId контрагента из справочника “Контрагенты”.
|
|
Грузоотправитель
|
[shipperId*]
|
externalId контрагента из справочника “Контрагенты”.
|
|
Вид отгрузки
|
[shipmentId*]
|
externalId вида отгрузки из справочника “Виды отгрузок”.
|
|
Регион поставки
|
[deliveryRegionId]
|
externalId региона из справочника “Регионы”.
|
|
Адрес поставки
|
deliveryAddress
|
Строка с адресом доставки
|
|
Регион погрузки
|
[unloadRegionId*]
|
externalId региона из справочника “Регионы”.
|
|
Адрес погрузки
|
unloadAddress*
|
Строка
|
|
Номенклатура
|
[nomenclatureId*]
|
externalId продукции из справочника “Номенклатура”.
|
|
Объем заказа, т
|
quantity*
|
Число
|
|
Единица измерения
|
[measureId*]
|
externalId единицы измерения из справочника “Единицы измерений”.
|
|
Дата доставки от
|
perioddataFrom
|
Дата, ограничивающая начало периода доставки (формат Y-m-d)
|
|
Дата доставки до
|
perioddataTo
|
Дата, ограничивающая конец периода доставки (формат Y-m-d)
|
|
Время доставки от
|
periodtimeFrom
|
Время, ограничивающая начало периода доставки (формат H:i:s)
|
|
Время доставки до
|
periodtimeTo
|
Время, ограничивающая конец периода доставки (формат H:i:s)
|
|
Контактное лицо
|
Contactname
|
ФИО контактного лица по заявке
|
|
Номер телефона
|
Contactphone
|
Телефон контактного лица по заявке
|
|
Название маршрута
|
routeName
|
Строка
|
|
Километраж, км
|
routeDistance
|
Число типа float
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
Запись с указанным идентификатором уже существует (нарушение уникального ключа справочника)
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найдена запись в связанном справочнике по передаваемому значению параметра
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Редактирование заказа, метод PUT:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Статус
|
status
|
Строка
|
|
Статус исполнения
|
statusImp
|
Строка
|
|
Грузоперевозчик
|
[carrierId*]
|
Массив идентификаторов назначенных машин
|
|
Прицеп
|
[trailerId]
|
Массив идентификаторов назначенных прицепов или NULL
|
|
Водитель
|
[driverId*]
|
Массив идентификаторов назначенных водителей
|
|
Заказчик
|
[clientId*]
|
externalId контрагента из справочника “Контрагенты”. Основной контрагент, который управляет заказом.
|
|
Договор
|
[documentId*]
|
Идентификатор договора
|
|
Завод
|
[PlantID*]
|
Идентификатор завода
|
|
Грузополучатель
|
[recipientId*]
|
externalId контрагента из справочника “Контрагенты”.
|
|
Грузоотправитель
|
[shipperId*]
|
externalId контрагента из справочника “Контрагенты”.
|
|
Вид отгрузки
|
[shipmentId*]
|
externalId вида отгрузки из справочника “Виды отгрузок”.
|
|
Регион поставки
|
[deliveryRegionId]
|
externalId региона из справочника “Регионы”.
|
|
Адрес поставки
|
deliveryAddress
|
Строка с адресом доставки
|
|
Регион погрузки
|
[unloadRegionId*]
|
externalId региона из справочника “Регионы”.
|
|
Адрес погрузки
|
unloadAddress*
|
Строка
|
|
Номенклатура
|
[nomenclatureId*]
|
externalId продукции из справочника “Номенклатура”.
|
|
Объем заказа, т
|
quantity*
|
Число
|
|
Единица измерения
|
[measureId*]
|
externalId единицы измерения из справочника “Единицы измерений”.
|
|
Дата доставки от
|
perioddataFrom
|
Дата, ограничивающая начало периода доставки (формат Y-m-d)
|
|
Дата доставки до
|
perioddataTo
|
Дата, ограничивающая конец периода доставки (формат Y-m-d)
|
|
Время доставки от
|
periodtimeFrom
|
Время, ограничивающая начало периода доставки (формат H:i:s)
|
|
Время доставки до
|
periodtimeTo
|
Время, ограничивающая конец периода доставки (формат H:i:s)
|
|
Контактное лицо
|
Contactname
|
ФИО контактного лица по заявке
|
|
Номер телефона
|
Contactphone
|
Телефон контактного лица по заявке
|
|
Название маршрута
|
routeName
|
Строка
|
|
Километраж, км
|
routeDistance
|
Число типа float
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе.
Обязательный параметр с пустым значением.
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись в связанном справочнике по передаваемому значению параметра.
Не найдена запись для редактирования
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
Удаление заказа, метод DELETE:
|
Параметры запроса
|
|
Название
|
Параметр
|
Значение и описание
|
|
Внешний идентификатор
|
externalId*
|
id заказа в системе ПАРУС
|
|
Коды состояний
|
|
Название
|
Код
|
Описание
|
|
Успех
|
200
|
Запрос был успешно выполнен
|
|
Плохой запрос
|
400
|
Отсутствие обязательных параметров в запросе или обязательный параметр с пустым значением
|
|
Не авторизован
|
401
|
Отсутствие валидной автотризации пользователя
|
|
Не найден
|
404
|
Не найден справочник в БД. Создается автоматически при использовании метода POST.
Не найдена запись для удаления.
|
|
Ошибка сервера
|
500
|
Неизвестная ошибка на стороне сервера
| |
field* - маркировка обязательного поля
🔑[field] - маркировка поля, значение которого связанно с другим справочником
Y-m-d - формат даты, пример: 2022-05-23
H:i:s - формат времени, пример: 22:33:58
Удаление записи (DELETE) - под удалением подразумевается не физическое удаление записи из справочника, а редактирование записи с простановкой признака "удалена"
Создание записи (POST) - под созданием подразумевается: проверка на существование справочника в БД, если его нет, то он создается; обновление записи в справочнике, если её не существует, то она добавляется в справочник, иначе происходит редактирование со сбросом признака "удалена"
Редактирование записи (PUT) - под редактированием подразумевается обновление записи в справочнике со сбросом признака "удалена"
