Документы
Группа сообщений для работы с документами.---
Командные модели
Данный блок содержит описание основных командных моделей, отвечающих за выполнение действий.
sendDocumentCommandEvent
Команда для отправки документа.
Документ будет взят в работу только после того, как будет разрешена его зависимость, указанная в теле XML документа. Если зависимость документа не будет разрешена в течение суток, то документ будет взят в работу в любом случае.
- [Обязательно] Документ и подпись должны быть предварительно загружены в хранилище через внешний API
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Нет | uuid | ИД запроса (в нижнем регистре) |
| docflowId | Да | uuid | ИД документооборота (в нижнем регистре) |
| docflowType | Да | DocflowType | Тип докуменооборота |
| senderId | Да | string | ИД отправителя |
| senderType | Да | SenderType | Тип отправителя |
| receiversId | Да | ReceiverInfo[array] | ИД получателей |
| documentId | Да | uuid | ИД документа (в нижнем регистре) |
| documentStorageId | Да | uuid | ИД документа в ЕСХ оператора ЭПД (в нижнем регистре) |
| documentName | Да | string | Наименование файла документа |
| documentType | Да | DocType | Тип документа |
| signatures | Нет | SignatureInfo[array] | Подписи к документу |
| poa | Нет | PoaInfo[array] | Информация к МЧД |
| primaryDocumentId | Нет | uuid | ИД первичного документа в ДО |
| previousDocumentId | Нет | uuid[array] | ИД документа, в ответ на который отправляется документ / повторно отправляется документ (в нижнем регистре) |
| comment | Нет | string | Комментарий/причина отказа (для УОУ) |
| uid | Нет | string | УИД ГИС ЭПД (Roaming) |
| cardStorageId | Нет | uuid | ИД xml от хаб в ЕСХ оператора ЭПД |
Пример модели #1
{
"docflowId": "887eca11-d711-44a0-9d00-23b25e334f9c",
"docflowType": "ETRN",
"senderId": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"receiversId": [
{
"id": "2AECD6B395E-4FCB-41AA-B10B-4E634B773772",
"receiverType": "Carrier"
},
{
"id": "2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0",
"receiverType": "Consignee"
}
],
"documentId": "c0478105-cd56-49e9-bb27-5786d228697d",
"documentStorageId": "ed290100-5d01-0015-6490-08d9d6d7cd95",
"documentName": "ON_TRNACLGROT_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_0_20220526_c0478105-cd56-49e9-bb27-5786d228697d.xml",
"documentType": "ShipperInfo",
"signatures": [
{
"id": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"storageID": "ed290200-5d01-0015-6490-08d9d6d7cd95",
"fileName": "ON_TRNACLGROT_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_0_20220526_c0478105-cd56-49e9-bb27-5786d228697d.p7s"
}
]
}
Пример модели #2
{
"docflowId": "887eca11-d711-44a0-9d00-23b25e334f9c",
"docflowType": "ETRN",
"senderId": "2AECD6B395E-4FCB-41AA-B10B-4E634B773772",
"receiversId": [
{
"id": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"receiverType": "Consignor"
},
{
"id": "2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0",
"receiverType": "Consignee"
}
],
"documentId": "829e4148-15a9-36c5-c971-bc4b2dc10434",
"documentStorageId": "ed290100-5d01-0015-6490-08d9d6d7cd95",
"documentName": "ON_TRNACLPPRIN_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_0_20220620_ec6e2071-ef74-47c2-81df-d27470862b15.xml",
"documentType": "CarrierInfoAcceptanceOfCargo",
"signatures": [
{
"id": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"storageID": "ed290200-5d01-0015-6490-08d9d6d7cd95",
"fileName": "ON_TRNACLPPRIN_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_0_20220620_ec6e2071-ef74-47c2-81df-d27470862b15.p7s"
}
],
"previousDocumentId": [
"c0478105-cd56-49e9-bb27-5786d228697d"
]
}
createDocumentCommandEvent
Команда для создания документа.
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД запроса (в нижнем регистре) |
| documentType | Да | DocTypeService | Тип сервисного документа |
| senderId | Да | string | ИД отправителя |
| receiverId | Да | string | ИД получателя |
| signatory | Да | SignatoryInfo | Данные подписанта |
| primaryDocumentId | Нет | uuid | ИД документа, на который формируется ИОП/УОУ (в нижнем регистре) |
| comment | Нет | string | Комментарий/причина отказа (для УОУ). Для УОУ обязательное поле. |
Пример модели
{
"requestId": "ebd0f163-4586-4e7e-a23c-70f9c5f086e0",
"documentType": "IOP",
"senderId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"receiverId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
"signatory": {
"name": "Иван",
"surname": "Иванов",
"patronymic": "Иванович",
"post": "Директор"
},
"primaryDocumentId": "98c0be43-ca0e-48fa-b1ef-fe6d55efbfec"
}
acceptDocumentCommandEvent
Команда принятия документа, сигнализирующая что клиентская система успешно получила
сообщение documentCameOutboundEvent.
Система ЭПД формирует переотправки каждую минуту в течение 3х дней, если не получает acceptDocumentCommandEvent.
Переотправка документа также будет, если придёт acceptDocumentCommandEvent с непустым полем errorMessage - просьба
переотправить документ.
Обратите внимание, что список receiversId должен быть такой же, как и в сообщении, которое акцептуется. Если кого-то
из абонентов будет не хватить, система ЭПД будет формировать переотправку.
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Нет | uuid | ИД запроса (в нижнем регистре) |
| docflowId | Да | uuid | ИД документооборота (в нижнем регистре) |
| documentId | Да | uuid | ИД документа(в нижнем регистре) |
| receiversId | Да | ReceiverInfo[array] | ИД получателя |
| errorMessage | Нет | string | Описание ошибки, почему не принят документ. Заполняется только если не удалось принять документ |
Пример модели
{
"docflowId": "887eca11-d711-44a0-9d00-23b25e334f9c",
"documentId": "829e4148-15a9-36c5-c971-bc4b2dc10434",
"receiversId": [
{
"id": "2AECD6B395E-4FCB-41AA-B10B-4E634B773772",
"receiverType": "Carrier"
},
{
"id": "2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0",
"receiverType": "Consignee"
}
]
}
exportDocumentStatusCommandEvent
Команда для запроса текущего статуса документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| documentId | Да | uuid | ИД документа (в нижнем регистре) |
Пример модели
{
"requestId": "abf003ca-6433-4535-87b8-dcb809b3d628",
"documentId": "92722ee6-82d3-4926-98c4-2a207846eec3"
}
exportGisDocumentStatusCommandEvent
Команда для запроса текущего ГИСового статуса документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| documentId | Да | uuid | ИД документа (в нижнем регистре) |
Пример модели
{
"requestId": "abf003ca-6433-4535-87b8-dcb809b3d628",
"documentId": "92722ee6-82d3-4926-98c4-2a207846eec3"
}
listDocumentsCommandEvent
Команда получения списка титулов по перевозке
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| uid | Да | uuid | УИД ГИС ЭПД перевозки |
Пример модели
{
"requestId": "487eca11-d711-44a0-9d00-33b25e334f9c",
"uid": "887eca11-d711-44a0-9d00-23b25e334f9c"
}
listTransportationsCommandEvent
Команда получения списка перевозок участником ДО (водитель или абонент)
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД запроса |
| abonentId | Да | uuid | ИД ЭДО участника документооборота |
| uid | Нет | uuid | УИД ГИС ЭПД перевозки |
| docFlowType | Нет | DocflowType | Тип документооборота (ДО) |
| active | Нет | string | Признак активности документооборота для абонента/участника кто запрашивает список ДО. Означает, что по данному ДО требуется выполнить какие либо действия со стороны абонента, в частности сформировать ответный титул в рамках данного ДО |
| documentId | Нет | uuid | Ид документа |
| startDate | Нет | string | Дата с какой выполнять отбор документооборота. В формате RFC3339 |
| endDate | Нет | string | Дата по какую выполнять отбор документооборота. В формате RFC3339 |
| limit | Нет | integer | Запрашиваемое количество документов (максимальное значение 100) |
| from | Нет | integer | Поисковый индекс ДО (используется для отбора в запросе в поле from, т.е. с какого индекса продолжить поиск) |
Пример модели
{
"requestId": "787eca11-d911-44a0-9d00-23b25e334f7c",
"uid": "887eca11-d711-44a0-9d00-23b25e334f9c",
"docFlowType": "ETRN",
"active": "true",
"documentId": "c0478105-cd56-49e9-bb27-5786d228697d",
"startDate": "23.03.2023",
"endDate": "25.03.2023",
"participant": "2AEBE94BCAC-4F6F-4DEA-A9C7-D9EEAF0858BE",
"limit": 1,
"from": 100000
}
Ответные модели
Данный блок содержит описание основных ответных моделей от ядра системы.
documentCameOutboundEvent
Событие о приходе документа в сторону абонента. Это ответное сообщение на sendDocumentCommandEvent.
documentCameOutboundEvent отправляется оператором ЭПД в каждую клиентскую систему с набором получателей, указанных
в ReceiversID.
Данный список заполняется согласно НПА (у каждого титула логика этого списка разная).
Список получателей уникален в рамках пары receiverID и receiverType.
В одну систему отправляется одно событие documentCameOutboundEvent, которое содержит весь список получателей для
данной системы.
Клиентская система должна подтвердить получение документа с помощью
события acceptDocumentCommandEvent в
соответствии с описанием последнего.
- [Обязательно] Документ и подпись должны быть предварительно загружены в хранилище через внешний API
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Нет | uuid | ИД запроса (в нижнем регистре) |
| docflowId | Да | uuid | ИД документооборота (в нижнем регистре) |
| docflowType | Да | DocflowType | Тип докуменооборота |
| senderId | Да | string | ИД отправителя |
| senderType | Да | SenderType | Тип отправителя |
| receiversId | Да | ReceiverInfo[array] | Информация о получателях |
| documentId | Да | uuid | ИД документа (в нижнем регистре) |
| documentStorageId | Да | uuid | ИД документа в ЕСХ оператора ЭПД (в нижнем регистре) |
| documentName | Да | string | Наименование файла документа |
| documentType | Да | DocType | Тип документа |
| signatures | Нет | SignatureInfo[array] | Подписи к документу |
| poa | Нет | PoaInfo[array] | Информация к МЧД |
| primaryDocumentId | Нет | uuid | ИД первичного документа в ДО |
| previousDocumentId | Нет | uuid[array] | ИД документа, в ответ на который отправляется документ / повторно отправляется документ (в нижнем регистре) |
| comment | Нет | string | Комментарий/причина отказа (для УОУ) |
| transactionId | Да | string | Наименование транзакции |
| uid | Да | string | УИД ГИС ЭПД |
| cardStorageId | Нет | uuid | ИД xml от хаб в ЕСХ оператора ЭПД |
Пример модели
{
"docflowId": "887eca11-d711-44a0-9d00-23b25e334f9c",
"docflowType": "ETRN",
"senderId": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"receiversId": [
{
"id": "2AECD6B395E-4FCB-41AA-B10B-4E634B773772",
"receiverType": "Carrier"
},
{
"id": "2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0",
"receiverType": "Consignee"
}
],
"documentId": "c0478105-cd56-49e9-bb27-5786d228697d",
"documentStorageId": "ed290100-5d01-0015-6490-08d9d6d7cd95",
"documentName": "ON_TRNACLGROT_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_0_20220526_c0478105-cd56-49e9-bb27-5786d228697d.xml",
"documentType": "ShipperInfo",
"signatures": [
{
"id": "2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723",
"storageID": "ed290200-5d01-0015-6490-08d9d6d7cd95",
"fileName": "ON_TRNACLGROT_2AECD6B395E-4FCB-41AA-B10B-4E634B773772_2AE3DF9A700-7E0D-4B9A-A531-E1C29E1F5BC0_2AE4E671C65-3DAB-4974-9FF9-3AEAF80AD723_0_20220526_c0478105-cd56-49e9-bb27-5786d228697d.p7s"
}
]
}
documentCreatedOutboundEvent
Событие оповещения создания документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| documentStorageId | Да | uuid | ИД документа в ЕСХ оператора ЭПД (в нижнем регистре) |
| userError | Нет | userError | Пользовательская ошибка |
Пример модели
{
"requestId": "3b0fe459-b7cf-4a9c-98ae-a5850e2821da",
"documentStorageId": "92722ee6-82d3-4926-98c4-2a207846eec3"
}
documentStatusUpdatedOutboundEvent
Событие оповещения изменения статуса документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| documentId | Да | uuid | ИД документа (в нижнем регистре) |
| status | Да | StatusType | Текущий статус документа |
| nextStatus | Нет | StatusType | Ожидаемый статус документа |
| userError | Нет | userError | Пользовательская ошибка |
Пример модели
{
"requestId": "92eec270-0590-4f5c-b0dc-4dc8ff360d35",
"documentId": "92722ee6-82d3-4926-98c4-2a207846eec3",
"status": "Initialized",
"nextStatus": "Checking"
}
gisDocumentStatusOutboundEvent
Событие оповещения изменения ГИСового статуса документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestID | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| documentID | Да | uuid | ИД документа (в нижнем регистре) |
| status | Да | DocumentGISStatusType | Текущий ГИСовый статус документа |
| docflowID | Да | uuid | ИД документооборота (в нижнем регистре) |
| warnings | Нет | string[array] | Предупреждения и замечания по документу от ГИС ЭПД |
| errors | Нет | string[array] | Ошибки по документу от ГИС ЭПД |
| userError | Нет | userError | Пользовательская ошибка |
| gisStatusCode | Да | gisStatusCode | Код статуса документа (в т.ч. ошибки) выдаваемый при обработке запроса на обработку данных документа от ГИС ЭПД |
Пример модели
{
"requestId": "ebd0f163-4586-4e7e-a23c-70f9c5f086e0",
"status": "sent",
"documentID": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"docflowID": "O9596552-364A-402E-AFFE-7C01F9C1B449",
"warnings": [
"warning1",
"warning2"
],
"errors": [
"error1",
"error2"
]
}
listDocumentsOutboundEvent
Событие о списке титулов по перевозке
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestID | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| list | Да | listDocument(array) | Список документов |
| userError | Нет | userError | Пользовательская ошибка |
listDocument
Дополнительная модель списка документов
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| uid | Да | uuid | Ид документооборота (ДО) |
| storageDocumentId | Да | uuid | ИД файла xml в ЕСХ |
| signatures | Да | uuid (array) | ИД файла подписи в ЕСХ |
| documentId | Да | uuid | ИД документа у оператора |
| status | Да | StatusType | Статус документа |
| documentType | Да | string | Тип документа |
| participants | Да | string (array) | Список участников |
| abonentId | Да | string | Отправитель титула |
Пример модели
{
"requestId": "27697d3e-c40a-4669-bd8e-21c0edbffe2e",
"list": [
{
"uid": "887eca11-d711-44a0-9d00-23b25e334f9c",
"storageDocumentId": "7349f4f2-c7e5-41f2-ab07-d632461a5e5f",
"signatures": [
"7349f4f2-c7e5-41f2-ab07-d632461a5e5f"
],
"documentId": "a7841167-6cf7-4154-aed2-d9861b4b9256",
"status": "Документ принят оператором",
"documentType": "ShipperInfo",
"participants": [
"2AEBE94BCAC-4F6F-4DEA-A9C7-D9EEAF0858BE"
],
"abonentId": "2AEBE94BCAC-4F6F-4DEA-A9C7-D9EEAF0858BE"
}
]
}
listTransportationsOutboundEvent
Ответная модель для команды ListTransportationsCommandEvent. На основании данных входящей модели ListTransportationsCommandEvent необходимо подготовить список всех перевозок удовлетворяющих отбору (набор полей из команды). Данные отбираем из таблицы с документами в doc-processor
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestID | Да | uuid | ИД исходного запроса (в нижнем регистре) |
| list | Да | listTransportation (array) | Список перевозок |
| userError | Нет | userError | Пользовательская ошибка |
listTransportation
Дополнительная модель списка перевозок
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| uid | Да | uuid | УИД ГИС ЭПД перевозки |
| active | Да | boolean | Признак активности документооборота для абонента/участника кто запрашивает список ДО. Означает, что по данному ДО требуется выполнить какие либо действия со стороны абонента, в частности сформировать ответный титул в рамках данного ДО |
| docFlowType | Да | DocflowType | Тип документооборота (ДО) |
| participants | Да | Participant (array) | Список получателей ДО |
| status | Да | StatusTypeDocflow | Статус документооборота |
| num | Да | integer | Поисковый индекс ДО |
Participant
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| uid | Да | string | ИД ЭДО участника перевозки |
| role | Да | type | Роль участника перевозки |
Пример модели
{
"requestId": "27697d3e-c40a-4669-bd8e-21c0edbffe2e",
"list": [
{
"uid": "887eca11-d711-44a0-9d00-23b25e334f9c",
"active": "true",
"docFlowType": "ETRN",
"participants": [
{
"id": "2AEBE94BCAC-4F6F-4DEA-A9C7-D9EEAF0858BE",
"role": "Consignor"
}
],
"status": "В обработке",
"num": 1
}
]
}
listEmployeeTransportationsCommandEvent
Команда получения списка перевозок участником ДО - сотрудником с ролью Reader, Driver, Medic или Mechanic
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД запроса |
| abonentId | Да | uuid | ИД ЭДО участника документооборота |
| uid | Нет | uuid | УИД ГИС ЭПД перевозки |
| roles | Да | string[array] | Роли сотрудника в Операторе ЭПД |
| driverData | Нет | DriverData | Данные водителя. Обязательно для роли Driver |
| docFlowType | Нет | DocflowType | Тип документооборота (ДО) |
| documentId | Нет | uuid | Ид документа |
| startDate | Нет | string | Дата с какой выполнять отбор документооборота. |
| endDate | Нет | string | Дата по какую выполнять отбор документооборота. |
| limit | Нет | integer | Запрашиваемое количество документов (максимальное значение 100) |
| from | Нет | integer | Поисковый индекс ДО (используется для отбора в запросе в поле from, т.е. с какого индекса продолжить поиск) |
DriverData
Дополнительная модель для команды listEmployeeTransportationsCommandEvent
| Название | Тип | Описание |
|---|---|---|
| inn | string | ИНН физического лица |
| phone | string | Номер телефона физического лица |
| driverLicense | DriverLicense | Данные водительского удостоверения |
DriverLicense
Дополнительная модель для команды listEmployeeTransportationsCommandEvent
| Название | Тип | Описание |
|---|---|---|
| series | string | Серия водительского удостоверения |
| number | string | Номер водительского удостоверения |
| date | string | Дата выдачи водительского удостоверения |
exportGisDocflowStatusCommandEvent
Команда для получения актуальной информации о перевозке из ГИС ЭПД по УИД ГИС ЭПД
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestId | Да | uuid | ИД исходного запроса |
| uid | Нет | uuid | УИД ГИС ЭПД перевозки |
Пример модели
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"uid": "a132ad0c-0e82-47f4-8da6-2a40d1f50d2b"
}
exportGisDocflowStatusOutboundEvent
Ответная модель для команды ExportGisDocflowStatusCommandEvent. На основании данных входящей модели ExportGisDocflowStatusCommandEvent получать актуальную информацию о перевозке из ГИС ЭПД по УИД ГИС ЭПД
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| requestID | Да | uuid | ИД исходного запроса |
| uid | Да | uuid | УИД ГИС ЭПД перевозки |
| qrStatus | Да | string | Статус QR-кода |
| statuses | Да | statuses | Список статусов по каждому запросу в на обработку данных в контексте одного УИД ГИС ЭПД |
statuses
Дополнительная модель для команды ExportGisDocflowStatusOutboundEvent
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| documentInfo | Да | documentInfo | Информация о документе |
| lastStatusInfo | Да | lastStatusInfo | Информация по актуальному статусу запроса на обработку данных |
documentInfo
Дополнительная модель для команды ExportGisDocflowStatusOutboundEvent
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| fileName | Да | string | Имя файла |
| documentReceivedAt | Да | string | Дата / время получения запроса |
lastStatusInfo
Дополнительная модель для команды ExportGisDocflowStatusOutboundEvent
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| createdAt | Да | string | Дата / время получения запроса |
| businessStatus | Да | businessStatus | Бизнес статус документа в ГИС |
| documentStatus | Да | documentStatus | Статус документа в ГИС |
| errors | Нет | string (array) | Массив строк с текстом ошибок |
| warnings | Нет | string (array) | Массив строк с текстом предупреждений |
businessStatus
Дополнительная модель для команды ExportGisDocflowStatusOutboundEvent
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| status | Да | int | Код бизнес статуса |
| comment | Да | string | Комментарий бизнес статуса |
documentStatus
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| status | Да | int | Код обработки документа ГИС ЭПД |
| comment | Да | string | Комментарий обработки документа ГИС ЭПД |
Пример модели
{
"requestId": "abf003ca-6433-4535-87b8-dcb809b3d628",
"uid": "a132ad0c-0e82-47f4-8da6-2a40d1f50d2b",
"qrStatus": "QR-код недоступен",
"statuses": [
{
"documentInfo": {
"fileName": "ON_PTLSPOSMO_2AE9314E4D1-E60F-49ED-B703-83FFC7FA915A_2AE9314E4D1-E60F-49ED-B703-83FFC7FA915A_20240318_cdce6d19-886b-4647-a7a5-8c104c156565.xml",
"documentReceivedAt": "2024-03-18T09:44:31.507294"
},
"lastStatusInfo": {
"createdAt": "2024-03-18T09:44:36.04283",
"businessStatus": {
"status": 3,
"comment": "Файл обмена и файл ЭП успешно обработались ГИС ЭПД"
},
"documentStatus": {
"status": 4000211050,
"comment": "Агрегация пройдена успешно"
},
"errors": [],
"warnings": []
}
}
]
}
Дополнительные модели
Данный блок содержит описание дополнительных моделей.
DocflowType
Тип ДО
| Значение | Описание |
|---|---|
| ETRN | Электронная транспортная накладная |
| ESV | Электронная сопроводительная ведомость |
| EZN | Электронный заказ-наряд |
| EZZ | Электронный заказ/заявка |
| EPL | Электронный путевой лист |
| EDF | Электронный договор фрахтования |
| Informal | Электронный неформализованный документ |
| Unknown | Тип неизвестен |
| ETRAN | РЖД |
StatusType
Статусы документов
| Значение | Описание |
|---|---|
| Initialized | Документ получен оператором |
| Checking | Выполняется проверка |
| Verified | Документ принят оператором |
| SentToRecipient | Документ отправлен получателю |
| Delivered | Документ доставлен получателю |
| DeliveryError | Документ отклонен получателем |
| Error | Ошибка по документу |
| Waiting | Ожидание разрешения зависимостей (отправляется если зависимости не разрешены в течении 2 минут) |
| Unknown | Тип неизвестен. |
DocumentGISStatusType
Статусы документов при работе с ГИС
| Значение | Описание |
|---|---|
| unknown | Неизвестный статус |
| pending | Ожидает отправку в ГИС ЭПД (Начальный статус) |
| ready | Готов к отправке в ГИС ЭПД |
| sent | Документ отправлен в ГИС ЭПД |
| accepted | Документ принят ГИС ЭПД |
| error | Документ отказан ГИС ЭПД |
GISStatusCode
Код статуса документа при работе с ГИС
| Наименование поля | Обязательность | Тип поля | Описание |
|---|---|---|---|
| status | Да | string | Код обработки документа ГИС ЭПД |
| comment | Да | string | Комментарий обработки документа ГИС ЭПД |
ReceiverInfo
Информация о получателе
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| id | Да | string | Идентификатора абонента внутри системы. |
| receiverType | Да | ReceiverType | Тип получателя |
ReceiverType
Типы получателей
| Значение | Описание |
|---|---|
| Consignor | Грузоотправитель |
| Carrier | Перевозчик |
| Consignee | Грузополучатель |
| Charterer | Фрахтователь |
| Freighter | Фрахтовщик |
| VehicleOwner | Cобственник транспортного средства |
| MedicalWorker | Медицинский работник |
| TechnicalWorker | Лицо, ответственное за техническое состояние ТС |
| OdometerWorker | Лицо, ответственное за снятие показаний одометра |
| AnotherReceiver | Иной получатель |
| InformalParticipant | Участник ДО с неформализованным документом |
| Unknown | Тип неизвестен. |
SenderType
Типы отправителей
| Значение | Описание |
|---|---|
| Consignor | Грузоотправитель |
| Carrier | Перевозчик |
| Consignee | Грузополучатель |
| Charterer | Фрахтователь |
| Freighter | Фрахтовщик |
| VehicleOwner | Cобственник транспортного средства |
| MedicalWorker | Медицинский работник |
| TechnicalWorker | Лицо, ответственное за техническое состояние ТС |
| OdometerWorker | Лицо, ответственное за снятие показаний одометра |
| Unknown | Тип неизвестен. |
SignatureInfo
Инф по подписи
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| id | Да | string(uuid) | ИД подписи |
| storageID | Да | string(uuid) | ИД в ЕСХ оператора ЭПД |
| fileName | Да | string | Имя файла подписи |
PoaInfo
Инф по МЧД ( машиночитаемая доверенность)
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| id | Да | string(uuid) | ИД доверенности |
| storageID | Да | string(uuid) | ИД в ЕСХ оператора ЭПД |
| fileName | Да | string | Имя файла доверенности |
| signatures | Нет | SignatureInfo[array] | Подписи к доверенностям |
SignatoryInfo
Информация по подписанту
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| name | Да | string | Имя подписанта |
| surname | Да | string | Фамилия подписанта |
| patronymic | Нет | string | Отчество подписанта |
| post | Да | string | Должность подписанта |
DocTypeService
Типы сервисных документов
| Значение | Описание |
|---|---|
| IOP | Извещение об получении |
| UOU | Уведомление об уточнении |
DocType
Типы документов
| Значение | Описание |
|---|---|
| ShipperInfo | Информация от грузоотправителя (Т1 ЭТрН) |
| CarrierInfoAcceptanceOfCargo | Информация от перевозчика о получении груза (Т2 ЭТрН) |
| ConsigneeInfo | Информация от грузополучателя (Т3 ЭТрН) |
| CarrierInfoDeliveryOfCargo | Информация от перевозчика о выдачи груза (Т4 ЭТрН) |
| ReaddressingInfo | Информация о переадресовке (Т7 ЭТрН) |
| ReplacementInfo | Информация о замене водителя (водителей) и (или) транспортного средства (Т8 ЭТрН) |
| CarrierFinаncialConditionChange | Информация об изменение финансового состояния перевозчика (Т5 ЭТрН) |
| ShipperFinаncialConditionChangeConfirmation | Подтверждение грузоотправителя об изменении финансового состояния (Т6 ЭТрН) |
| ChartererInformation | Файл обмена информации фрахтователя (Т1 ЭЗН) |
| FreighterInformation | Файл обмена информации фрахтовщика (Т2 ЭЗН) |
| ChartererInformationDeliveryTransport | Файл обмена информации фрахтователя по факту подачи транспортного средства (Т3 ЭЗН) |
| FreighterInformationReturnTransport | Файл обмена информации фрахтовщика по факту возврата транспортного средства (Т4 ЭЗН) |
| CarrierInformation_1 | Файл обмена информации перевозчика при передачи порожнего контейнера грузоотправителю Т1-1 ON_SOPVEDPER1 (ЭСВ) |
| ShipperInformation_1 | Файл обмена информации грузоотправителя при получении порожнего контейнера от перевозчика Т2-1 ON_SOPVEDGO1 (ЭСВ) |
| ShipperInformation_2 | Файл обмена информации грузоотправителя при передаче груженого контейнера перевозчику Т2-2 ON_SOPVEDGO2 (ЭСВ) |
| CarrierInformation_2 | Файл обмена информации перевозчика при получении груженого контейнера от грузоотправителя Т1-2 ON_SOPVEDPER2 (ЭСВ) |
| CarrierInformation_3 | Файл обмена информации перевозчика при передаче груженого контейнера грузополучателю Т1-3 ON_SOPVEDPER3 (ЭСВ) |
| ConsigneeInformation_1 | Файл обмена информации грузополучателя при получении груженого контейнера от перевозчика Т3-1 ON_SOPVEDGP1 (ЭСВ) |
| ConsigneeInformation_2 | Файл обмена информации грузополучателя при подаче транспортного средства перевозчиком для погрузки порожнего контейнера Т3-2 ON_SOPVEDGP2 (ЭСВ) |
| CarrierInformation_4 | Файл обмена информации перевозчика при получении порожнего контейнера от грузополучателя Т1-4 ON_SOPVEDPER4 (ЭСВ) |
| CarrierInformation_5 | Файл обмена информации перевозчика при подаче транспортного средства для погрузки порожнего контейнера Т1-5 ON_SOPVEDPER5 (ЭСВ) |
| IOP | Извещение об получении (служебный документ) |
| UOU | Уведомление об уточнении (служебный документ) |
| OrderInfo | Информация грузоотправителя по Заказ/Заявке (Т1 ЭЗЗ) |
| AcceptOrderInfo | Информация перевозчика по Заказ/Заявке (Т2 ЭЗЗ) |
| OwnerVehicleInfo | Информация от собственника транспортного средства (Т1 ЭПЛ) |
| BeforeMedicalInfo | Информация предрейсового осмотра от медицинского работника (Т2 ЭПЛ) |
| BeforeTechnicalInfo | Информация от ответственного за техническое состояние ТС (Т3 ЭПЛ) |
| BeforeОdometerInfo | Информация от ответственного за снятие показаний одометра при выезде (Т4 ЭПЛ) |
| AfterОdometerInfo | Информация от ответственного за снятие показаний одометра при заезде (Т5 ЭПЛ) |
| AfterMedicalInfo | Информация послерейсового осмотра от медицинского работника (Т6 ЭПЛ) |
| EDF_T1 | Файл обмена информации Фрахтователя (Т1 ЭДФ) |
| EDF_T2 | Файл обмена информации Фрахтовщика (Т2 ЭДФ) |
| InformalInfo | Файл обмена неформализованным документом |
| ETRANInfo | Файл обмена РЖД документа |
| DraftDocument | Черновик документа |