Skip to main content

Docflow

Документооборот

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

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

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

exportDocflowStatusCommandEvent​

Команда получения текущего статуса документооборота

НазваниеОбязат.ТипОписание
requestIdДаuuidИД исходного запроса (в нижнем регистре)
abonentIdДаstringИД абонента
docflowIdДаuuidИД документооборота (в нижнем регистре)
Пример модели
{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
  "docflowId": "a8b53313-4603-4988-a91b-b313d262a6a9"
}

exportDocflowCommandEvent​

Команда получения всех документов в указанном документообороте

НазваниеОбязат.ТипОписание
requestIdДаuuidИД исходного запроса (в нижнем регистре)
abonentIdДаstringИД абонента
docflowIdДаuuidИД документооборота (в нижнем регистре)
Пример модели
{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
  "docflowId": "a8b53313-4603-4988-a91b-b313d262a6a9"
}

exportGisDocflowStatusCommandEvent​

Команда для получения актуальной информации о перевозке из ГИС ЭПД по УИД ГИС ЭПД

НазваниеОбязат.ТипОписание
requestIdДаuuidИД исходного запроса
uidНетuuidУИД ГИС ЭПД перевозки
Пример модели
{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "uid": "a132ad0c-0e82-47f4-8da6-2a40d1f50d2b"
}

Ответные модели​

Данный блок содержит описание основных ответных моделей от ядра системы.

docflowIdStatusUpdatedOutboundEvent​

Событие оповещения о текущем статусе

НазваниеОбязат.ТипОписание
requestIdДаuuidИД исходного запроса (в нижнем регистре)
abonentIdДаstringИД абонента
docflowIdДаuuidИД документооборота (в нижнем регистре)
statusДаStatusTypeDocflowТекущий статус документооборота
allowedActionsНетDocflowAllowedActions[array]Доступные действия с документооборотом
userErrorНетuserErrorПользовательская ошибка
Пример модели
{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
  "docflowId": "92722ee6-82d3-4926-98c4-2a207846eec3",
  "status": "Pending",
  "allowedActions": [
    "AcceptCargoDelivery",
    "AcceptCargoDeliveryIssue",
    "IOP",
    "UOU"
  ]
}

docflowTransactionStatusChangedOutboundEvent​

Событие оповещения о всех документах в указанном документообороте

НазваниеОбязат.ТипОписание
requestIdДаuuidИД исходного запроса (в нижнем регистре)
abonentIdДаstringИД абонента
docflowIdДаuuidИД документооборота (в нижнем регистре)
documentsДаDocumentInfo[array]Информация о документах указанного документооборота
userErrorНетuserErrorПользовательская ошибка
Пример модели
{
  "requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
  "abonentId": "2AEO9596552-364A-402E-AFFE-7C01F9C1B449",
  "docflowId": "a8b53313-4603-4988-a91b-b313d262a6a0",
  "documents": [
    {
      "id": "a8b53313-4603-4988-a91b-b313d262a6a6",
      "documentName": "ON_TRNACLGROT_2AE6468B9F2-A7D4-4B17-AA81-89C1DD7D29ED_2AEEAA9E60D-9C91-4E6E-889B-C2365110B24C_2AE7423D076-051C-42BE-B3E8-8737B72D74E6_0_20220420_70ea6372-596d-908d-44a8-9957e50fac6c.xml",
      "documentStorageId": "a8b53313-4603-4988-a91b-b313d262a6a6",
      "documentType": "ShipperInfo"
    },
    {
      "id": "a8b53313-4603-4988-a91b-b313d262a6a6",
      "documentName": "ON_TRNACLPPRIN_2AEEAA9E60D-9C91-4E6E-889B-C2365110B24C_2AE7423D076-051C-42BE-B3E8-8737B72D74E6_2AE6468B9F2-A7D4-4B17-AA81-89C1DD7D29ED_0_20220420_829e4148-15a9-36c5-c971-bc4b2dc10434.xml",
      "documentStorageId": "a8b53313-4603-4988-a91b-b313d262a6a6",
      "documentType": "CarrierInfoAcceptanceOfCargo"
    }
  ]
}

exportGisDocflowStatusOutboundEvent​

Ответная модель для команды ExportGisDocflowStatusCommandEvent. На основании данных входящей модели ExportGisDocflowStatusCommandEvent получать актуальную информацию о перевозке из ГИС ЭПД по УИД ГИС ЭПД

НазваниеОбязат.ТипОписание
requestIDДаuuidИД исходного запроса
uidДаuuidУИД ГИС УПД перевозки
qrStatusДаstringСтатус QR-кода
statusesДаstatusesСписок статусов по каждому запросу в на обработку данных в контексте одного УИД ГИС ЭПД
userErrorНетuserErrorПользовательская ошибка

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": []
      }
    }
  ]
}

Дополнительные модели​

Данный блок содержит описание дополнительных моделей.

StatusTypeDocflow​

Статусы документооборота

