Лента событий для ПЭ
Эта страница описывает, как по ленте событий отличить титулы и ошибки. Работа с лентой событий для перевозочных документов описана на странице Работа с событиями.
Отличия титулов Т1—Т3
Все титулы приходят с AttachmentType = Title, поэтому различать их нужно по другим полям:
Т1 |
Т2 |
Т3 |
|
|---|---|---|---|
|
|
|
|
Префикс |
|
|
|
Событие приходит в поле |
|
|
|
Ключевые события документооборота
С документом во время документооборота происходит множество событий — обрабатывать их все не нужно. Ниже в разделах перечислены главные события обработки ПЭ — они указаны в том порядке, в котором приходят:
отправлен титул Т1 — событие для заказчика,
получен титул Т1 — событие для экспедитора,
получены данные от ГИС ЭПД,
отправлен титул Т2 — событие для экспедитора,
получен титул Т2 от экспедитора — событие для заказчика,
отправлен титул Т3 — событие для заказчика,
получен титул Т3 — событие для экспедитора.
Кроме них на любой стадии документооборота могут произойти следующие события:
Ошибка — сущность с
AttachmentType = OuterDocflowи статусомType = Error. Код и текст ошибки находятся вStatus.Details.
Любое событие хранится в структуре BoxEvent: новое сообщение — в поле Message, дополнение к уже существующему сообщению — в поле Patch.
Для работы с событиями могут потребоваться следующие поля:
MessageId— идентификатор сообщения. У титулов Т1—Т3 он один. По нему запросите сообщение методом GetMessage (V6).EntityId— идентификатор сущности внутри сообщения. У титула это идентификатор документа. Содержимое сущности получите методом GetEntityContent (V4).ParentEntityId— идентификатор родительской сущности. У подписи это документ, который она подписывает. У титулов Т2 и Т3 — титул Т1.FromBoxId,ToBoxId— идентификаторы ящиков отправителя и получателя.DocumentNumber,DocumentDate— номер и дата документа.FileName— имя файла, ИдФайл.TypeNamedId— тип документа. Пригодится для отбора, если фильтр не был задан в самом запросе.ContentTypeId— версия и вид титула. По нему титулы различаются между собой.DocumentDirection— направление документа:Inbound— входящий,Outbound— исходящий.RecipientResponseStatus— статус ответа получателя.
Отправлен титул Т1
Это событие появляется в ленте заказчика.
Событие отправки титула приходит в поле Message со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t1_wt3_05_02.
Подпись титула — соседняя сущность Signature. Ее ParentEntityId совпадает с EntityId титула Т1.
Какие поля из ответа стоит сохранить:
Параметр |
Значение |
Для чего сохранять |
|---|---|---|
|
Идентификатор сообщения |
Связать все события одного ПЭ и указать его при отправке титулов Т2 и Т3 методом PostMessagePatch |
|
Идентификатор сущности в сообщении |
Указать его в |
|
Имя файла, ИдФайл |
Идентифицировать конкретный файл при хранении, сверке с XML и просмотре ленты событий |
|
Уникальный идентификатор поручения |
Связать титулы одного ПЭ и заполнить последующие титулы: титулы Т2 и Т3 повторяют УИД, который ГИС ЭПД присваивает после титула Т1 |
Пример события:
{
"EventId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"Message": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000000000000,
"LastPatchTimestampTicks": 638900000000000000,
"FromBoxId": "client-box-id@diadoc.ru",
"ToBoxId": "forwarder-box-id@diadoc.ru",
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"ParentEntityId": "",
"AttachmentType": "Title",
"FileName": "ON_POREXPKLT_2BM-client_2BM-forwarder_20260914_8171b4f7-7ee7-4d80-8ec8-20d93f951dfa.xml",
"Content": {
"Size": 12458
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Outbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "6c4ae8d5-8dac-41dc-b7cd-dbe0a1f5683a",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"SignerBoxId": "client-box-id@diadoc.ru"
}
],
"MessageType": "Letter"
},
"IndexKey": "CN7eBK3zqiA"
}
Получен титул Т1
Это событие появляется в ленте экспедитора.
Событие получения титула приходит в поле Message со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t1_wt3_05_02.
Какие поля из ответа стоит сохранить:
Параметр |
Значение |
Для чего сохранять |
|---|---|---|
|
Ящик организации заказчика |
Идентифицировать ящик заказчика: связывать ПЭ с контрагентом, определять отправителя входящего Т1 и при необходимости использовать его в последующих вызовах API. |
|
Идентификатор сообщения |
По параметру можно запросить сообщение методом |
|
Идентификатор сущности в сообщении |
Идентификатор конкретного титула внутри сообщения. Нужен, чтобы запросить содержимое методом |
* FromBoxId — это ящик контрагента. Получить его можно как из ленты событий, так и из титула Т1: для этого нужно распарсить титул, получить из него значение ИдФайл и получить из этого значения первый идентификатор в формате GUID. Это значение нужно передать в метод GetOrganization, чтобы получить идентификатор ящика boxId.
Пример события:
{
"EventId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"Message": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000000000000,
"LastPatchTimestampTicks": 638900000000000000,
"FromBoxId": "client-box-id@diadoc.ru",
"ToBoxId": "forwarder-box-id@diadoc.ru",
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"ParentEntityId": "",
"AttachmentType": "Title",
"FileName": "ON_POREXPKLT_2BM-client_2BM-forwarder_20260914_8171b4f7-7ee7-4d80-8ec8-20d93f951dfa.xml",
"Content": {
"Size": 12458
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Inbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "6c4ae8d5-8dac-41dc-b7cd-dbe0a1f5683a",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"SignerBoxId": "client-box-id@diadoc.ru"
}
],
"MessageType": "Letter"
},
"IndexKey": "CN7eBK3zqiA"
}
Получены данные ГИС ЭПД
Ответ ГИС ЭПД приходит в поле Patch со следующими признаками:
EntityType = Attachment;AttachmentType = OuterDocflow;DocflowNamedId = KlMt.
Связывайте статус с титулом по ParentEntityId, а с поручением — по Patch.MessageId. Сохраняйте все полученные статусы, а не только последний: один ПЭ может пройти несколько промежуточных состояний и завершиться ошибкой.
Пример события:
{
"EventId": "d2f8a1c4-6b3e-4d75-9a20-5e7c1f8b4d63",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000300000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "e3a9b2d5-7c4f-4e86-8b31-6f2d9a5c7e14",
"ParentEntityId": "{{titleEntityId}}",
"Content": {
"Size": 218
},
"AttachmentType": "OuterDocflow",
"FileName": "{{gisEpdStatusFileName}}.json",
"NeedRecipientSignature": false,
"RawCreationDate": 638900000300000000,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"OuterDocflow": {
"DocflowNamedId": "KlMt",
"DocflowFriendlyName": "ГИС ЭПД",
"Status": {
"NamedId": "4000211000",
"FriendlyName": "Принят новый перевозочный документ",
"Type": "Success",
"Details": [
{
"Code": "mt-id",
"Text": "{{mintransDocumentId}}"
},
{
"Code": "mt-rid",
"Text": "{{mintransRequestId}}"
}
]
}
},
"ContentTypeId": ""
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "d2f8a1c4-6b3e-4d75-9a20-5e7c1f8b4d63",
"MessageType": "Letter"
},
"IndexKey": "CT4kQm7zXa"
}
* Статус 4000211000 в примере — принят новый документ.
Отправлен титул Т2
Это событие появляется в ленте экспедитора.
Событие отправки титула приходит в поле Patch со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t2_wt3_05_02.
ParentEntityId титула Т2 совпадает с EntityId титула Т1. У титулов Т1—Т3 один MessageId.
Пример события:
{
"EventId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000100000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"AttachmentType": "Title",
"FileName": "ON_POREXPEXP_2BM-forwarder_2BM-client_20260922_b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52.xml",
"Content": {
"Size": 13241
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Outbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "c8f3d0b2-5a79-46e4-9b31-7d2caf8e4b63",
"ParentEntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"SignerBoxId": "forwarder-box-id@diadoc.ru"
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90",
"MessageType": "Letter"
},
"IndexKey": "DQ8fLM4xvR"
}
Получен титул Т2
Это событие появляется в ленте заказчика.
Сведения о титуле Т2 приходят в поле Patch со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t2_wt3_05_02.
ParentEntityId титула Т2 совпадает с EntityId титула Т1.
Пример события:
{
"EventId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000100000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"AttachmentType": "Title",
"FileName": "ON_POREXPEXP_2BM-forwarder_2BM-client_20260914_b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52.xml",
"Content": {
"Size": 13241
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Inbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "c8f3d0b2-5a79-46e4-9b31-7d2caf8e4b63",
"ParentEntityId": "b7e2c9a1-4f68-45d3-8a20-6c1b9e7f3d52",
"SignerBoxId": "forwarder-box-id@diadoc.ru"
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90",
"MessageType": "Letter"
},
"IndexKey": "DQ8fLM4xvR"
}
Отправлен титул Т3
Это событие появляется в ленте заказчика. Заказчик отправляет титул Т3, если отзывает поручение.
Событие отправки титула приходит в поле Patch со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t3_wt3_05_02.
ParentEntityId титула Т3 совпадает с EntityId титула Т1. У титулов Т1—Т3 один MessageId.
Пример события:
{
"EventId": "d7a4e91b-2c63-4f80-9b15-6e8c3a2f7d41",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000200000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"AttachmentType": "Title",
"FileName": "ON_POREXPOTZ_2BM-forwarder_2BM-client_20260922_e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53.xml",
"Content": {
"Size": 11876
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Outbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "f9c6a1b3-4e85-4d02-9b37-8a6e3c7d5f64",
"ParentEntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"SignerBoxId": "client-box-id@diadoc.ru"
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "d7a4e91b-2c63-4f80-9b15-6e8c3a2f7d41",
"MessageType": "Letter"
},
"IndexKey": "CR8hNP5yWs"
}
Получен титул Т3
Это событие появляется в ленте экспедитора.
Сведения о титуле Т3 приходят в поле Patch со следующими признаками:
EntityType = Attachment;AttachmentType = Title;ContentTypeId = kl_porek_t3_wt3_05_02.
ParentEntityId титула Т3 совпадает с EntityId титула Т1.
Пример события:
{
"EventId": "d7a4e91b-2c63-4f80-9b15-6e8c3a2f7d41",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000200000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"ParentEntityId": "8171b4f7-7ee7-4d80-8ec8-20d93f951dfa",
"AttachmentType": "Title",
"FileName": "ON_POREXPOTZ_2BM-client_2BM-forwarder_20260922_e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53.xml",
"Content": {
"Size": 11876
},
"DocumentInfo": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"EntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"TypeNamedId": "LogisticsForwardingOrder",
"Function": "default",
"DocumentDirection": "Inbound",
"Version": "kl_porek_wt3_05_02_01"
}
},
{
"EntityType": "Signature",
"EntityId": "f9c6a1b3-4e85-4d02-9b37-8a6e3c7d5f64",
"ParentEntityId": "e8b5f0a2-3d74-4c91-8a26-7f9d2b6e4c53",
"SignerBoxId": "client-box-id@diadoc.ru"
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "d7a4e91b-2c63-4f80-9b15-6e8c3a2f7d41",
"MessageType": "Letter"
},
"IndexKey": "CR8hNP5yWs"
}
Ошибки в ленте событий
Документ не доставлен до контрагента
Проверить статус доставки можно следующими способами:
По технологическому документу. Ориентируйтесь на
DP_PDOTPRв ленте получателя: это подтверждение оператора о дате доставки.По событию. Если документ не доставлен, в ленте появится дополнение
Patchс сущностьюEntityType = AttachmentиAttachmentType = DeliveryFailureNotification.
Пример события:
{
"EventId": "72c4e8d1-5b9a-4f36-8c20-1e7d3a9b6f45",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000200000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "8d5f2a9c-6b31-47e0-9a84-3c7e1f6b2d90",
"ParentEntityId": "c8f3d0b2-5a79-46e4-9b31-7d2caf8e4b63",
"AttachmentType": "SignatureVerificationReport",
"Content": {
"Size": 512
}
},
{
"EntityType": "Attachment",
"EntityId": "4a7e1c9d-2b56-48f0-8d31-6c9f2e5a7b43",
"ParentEntityId": "",
"AttachmentType": "DeliveryFailureNotification",
"Content": {
"Size": 264
},
"NotDeliveredEventId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90"
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "72c4e8d1-5b9a-4f36-8c20-1e7d3a9b6f45",
"NotDeliveredEventId": "a4f1c8e2-6d3b-4a71-9f25-2e8d7c4b1a90",
"MessageType": "Letter"
},
"IndexKey": "CU9rLm2xYa"
}
NotDeliveredEventId — идентификатор сообщения или дополнения, который не удалось доставить, — чтобы его получить, вызовите метод GetEvent (V3) и укажите NotDeliveredEventId в параметре eventId.
В этом же событии может быть сущность с причиной недоставки: если подпись оказалась невалидной, ее тип вложения будет иметь значение AttachmentType = SignatureVerificationReport.
Машиночитаемая доверенность не прошла проверку
Результат проверки машиночитаемой доверенности хранится в сущности со следующими признаками:
EntityType = Attachment;AttachmentType = PowerOfAttorneyStatus.
Статус проверки хранится в структуре PowerOfAttorneyInfo. При StatusNamedId = ValidationError код ошибки будет храниться в поле OperationError.
Пример события:
{
"EventId": "e1b4c7d8-2a65-4f90-8c31-6d9e5a3f7b24",
"Patch": {
"MessageId": "91c3d822-d62b-4927-95af-a4c714ef4c79",
"TimestampTicks": 638900000400000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "5c8e1a4d-7b20-46f3-9d52-2a6c8f1e4b90",
"ParentEntityId": "4d7a2c9e-6b31-48f0-8a25-1e9c5d7f3b62",
"AttachmentType": "PowerOfAttorneyStatus",
"RawCreationDate": 638900000400000000,
"PowerOfAttorneyInfo": {
"FullId": {
"RegistrationNumber": "12345678-90ab-cdef-1234-567890abcdef",
"IssuerInn": "7701234567",
"RepresentativeInn": "7707654321"
},
"Status": {
"Severity": "Error",
"StatusNamedId": "IsNotValid",
"StatusText": "МЧД не прошла проверку",
"ValidationProtocol": {
"CheckResults": [
{
"Status": "Error",
"Name": "PowerOfAttorneyIsActive",
"Error": {
"Code": "PowerOfAttorneyRevoked",
"Text": "МЧД отозвана"
}
}
]
}
},
"SendingType": "Meta"
},
"Labels": []
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"PatchId": "e1b4c7d8-2a65-4f90-8c31-6d9e5a3f7b24",
"MessageType": "Letter"
},
"IndexKey": "CV5sRn8yZb"
}
Ошибки от ГИС ЭПД
Результат проверки титула в ГИС ЭПД хранится в сущности со следующими признаками:
EntityType = Attachment;AttachmentType = OuterDocflow;DocflowNamedId = KlMt;Status.Type = Error.
Статусы обработки описаны в разделе Информация о статусе обработки.
Пример события:
{
"EventId": "a8f20b73-d7c2-43ac-b04a-968f555c4378",
"Patch": {
"MessageId": "f961c6c2-e1b6-4f2a-88f8-56dca0d75e0d",
"TimestampTicks": 639195228581087924,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "4a8a1b10-1851-4ebc-954f-8df812e2c2a9",
"ParentEntityId": "f24ae770-91ec-4f9d-80fe-ddf83a0c00f9",
"AttachmentType": "OuterDocflow",
"FileName": "f24ae770-91ec-4f9d-80fe-ddf83a0c00f9.json",
"Content": {
"Size": 194
},
"OuterDocflow": {
"DocflowNamedId": "KlMt",
"DocflowFriendlyName": "ГИС ЭПД",
"Status": {
"NamedId": "2000411000",
"FriendlyName": "XML не соответствует XSD схеме",
"Type": "Error",
"Details": [
{
"Code": "mt-id",
"Text": "34252a8c-6791-4867-bbfb-d23bf75921f1"
}
]
}
}
}
],
"PatchId": "a8f20b73-d7c2-43ac-b04a-968f555c4378",
"MessageType": "Letter"
},
"IndexKey": "CN7eBK3zqiA"
}
Ошибки из роуминга
Отправка перевозочных документов в роуминге — обмен документами между компаниями, которые пользуются услугами разных операторов электронного документооборота.
Если при отправке документа в роуминг возникла ошибка, она хранится в сущности со следующими признаками:
EntityType = Attachment;AttachmentType = RoamingNotification.
Напрямую статус роуминговой ошибки не возвращается. Чтобы узнать об ошибке, проверьте поле Content.Size: если значение равно нулю, ошибок нет, а если больше нуля — при отправке возникла ошибка. Помните, что поле Size — размер содержимого сущности в байтах, а не число ошибок.
Пример события:
{
"EventId": "19d92444-7d6e-4a07-92ab-239ce283fe9a",
"Patch": {
"MessageId": "f961c6c2-e1b6-4f2a-88f8-56dca0d75e0d",
"TimestampTicks": 639195228587000000,
"Entities": [
{
"EntityType": "Attachment",
"EntityId": "593949d7-c20a-4330-a0e8-8dcb28f8328a",
"ParentEntityId": "f24ae770-91ec-4f9d-80fe-ddf83a0c00f9",
"AttachmentType": "RoamingNotification",
"Content": {
"Size": 48
},
"NeedRecipientSignature": false,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": ""
}
],
"PatchId": "19d92444-7d6e-4a07-92ab-239ce283fe9a",
"MessageType": "Letter"
},
"IndexKey": "CN7eBTVr4Y0"
}
Чтобы узнать, какая ошибка произошла, вызовите метод GetDocument (V3). Текст ошибки будет храниться в поле RoamingNotificationStatusDescription. При ошибке доставки в роуминг статус будет иметь значение RoamingNotificationStatusError.
Пример ответа:
{
"RoamingNotificationStatus": "RoamingNotificationStatusError",
"HasCustomPrintForm": false,
"CustomData": [],
"PacketId": "834d3117-0000-4f16-9d46-5490d32e15d6",
"DocumentDirection": "Outbound",
"LastModificationTimestampTicks": 639069112128562671,
"IsEncryptedContent": false,
"SenderSignatureStatus": "SenderSignatureCheckedAndValid",
"IsRead": true,
"RoamingNotificationStatusDescription": "Документооборот c таким первым титулом уже существует"
}