Skip to main content

Документы

Группа сообщений для работы с документами.---

Командные модели​

Данный блок содержит описание основных командных моделей, отвечающих за выполнение действий.


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

НазваниеТипОписание
innstringИНН физического лица
phonestringНомер телефона физического лица
driverLicenseDriverLicenseДанные водительского удостоверения

DriverLicense​

Дополнительная модель для команды listEmployeeTransportationsCommandEvent

НазваниеТипОписание
seriesstringСерия водительского удостоверения
numberstringНомер водительского удостоверения
datestringДата выдачи водительского удостоверения

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Фрахтовщик
VehicleOwnerCобственник транспортного средства
MedicalWorkerМедицинский работник
TechnicalWorkerЛицо, ответственное за техническое состояние ТС
OdometerWorkerЛицо, ответственное за снятие показаний одометра
AnotherReceiverИной получатель
InformalParticipantУчастник ДО с неформализованным документом
UnknownТип неизвестен.

SenderType​

Типы отправителей

ЗначениеОписание
ConsignorГрузоотправитель
CarrierПеревозчик
ConsigneeГрузополучатель
ChartererФрахтователь
FreighterФрахтовщик
VehicleOwnerCобственник транспортного средства
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Черновик документа