GetDocflows (V4)
Возвращает список документов с информацией о документообороте по их идентификаторам.
Для каждого документа возвращаются данные, которые характеризуют его текущее состояние: информация о документообороте и метаданные.
- POST /V4/GetDocflows
- Query Parameters:
boxId – идентификатор ящика организации в формате GUID.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать список запросов на получение документов с информацией о документообороте, представленный структурой GetDocflowBatchRequest.
- 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:
Тело ответа содержит список документов с информацией о документообороте, представленный структурой GetDocflowBatchResponseV4.
Для выполнения метода текущий пользователь должен иметь доступ ко всем документам в ящике, иначе метод вернет ошибку 403 (Forbidden).
Метод вернет всю доступную информацию по указанным документам, в том числе содержимое документов и подписей, если это было указано в запросе.
Обратите внимание, что суммарный размер содержимого всех сущностей, хранящихся в поле Entity.Content.Data, не может превышать 1 048 576 байт — ограничение относится только к Entity с EntityType.Attachment.
Если при добавлении содержимого очередного документа этот размер будет превышен, то такое содержимое не будет добавлено в ответ. Если для каких-то документов содержимое не было получено в ответе метода, его можно получить с помощью метода GetEntityContent (V4).
Примеры использования
Пример HTTP-запроса:
POST /V4/GetDocflows?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
Пример тела запроса:
{
"Requests": [
{
"DocumentId": {
"MessageId": "ba04162c-e26f-448f-a370-299b4f15b6d1",
"EntityId": "da7cd73e-ff49-4a23-a018-42d27487e536"
}
}
]
}
Пример тела ответа:
{
"Documents": [
{
"DocumentId": {
"MessageId": "ba04162c-e26f-448f-a370-299b4f15b6d1",
"EntityId": "da7cd73e-ff49-4a23-a018-42d27487e536"
},
"LastEvent": {
"EventId": "10e0aa00-79f0-11f0-8000-00023a35cd5b",
"Timestamp": {
"Ticks": 638908700430756352
}
},
"DocumentInfo": {
"FullVersion": {
"TypeNamedId": "UniversalTransferDocument",
"Function": "СЧФДОП",
"Version": "utd820_05_01_02_hyphen"
},
"MessageType": "Letter",
"WorkflowId": 18,
"Participants": {
"Sender": {
"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"IsRoaming": false
},
"Recipient": {
"BoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"IsRoaming": false
},
"IsInternal": false,
"IsCrossBorder": false
},
"DocumentDirection": "Outbound",
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"Metadata": [
{
"Key": "FileName",
"Value": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d.xml"
},
{
"Key": "DocumentNumber",
"Value": "123123"
},
{
"Key": "DocumentDate",
"Value": "2025-02-07T00:00:00.0000000Z"
},
{
"Key": "TotalSum",
"Value": "1.00"
},
{
"Key": "TotalVat",
"Value": "1.00"
},
{
"Key": "CurrencyCode",
"Value": "643"
},
{
"Key": "Grounds",
"Value": "Без документа-основания"
},
{
"Key": "TotalVat10",
"Value": "0"
},
{
"Key": "TotalVat18",
"Value": "0"
},
{
"Key": "TotalVat20",
"Value": "0"
},
{
"Key": "SellerInn",
"Value": "6125600340"
}
],
"CustomData": [],
"DocumentLinks": {
"InitialIds": [],
"SubordinateIds": []
},
"PacketInfo": {
"LockMode": "None"
},
"IsRead": true,
"IsDeleted": false,
"IsInvitation": false,
"LetterInfo": {
"IsEncrypted": false,
"ForwardDocumentEvents": [
{
"Timestamp": {
"Ticks": 638806439880369912
},
"ToBoxId": "efc0c4deaa81428998732035ce4c2bac@diadoc.ru"
},
{
"Timestamp": {
"Ticks": 638806440596039464
},
"ToBoxId": "efc0c4deaa81428998732035ce4c2bac@diadoc.ru"
},
{
"Timestamp": {
"Ticks": 638908700430343004
},
"ToBoxId": "efc0c4deaa81428998732035ce4c2bac@diadoc.ru"
}
],
"IsTest": false
},
"EditingSettingId": "",
"HasUnreadOutOfWorkflowUniversalMessages": false
},
"Docflow": {
"SenderTitle": {
"IsFinished": true,
"Attachment": {
"Attachment": {
"Entity": {
"EntityId": "da7cd73e-ff49-4a23-a018-42d27487e536",
"CreationTimestamp": {
"Ticks": 638745087768452096
},
"Content": {
"Size": 2512
}
},
"AttachmentFilename": "ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-6125600340-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d.xml",
"DisplayFilename": "УПД №123123 от 07.02.25"
},
"Signature": {
"Cms": {
"EntityId": "9d798f4f-d61f-4aec-acac-69475d14dbab",
"CreationTimestamp": {
"Ticks": 638745087768452096
},
"Content": {
"Size": 3378
}
},
"CadesT": {
"EntityId": "278a5359-5ab3-4de1-9656-bc89b0bcd6f0",
"CreationTimestamp": {
"Ticks": 638745087772041933
},
"Content": {
"Size": 7011
}
},
"SignerBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638745087772041933
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом другого ЮЛ/ИП, возможно, требуется МЧД"
}
},
"ContentTypeId": "utd820_schfdop_orig_t1_05_01_02_hyphen"
},
"SentAt": {
"Ticks": 638745087768452096
},
"DeliveredAt": {
"Ticks": 638745087772041933
},
"SenderSignatureStatus": "SenderSignatureCheckedAndValid"
},
"Confirmation": {
"IsFinished": true,
"ConfirmationAttachment": {
"Attachment": {
"Entity": {
"EntityId": "f0183cf1-fcb8-4617-9fcd-6b717207f4ee",
"CreationTimestamp": {
"Ticks": 638745087772041933
},
"Content": {
"Size": 5534
}
},
"AttachmentFilename": "DP_PDPOL_2BM-6125600340-732644841-202407101103418496883_2BM_20250207_f0183cf1-fcb8-4617-9fcd-6b717207f4ee.xml",
"DisplayFilename": "Подтверждение даты получения"
},
"Signature": {
"Cms": {
"EntityId": "493b4408-ae65-442d-ac5f-b4c32bdfe063",
"CreationTimestamp": {
"Ticks": 638745087772041933
},
"Content": {
"Size": 3364
}
},
"CadesT": {
"EntityId": "8f6b9892-6693-4db4-8a13-d1d8e5b7f46a",
"CreationTimestamp": {
"Ticks": 638745087772041933
},
"Content": {
"Size": 6994
}
},
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638745087772041933
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
}
},
"ContentTypeId": "send_confirmation_133_01_03"
},
"ConfirmedAt": {
"Ticks": 638745087772041933
}
},
"RecipientReceipt": {
"IsFinished": true,
"ReceiptAttachment": {
"Attachment": {
"Entity": {
"EntityId": "a5b926b6-ffd9-4f5a-911d-2072a16a7783",
"CreationTimestamp": {
"Ticks": 638747862189246928
},
"Content": {
"Size": 5609
}
},
"AttachmentFilename": "DP_IZVPOL_2BM-6125600340-732644841-202407101103418496883_2BM-9147414342-757645784-202407101104400484330_20250207_c6a07379-b1fb-444a-bfda-500901ac5197.xml",
"DisplayFilename": "Извещение о получении УПД"
},
"Signature": {
"Cms": {
"EntityId": "2dd2c42c-8104-425c-9aee-e5c550c9ff42",
"CreationTimestamp": {
"Ticks": 638747862189246928
},
"Content": {
"Size": 3213
}
},
"CadesT": {
"EntityId": "f4c64718-2ccc-4dbf-aa21-ae584fd203f9",
"CreationTimestamp": {
"Ticks": 638747862192156432
},
"Content": {
"Size": 6846
}
},
"SignerBoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638747862192156432
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом физ. лица без МЧД"
}
},
"ContentTypeId": "receipt_133_01_03"
},
"SentAt": {
"Ticks": 638747862189246928
},
"DeliveredAt": {
"Ticks": 638747862192156432
},
"Confirmation": {
"IsFinished": true,
"ConfirmationAttachment": {
"Attachment": {
"Entity": {
"EntityId": "d0888429-a0ba-430a-b4ac-21462b38b948",
"CreationTimestamp": {
"Ticks": 638747862192156432
},
"Content": {
"Size": 5318
}
},
"AttachmentFilename": "DP_PDOTPR_2BM-6125600340-732644841-202407101103418496883_2BM_20250210_d0888429-a0ba-430a-b4ac-21462b38b948.xml",
"DisplayFilename": "Подтверждение оператора"
},
"Signature": {
"Cms": {
"EntityId": "6c874f6b-7ed8-4916-862a-a1a0350bbe87",
"CreationTimestamp": {
"Ticks": 638747862192156432
},
"Content": {
"Size": 3364
}
},
"CadesT": {
"EntityId": "e78d8d0c-ad3d-42e7-82c0-80316ebd0ee5",
"CreationTimestamp": {
"Ticks": 638747862192156432
},
"Content": {
"Size": 6994
}
},
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638747862192156432
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
}
},
"ContentTypeId": "delivery_confirmation_133_01_03"
},
"ConfirmedAt": {
"Ticks": 638747862192156432
}
},
"Status": "Finished"
},
"RecipientResponse": {
"IsFinished": false,
"ResponseStatus": "WaitingForRecipientSignature"
},
"SenderReceipt": {
"IsFinished": true,
"Status": "GeneralReceiptStatusNotAcceptable"
},
"ResolutionEntities": {
"Requests": [],
"Resolutions": [],
"ApprovementSignatures": [],
"SignatureDenials": []
},
"OuterDocflows": [],
"OuterDocflowEntities": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Warning",
"StatusText": "Ожидается подпись контрагента"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность",
"Errors": []
}
}
}
}
]
}
Пример запроса с использованием C# SDK:
GetDocflowBatchResponseV4 GetDocflowsV4(string authToken, string boxId, GetDocflowBatchRequest request);
Получение двух документов и вывод на консоль признака завершенности их документооборота:
var request = new GetDocflowBatchRequest
{
Requests =
{
new GetDocflowRequest
{
DocumentId = new DocumentId(messageId1, documentId1),
InjectEntityContent = true
},
new GetDocflowRequest
{
DocumentId = new DocumentId(messageId2, documentId2),
InjectEntityContent = false,
LastEventId = lastEventId
}
}
};
var response = api.Docflow.GetDocflowsV4(token, boxId, request);
foreach (var doc in response.Documents)
Console.Out.WriteLine(doc.Docflow.SenderTitle.IsFinished);
См. также
- Инструкции:
- Методы для работы с документооборотом:
GetDocflowEvents (V4) — возвращает список событий, произошедших с документами
GetDocflowEvents (V5) — возвращает список событий, произошедших с документами, корректно отображая данные для многотитульных документов
GetDocflows (V4) — возвращает список документов с информацией о документообороте по их идентификаторам
GetDocflows (V5) — возвращает список документов с информацией о документообороте по их идентификаторам, корректно отображая данные для многотитульных документов
GetDocflowsByPacketId (V4) — возвращает список документов, находящихся в пакете
GetDocflowsByPacketId (V5) — возвращает список документов, находящихся в пакете, корректно отображая данные для многотитульных документов
SearchDocflows (V4) — выполняет поиск документов по строке запроса
SearchDocflows (V5) — выполняет поиск документов по строке запроса, корректно отображая данные для многотитульных документов