ЗначениеОписание
PendingВ обработке
AwaitingShipmentОжидает отгрузки со склада отправителя
AcceptCargoDeliveryГруз принят к перевозке
AcceptCargoDeliveryIssueГруз принят к перевозке с замечаниями
AcceptCargoConsigneeГруз принят грузополучателем
AcceptCargoConsigneeIssueГруз принят грузополучателем с замечаниями
RejectCargoConsigneeОтказано в приемке груза
ReleasedCargoCarrierГруз выдан грузополучателю
ReleasedCargoCarrierIssueГруз выдан грузополучателю с замечаниями
FinancialChangeDeliveryРасчет стоимости перевозки
ChangeDeliveryPointПереадресовка
ReplacementInfoЗамена водителя / транспортного средства
FinishedДокументооборот завершен
VehicleRequestЗапрос транспортного средства
VehicleRequestConfirmedЗапрос транспортного средства подтвержден
DeliveryVehicleПодача транспортного средства
VehicleReturnВозврат транспортного средства
TransferShipperEmptyContainerПередача порожнего контейнера грузоотправителю
ReceiptFromCarrierEmptyContainerПолучение порожнего контейнера от перевозчика
DeliveryVehicleEmptyContainerПодача транспортного средства под погрузку порожнего контейнера
TransferToCarrierEmptyContainerПередача порожнего контейнера перевозчику
ReceiptFromConsigneeEmptyContainerПолучение порожнего контейнера от грузополучателя
ReceiptFromShipperLoadedContainerПолучение груженого контейнера от грузоотправителя
TransferToCarrierLoadedContainerПередача груженого контейнера перевозчику
TransferToConsigneeLoadedContainerПередача груженого контейнера грузополучателю
ReceiptFromCarrierLoadedContainerПолучение груженого контейнера от перевозчика
UOUУведомление об уточнении
СorrectionRequiredТребуется исправление документа(ГИС)
SendOrderПередача заказ/заявки
AcceptOrderДокументооборот завершен
OwnerVehicleInfoИнформация собственника транспортного средства
BeforeMedicalCheckПройден предрейсовый медицинский осмотр
BeforeTechnicalCheckПройден технический осмотр ТС
BeforeOdometerCheckПолучена информация о показаниях одометра при выезде
AfterOdometerCheckПолучена информация о показаниях одометра при заезде
AfterMedicalCheckПройден послерейсовый медицинский осмотр
TransactionEDF_T1Информация Фрахтователя
TransactionEDF_T2Информация Фрахтовщика
ErrorОшибка по документу
UnknownТип неизвестен

DocflowAllowedActions​

Список доступных действий для данного документооборота

ЗначениеОписание
AcceptCargoDeliveryПринять груз к перевозке
AcceptCargoDeliveryIssueПринять груз к перевозке с замечаниями
AcceptCargoConsigneeПринять груз грузополучателем
AcceptCargoConsigneeIssueПринять груз грузополучателем с замечаниями
RejectCargoConsigneeОтказать в приемке груза
ReleasedCargoCarrierВыдать груз грузополучателю
ReleasedCargoCarrierIssueВыдать груз грузополучателю с замечаниями
SendFinancialChangeDeliveryОтправить изменение стоимости перевозки
FinancialChangeDeliveryПринять изменение стоимость перевозки
ChangeDeliveryPointОформить переадресовку
ReplacementInfoОформить изменения в перевозке
VehicleRequestПодтвердить запрос на транспортное средство
VehicleRequestConfirmedОформить подачу транспортного средства
VehicleReturnОформить возврат транспортного средства
TransferShipperEmptyContainerПередать порожний контейнер грузоотправителю
ReceiptFromCarrierEmptyContainerПринять порожний контейнер от перевозчика
DeliveryVehicleEmptyContainerПодать транспортное средство под погрузку порожнего контейнера
TransferToCarrierEmptyContainerПередать порожний контейнер перевозчику
ReceiptFromConsigneeEmptyContainerПринять порожний контейнер от грузополучателя
ReceiptFromShipperLoadedContainerПринять груженый контейнер от грузоотправителя
TransferToCarrierLoadedContainerПередать груженый контейнер перевозчику
TransferToConsigneeLoadedContainerПередать груженый контейнер грузополучателю
ReceiptFromCarrierLoadedContainerПринять груженый контейнер от перевозчика
SendIOPОтправить уведомление о получении
SendUOUОтправить уведомление об уточнении
SendOrderОтправить заказ/заявку
AcceptOrderПодтвердить заказ/заявку
OwnerVehicleInfoОформить информацию собственника транспортного средства
BeforeMedicalCheckОформить предрейсовый медицинский осмотр
BeforeTechnicalCheckОформить технический осмотр ТС
BeforeOdometerCheckОформить информацию о показаниях одометра при выезде
AfterOdometerCheckОформить информацию о показаниях одометра при заезде
AfterMedicalCheckОформить послерейсовый медицинский осмотр
TransactionEDF_T1Оформить информацию Фрахтователя
TransactionEDF_T2Оформить информацию Фрахтовщика
СorrectionТребуется исправление документа(ГИС)
UnknownТип неизвестен

DocumentInfo​

Информация по документу

НазваниеОбязат.ТипОписание
idДаuuidИД документа (в нижнем регистре)
documentNameДаstringНаименование файла
documentStorageIdДаuuidИД документа в ЕСХ оператора ЭПД (в нижнем регистре)
documentTypeДаDocTypeТип документа
signaturesНетSignatureInfo [array]Тип документа

SignatureInfo​

Информация о подписи

НазваниеОбязат.ТипОписание
storageIDДаuuidИД в ЕСХ оператора ЭПД (в нижнем регистре)
fileNameДаstringИмя файла подписи