Здесь рассматривается подробное описание порядка взаимодействия с различными типами предприятий для использования их в качестве Грузоотправителей и Грузополучателей при создании Запросов через API.
Предприятия могут быть трех типов:
- Собственные ЮрЛица
- Карточки предприятий
- ЮрЛица Контрагентов
Собственные ЮрЛица
- В UI cписок собственных ЮрЛиц можно увидеть в разделе "Юр.лица". В каждом собственном ЮрЛице есть список Сотрудников
- В API список собственных ЮрЛиц и их Сотрудников можно получить методом GET /api/v1/tender/create, который возвращает все справочники, необходимые для создания Запроса. Собственные ЮрЛица данный метод возвращает в блоке "Corporates":
- Создавать и изменять собственные ЮрЛица и их Сотрудников можно только в UI. Управление собственными ЮрЛицами через API не предусмотрено.
- Собственное ЮрЛицо и его Сотрудников можно указывать в качестве Грузоотправителя и/или Грузополучателя и его Ответственного как в UI, так и в API.
Карточки Предприятий
- К данной категории относятся предприятия, которые не являются участниками взаимодействия в Системе, но данные о них необходимо хранить и отображать. Например, в нашем случае, в качестве Грузоотправителей или Грузополучателей.
- В UI не предусмотрено специального раздела для управления данной категорией предприятий и их Контактными лицами. Их просмотр, создание и изменение возможно только в форме создания Запроса в полях "Грузоотправитель" и "Грузополучатель"
При этом следует помнить, что сохранение вновь созданной или измененной Карточки предприятия и/или его Контактного лица произойдет только при сохранении формы создания Запроса.
Создадим новую Карточку предприятия "ООО Склад1" (пока что без Контактного лица), сохраним форму создания Запроса, откроем ее заново и посмотрим на получившийся список в поле "Грузоотправитель"
Так же следует обратить внимание на то, что в UI изменить можно только предприятие, относящееся к категории "Карточка предприятия". Внести изменения в данные собственного ЮрЛица или ЮрЛица Контрагента форма, по понятным причинам, не позволяет
- В API список Карточек предприятий можно получить методом GET /api/v1/tender/create, который возвращает все справочники, необходимые для создания Запроса. Карточки предприятий данный метод возвращает в блоке "Contragents":
- Для полноценного управления Карточками предприятий и их контактными лицами (создание и изменение) в API предусмотрен набор методов раздела Contragent
Обращаем отдельное внимание на то, что в данном разделе термин "Contragent" используется в целях обратной совместимости и не имеет никакого отношения к разделу "Контрагенты" в UI. - Карточки предприятий и их контактные лица можно указывать в качестве Грузоотправителя и/или Грузополучателя и его Ответственного как в UI, так и в API. Рекомендуется использовать именно этот тип для указания в качестве Грузоотправителя или Грузополучателя и их Ответственного во всех случаях, когда Грузоотправитель или Грузополучатель не является собственным ЮрЛицом.
ЮрЛица Контрагентов (компаний-Перевозчиков)
- В UI список ЮрЛиц Контрагентов можно увидеть в разделе "Контрагенты". В качестве примера будем рассматривать партнёрства только между системными тестовыми компаниями: Грузовладельцем ТрансДемо1 и Перевозчиками ТрансДемо2, ТрансДемо3 и ТрансДемо4
- В API список ЮрЛиц Контрагентов можно получить методом GET /api/v1/tender/create, который возвращает все справочники, необходимые для создания Запроса. ЮрЛица Контрагентов данный метод возвращает в блоке "Contractors":
- Устанавливать и приостанавливать Партнёрства с Контрагентами можно только в UI. У правление Контрагентами в API не предусмотрено.
- Как видно на скриншотах, в свойствах Контрагентов нет таких сущностей как Контактное лицо. В API в модели ContractorDetailModel присутствует параметр ContactPersons лишь в целях обратной совместимости. В нынешних условиях он всегда пустой.
- ЮрЛицо Контрагента можно единожды указать в качестве Грузоотправителя и/или Грузополучателя как в UI, так и в API. При этом автоматически создается копия этого ЮрЛица типа "Карточка предприятия" и при создании последующих Запросов необходимо использовать в качестве Грузоотправителя или Грузополучателя эту копию (форма создания Запроса в UI учитывает это и не дублирует компании в списке). К этой копии, соответственно, уже можно создавать и ContactPersons
