GetDocflowsByPacketId (V3)
Предупреждение
После окончания переходного периода эта версия метода перестанет работать и будет возвращать ошибки. Используйте новую версию метода — GetDocflowsByPacketId (V4).
Возвращает список документов, находящихся в пакете.
- POST /V3/GetDocflowsByPacketId
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать запрос на получение документов с информацией о документообороте, представленный структурой GetDocflowsByPacketIdRequest.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит список документов с информацией о документообороте, представленный структурой GetDocflowsByPacketIdResponseV3.
В ответе вернутся только те документы, к которым у пользователя есть доступ.
Список документов Documents в ответе GetDocflowsByPacketIdResponseV3 может содержать не больше 100 элементов. Поэтому:
Если найденных документов меньше 100, то метод вернет их полностью.
Если найденных документов больше 100, то в ответе
Documentsвернутся только первые 100 элементов. В этом случае получить весь список найденных документов можно постранично. Для этого вызывайте методGetDocflowsByPacketIdс теми же параметрами запроса и с указанием параметраAfterIndexKeyструктуры запроса GetDocflowsByPacketIdRequest до тех пор, пока список документов не будет вычитан полностью. В качестве параметраAfterIndexKeyнужно указывать ключ документа из поля FetchedDocumentV3.IndexKey.
В зависимости от значения параметра AfterIndexKey метод работает следующим образом:
Если в запросе отсутствует параметр
AfterIndexKey, то метод вернет начало списка найденных документов.Если в запросе указан параметр
AfterIndexKey, то метод вернет список документов, следующих за документом с ключомAfterIndexKey; документ с ключомAfterIndexKeyв этот список не попадает.
При разработке интеграционного решения учитывайте, что в очередной странице может не быть ни одного документа.
Примеры использования
Пример HTTP-запроса:
POST /V3/GetDocflowsByPacketId?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json charset=utf-8
Accept: application/json
Пример тела запроса:
{
"PacketId": "92bccade-bfa0-4310-8051-a0761b5ec0a7"
}
Пример тела ответа:
{
"Documents": [
{
"Document": {
"DocumentId": {
"MessageId": "207f66c8-e4ec-44c0-ac55-ca470353895c",
"EntityId": "8844ce29-51de-4339-926e-27b25d87d71a"
},
"LastEvent": {
"EventId": "6b41239c-63b2-11f0-8000-000171f1b75e",
"Timestamp": {
"Ticks": 638884246403244956
}
},
"DocumentInfo": {
"FullVersion": {
"TypeNamedId": "Nonformalized",
"Function": "default",
"Version": "v1"
},
"MessageType": "Letter",
"WorkflowId": 1,
"Participants": {
"Sender": {
"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000"
},
"Recipient": {
"BoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000"
},
"IsInternal": false
},
"DocumentDirection": "Outbound",
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"Metadata": [
{
"Key": "FileName",
"Value": "image1.png"
}
],
"CustomData": [],
"DocumentLinks": {
"InitialIds": [],
"SubordinateIds": [
{
"MessageId": "207f66c8-e4ec-44c0-ac55-ca470353895c",
"EntityId": "deed95ff-1838-449f-a5a9-f494e8daff13"
}
]
},
"PacketInfo": {
"LockMode": "None",
"PacketId": "92bccade-bfa0-4310-8051-a0761b5ec0a7"
},
"IsRead": true,
"IsDeleted": false,
"IsInvitation": false,
"LetterInfo": {
"IsEncrypted": false,
"ForwardDocumentEvents": [],
"IsTest": false
},
"EditingSettingId": ""
},
"Docflow": {
"SenderTitle": {
"IsFinished": true,
"Attachment": {
"Attachment": {
"Entity": {
"EntityId": "8844ce29-51de-4339-926e-27b25d87d71a",
"CreationTimestamp": {
"Ticks": 638884246398030543
},
"Content": {
"Size": 24368
}
},
"AttachmentFilename": "image1.png",
"DisplayFilename": "Image1.png"
},
"Signature": {
"Cms": {
"EntityId": "c6cf2aa4-63f5-42b6-8e6d-b41900c6efcf",
"CreationTimestamp": {
"Ticks": 638884246398030543
},
"Content": {
"Size": 3213
}
},
"CadesT": {
"EntityId": "4c9e22e3-b498-4568-acc3-ad1e486cb315",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 6843
}
},
"SignerBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638884246401807596
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом физ. лица без МЧД"
},
"SignatureTypeInfo": {
"SignatureType": "Qualified",
"QualifiedDetails": {
"SignatureSource": "Default"
}
}
},
"ContentTypeId": "nonformalized_01"
},
"SentAt": {
"Ticks": 638884246398030543
},
"DeliveredAt": {
"Ticks": 638884246401807596
},
"SenderSignatureStatus": "SenderSignatureCheckedAndValid"
},
"Confirmation": {
"IsFinished": true,
"ConfirmationAttachment": {
"Attachment": {
"Entity": {
"EntityId": "64c92dce-3b10-4a76-808c-b2489443eccd",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 5167
}
},
"AttachmentFilename": "DP_PDPOL_2BM-4934609619-732644841-202407101103418496883_2BM_20250718_64c92dce-3b10-4a76-808c-b2489443eccd.xml",
"DisplayFilename": "Подтверждение даты получения"
},
"Signature": {
"Cms": {
"EntityId": "fbbad90f-85a2-4ccd-941a-53d96093b8f3",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 3532
}
},
"CadesT": {
"EntityId": "c8680d31-815d-4371-8cbc-0170522ade92",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 7160
}
},
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638884246401807596
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
},
"SignatureTypeInfo": {
"SignatureType": "Qualified",
"QualifiedDetails": {
"SignatureSource": "Default"
}
}
},
"ContentTypeId": "send_confirmation_133_01_03"
},
"ConfirmedAt": {
"Ticks": 638884246401807596
}
},
"ResolutionEntities": {
"Requests": [],
"Resolutions": [],
"ApprovementSignatures": [],
"SignatureDenials": []
},
"OuterDocflows": [],
"OuterDocflowEntities": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Info",
"StatusText": "Документооборот завершен"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность",
"Errors": []
}
}
}
},
"IndexKey": "AgoSCchmfyDs5MBEEaxVykcDU4lcEhIJKc5EiN5ROUMRkm4nsl2H1xo="
},
{
"Document": {
"DocumentId": {
"MessageId": "207f66c8-e4ec-44c0-ac55-ca470353895c",
"EntityId": "deed95ff-1838-449f-a5a9-f494e8daff13"
},
"LastEvent": {
"EventId": "6b41239c-63b2-11f0-8000-000171f1b75e",
"Timestamp": {
"Ticks": 638884246403244956
}
},
"DocumentInfo": {
"FullVersion": {
"TypeNamedId": "Nonformalized",
"Function": "default",
"Version": "v1"
},
"MessageType": "Letter",
"WorkflowId": 1,
"Participants": {
"Sender": {
"BoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000"
},
"Recipient": {
"BoxId": "1f208d032a604f6491b1b7aad54cfaf3@diadoc.ru",
"DepartmentId": "00000000-0000-0000-0000-000000000000"
},
"IsInternal": false
},
"DocumentDirection": "Outbound",
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"Metadata": [
{
"Key": "FileName",
"Value": "image2.png"
}
],
"CustomData": [],
"DocumentLinks": {
"InitialIds": [
{
"MessageId": "207f66c8-e4ec-44c0-ac55-ca470353895c",
"EntityId": "8844ce29-51de-4339-926e-27b25d87d71a"
}
],
"SubordinateIds": []
},
"PacketInfo": {
"LockMode": "None",
"PacketId": "92bccade-bfa0-4310-8051-a0761b5ec0a7"
},
"IsRead": true,
"IsDeleted": false,
"IsInvitation": false,
"LetterInfo": {
"IsEncrypted": false,
"ForwardDocumentEvents": [],
"IsTest": false
},
"EditingSettingId": ""
},
"Docflow": {
"SenderTitle": {
"IsFinished": true,
"Attachment": {
"Attachment": {
"Entity": {
"EntityId": "deed95ff-1838-449f-a5a9-f494e8daff13",
"CreationTimestamp": {
"Ticks": 638884246398030543
},
"Content": {
"Size": 17533
}
},
"AttachmentFilename": "image2.png",
"DisplayFilename": "Image2.png"
},
"Signature": {
"Cms": {
"EntityId": "6cda150c-f4d3-4bc0-a1d4-e1c867d2d117",
"CreationTimestamp": {
"Ticks": 638884246398030543
},
"Content": {
"Size": 3213
}
},
"CadesT": {
"EntityId": "20e8f722-8e36-4b59-b627-d40c1fddc20d",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 6843
}
},
"SignerBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638884246401807596
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyRequired",
"Comment": "Документ подписан сертификатом физ. лица без МЧД"
},
"SignatureTypeInfo": {
"SignatureType": "Qualified",
"QualifiedDetails": {
"SignatureSource": "Default"
}
}
},
"ContentTypeId": "nonformalized_01"
},
"SentAt": {
"Ticks": 638884246398030543
},
"DeliveredAt": {
"Ticks": 638884246401807596
},
"SenderSignatureStatus": "SenderSignatureCheckedAndValid"
},
"Confirmation": {
"IsFinished": true,
"ConfirmationAttachment": {
"Attachment": {
"Entity": {
"EntityId": "0b62a7b0-60a0-4a24-a2a5-b07a9d433c60",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 5167
}
},
"AttachmentFilename": "DP_PDPOL_2BM-4934609619-732644841-202407101103418496883_2BM_20250718_0b62a7b0-60a0-4a24-a2a5-b07a9d433c60.xml",
"DisplayFilename": "Подтверждение даты получения"
},
"Signature": {
"Cms": {
"EntityId": "86afb275-4601-4e25-b6cc-677609df0ea4",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 3532
}
},
"CadesT": {
"EntityId": "abd8838c-d021-4a0d-974c-9535afadc416",
"CreationTimestamp": {
"Ticks": 638884246401807596
},
"Content": {
"Size": 7160
}
},
"SignerBoxId": "00000000000000000000000000000000@diadoc.ru",
"SignerDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsValid": true,
"DeliveredAt": {
"Ticks": 638884246401807596
},
"PowerOfAttorneyAttachmentStatus": {
"StatusName": "PowerOfAttorneyNotRequired"
},
"SignatureTypeInfo": {
"SignatureType": "Qualified",
"QualifiedDetails": {
"SignatureSource": "Default"
}
}
},
"ContentTypeId": "send_confirmation_133_01_03"
},
"ConfirmedAt": {
"Ticks": 638884246401807596
}
},
"ResolutionEntities": {
"Requests": [],
"Resolutions": [],
"ApprovementSignatures": [],
"SignatureDenials": []
},
"OuterDocflows": [],
"OuterDocflowEntities": [],
"DocflowStatus": {
"PrimaryStatus": {
"Severity": "Info",
"StatusText": "Документооборот завершен"
},
"PowerOfAttorneyGeneralStatus": {
"Severity": "Warning",
"StatusNamedId": "IsNotAttached",
"StatusText": "Не приложена доверенность",
"Errors": []
}
}
}
},
"IndexKey": "AgoSCchmfyDs5MBEEaxVykcDU4lcEhIJ/5Xt3jgYn0QRpan0lOja/xM="
}
]
}
Пример запроса с использованием C# SDK:
GetDocflowsByPacketIdResponseV3 GetDocflowsByPacketId(string authToken, string boxId, GetDocflowsByPacketIdRequest 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.GetDocflows(token, boxId, request);
foreach (var doc in response.Documents)
Console.Out.WriteLine(doc.Docflow.SenderTitle.IsFinished);
См. также
- Методы для работы с документооборотом:
GetDocflowEvents (V3) — возвращает список событий, произошедших с документами
GetDocflowEvents (V4) — возвращает список событий, произошедших с документами
GetDocflows (V3) — возвращает список документов с информацией о документообороте по их идентификаторам
GetDocflows (V4) — возвращает список документов с информацией о документообороте по их идентификаторам
GetDocflowsByPacketId (V3) — возвращает список документов, находящихся в пакете
GetDocflowsByPacketId (V4) — возвращает список документов, находящихся в пакете
SearchDocflows (V3) — выполняет поиск документов по строке запроса
SearchDocflows (V4) — выполняет поиск документов по строке запроса
- Устаревшие версии метода: