GetLastEvent (V2)
Возвращает последнее событие в ящике.
- GET /V2/GetLastEvent
- Query Parameters:
boxId – идентификатор ящика организации в формате GUID.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
204 No Content – в ящике нет событий.
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:
Тело ответа содержит последнее событие в ящике, представленное структурой BoxEvent.
Метод вернет последнее событие из ленты событий. Лента формируется по подразделению организации, в котором состоит пользователь. Подразделение указано в поле UserDepartmentId структуры OrganizationUserPermissions.
Важно
К подразделению организации привязываются все события, произошедшие с 15.03.2017. События, произошедшие до этой даты, может получить только пользователь, который имеет доступ ко всем документам организации.
Если у пользователя есть доступ ко всем документам организации, в ленту попадут события по всему ящику. Доступ пользователя указан в поле AllDocuments структуры DocumentAccessLevel.
События по черновикам доступны пользователям, у которых есть доступ ко всем документам организации, так как черновики не имеют привязки к подразделению.
Метод вернет всю информацию, которую возможно получить по указанному событию, в том числе содержимое документов и подписей. В некоторых случаях получить содержимое документов невозможно, подробнее об этом в описании структуры Content.
Примеры использования
Пример HTTP-запроса:
GET /V2/GetLastEvent?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Пример тела ответа:
{
"EventId": "4c422f4e-7ecd-492d-a652-3aa45007da1b",
"Patch": {
"MessageId": "bcd62464-5b5d-44ff-93b0-ec6981b7cefe",
"TimestampTicks": 638899802371782567,
"Entities": [
{
"EntityType": "Signature",
"EntityId": "08e7adf5-5e81-4529-be13-e01547efab10",
"AuthorUserId": "b11d99c1-0674-4c32-ab2f-f6cc13d7c2a3",
"ParentEntityId": "ffbc3764-42de-45de-b5e8-d8648461012f",
"Content": {
"Size": -1,
"Data": "<...>"
},
"AttachmentType": "Nonformalized",
"NeedRecipientSignature": false,
"SignerBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"RawCreationDate": 638899802371782567,
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "",
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом другого ЮЛ/ИП, возможно, требуется МЧД"
}
},
{
"EntityType": "Attachment",
"EntityId": "4748dd78-2dd1-414d-a60e-be7e8656a768",
"AuthorUserId": "",
"ParentEntityId": "752861b6-2b81-4fe1-a73b-1a8b96df5c90",
"Content": {
"Size": 5618,
"Data": "<...>"
},
"AttachmentType": "InvoiceConfirmation",
"FileName": "DP_PDPOL_2BM-9147414342-757645784-202407101104400484330_2BM_20250805_4748dd78-2dd1-414d-a60e-be7e8656a768.xml",
"NeedRecipientSignature": false,
"RawCreationDate": 638899802371782567,
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "send_confirmation_133_01_03"
},
{
"EntityType": "Signature",
"EntityId": "3a73970f-ce25-42f0-a0c3-10774e307320",
"AuthorUserId": "",
"ParentEntityId": "4748dd78-2dd1-414d-a60e-be7e8656a768",
"Content": {
"Size": -1,
"Data": "<...>"
},
"AttachmentType": "Nonformalized",
"NeedRecipientSignature": false,
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"RawCreationDate": 638899802371782567,
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"NeedReceipt": false,
"IsApprovementSignature": false,
"IsEncryptedContent": false,
"Labels": [],
"ContentTypeId": "",
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
}
}
],
"ForDraft": false,
"DraftIsRecycled": false,
"DraftIsTransformedToMessageIdList": [],
"DraftIsLocked": false,
"MessageIsDeleted": false,
"EntityPatches": [],
"MessageIsRestored": false,
"MessageIsDelivered": false,
"DeliveredEventId": "1489068b-56ce-4bc9-bf8b-62b47f450f3b",
"PatchId": "4c422f4e-7ecd-492d-a652-3aa45007da1b",
"MessageType": "Letter"
},
"IndexKey": "CN3T_DeCTa4"
}
См. также
- Методы для работы с событиями по документам:
GetEvent (V3) — возвращает событие по указанному идентификатору
GetLastEvent (V2) — возвращает последнее событие в ящике
GetNewEvents (V8) — возвращает ленту событий в ящике