GetEvent (V2)

Предупреждение

После окончания переходного периода эта версия метода перестанет работать и будет возвращать ошибки. Используйте новую версию метода — GetEvent (V3).

Возвращает событие по указанному идентификатору.

GET /V2/GetEvent
Query Parameters:

  • boxId – идентификатор ящика организации.

  • eventId – идентификатор события.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – в указанном ящике нет события с указанным идентификатором.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит событие с идентификатором eventId из ящика boxId, представленное структурой BoxEvent.

Для выполнения метода текущий пользователь должен иметь доступ ко всем документам в ящике, иначе метод вернет ошибку 403 (Forbidden).

Метод вернет всю доступную информацию по указанному событию, в том числе содержимое документов и подписей. В некоторых случаях получить содержимое невозможно, подробнее об этом в описании структуры Content.

Примеры использования

Пример HTTP-запроса:

GET /V2/GetEvent?boxId={{boxId}}&eventId={{eventId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела ответа:

{
    "EventId": "4c422f4e-7ecd-492d-a652-3aa45007da1b",
    "IndexKey": "CN3T_DeCTa4",
    "Patch": {
        "DeliveredEventId": "1489068b-56ce-4bc9-bf8b-62b47f450f3b",
        "DraftIsLocked": false,
        "DraftIsRecycled": false,
        "DraftIsTransformedToMessageIdList": [
        ],
        "Entities": [
            {
                "AttachmentType": "Nonformalized",
                "AuthorUserId": "b11d99c1-0674-4c32-ab2f-f6cc13d7c2a3",
                "Content": {
                    "Data": "<...>",
                    "Size": -1
                },
                "ContentTypeId": "",
                "EntityId": "08e7adf5-5e81-4529-be13-e01547efab10",
                "EntityType": "Signature",
                "IsApprovementSignature": false,
                "IsEncryptedContent": false,
                "Labels": [
                ],
                "NeedReceipt": false,
                "NeedRecipientSignature": false,
                "ParentEntityId": "ffbc3764-42de-45de-b5e8-d8648461012f",
                "PowerOfAttorneyAttachmentStatus": {
                    "Comment": "Документ подписан сертификатом другого ЮЛ/ИП, возможно, требуется МЧД",
                    "StatusName": "PowerOfAttorneyRequired"
                },
                "RawCreationDate": 638899802371782567,
                "SignerBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
                "SignerDepartmentId": "00000000-0000-0000-0000-000000000000"
            },
            {
                "AttachmentType": "InvoiceConfirmation",
                "AuthorUserId": "",
                "Content": {
                    "Data": "<...>",
                    "Size": 5618
                },
                "ContentTypeId": "send_confirmation_133_01_03",
                "EntityId": "4748dd78-2dd1-414d-a60e-be7e8656a768",
                "EntityType": "Attachment",
                "FileName": "DP_PDPOL_2BM-9147414342-757645784-202407101104400484330_2BM_20250805_4748dd78-2dd1-414d-a60e-be7e8656a768.xml",
                "IsApprovementSignature": false,
                "IsEncryptedContent": false,
                "Labels": [
                ],
                "NeedReceipt": false,
                "NeedRecipientSignature": false,
                "ParentEntityId": "752861b6-2b81-4fe1-a73b-1a8b96df5c90",
                "RawCreationDate": 638899802371782567
            },
            {
                "AttachmentType": "Nonformalized",
                "AuthorUserId": "",
                "Content": {
                    "Data": "<...>",
                    "Size": -1
                },
                "ContentTypeId": "",
                "EntityId": "3a73970f-ce25-42f0-a0c3-10774e307320",
                "EntityType": "Signature",
                "IsApprovementSignature": false,
                "IsEncryptedContent": false,
                "Labels": [
                ],
                "NeedReceipt": false,
                "NeedRecipientSignature": false,
                "ParentEntityId": "4748dd78-2dd1-414d-a60e-be7e8656a768",
                "PowerOfAttorneyAttachmentStatus": {
                    "StatusName": "PowerOfAttorneyNotRequired"
                },
                "RawCreationDate": 638899802371782567,
                "SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
                "SignerDepartmentId": "00000000-0000-0000-0000-000000000000"
            }
        ],
        "EntityPatches": [
        ],
        "ForDraft": false,
        "MessageId": "bcd62464-5b5d-44ff-93b0-ec6981b7cefe",
        "MessageIsDeleted": false,
        "MessageIsDelivered": false,
        "MessageIsRestored": false,
        "MessageType": "Letter",
        "PatchId": "4c422f4e-7ecd-492d-a652-3aa45007da1b",
        "TimestampTicks": 638899802371782567
    }
}

См. также

Методы для работы с событиями по документам:

  • GetEvent (V2) — возвращает событие по указанному идентификатору

  • GetEvent (V3) — возвращает событие по указанному идентификатору

  • GetLastEvent — возвращает последнее событие в ящике

  • GetLastEvent (V2) — возвращает последнее событие в ящике

  • GetNewEvents (V7) — возвращает ленту событий в ящике

  • GetNewEvents (V8) — возвращает ленту событий в ящике