GetDocflowsByPacketId (V2)
Метод устарел и будет удален из API после 03 апреля 2027 года. Подробнее в истории изменений. Используйте актуальную версию метода — GetDocflowsByPacketId (V5).
Метод GetDocflowsByPacketId возвращает список документов, находящихся в пакете.
POST /V2/GetDocflowsByPacketId
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать структуру GetDocflowsByPacketIdRequest.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомboxIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит список документов, представленный структурой GetDocflowsByPacketIdResponse.
В ответе вернутся только те документы, к которым у пользователя есть доступ.
Список документов Documents в ответе GetDocflowsByPacketIdResponse может содержать не больше 100 элементов. Поэтому:
- Если найденных документов меньше 100, то метод вернет их полностью.
- Если найденных документов больше 100, то в ответе
Documentsвернутся только первые 100 элементов. В этом случае получить весь список найденных документов можно постранично. Для этого вызывайте методGetDocflowsByPacketIdс теми же параметрами запроса и с указанием параметраAfterIndexKeyструктуры запроса GetDocflowsByPacketIdRequest до тех пор, пока список документов не будет вычитан полностью. В качестве параметраAfterIndexKeyнужно указывать ключ документа из поля FetchedDocument.IndexKey.
В зависимости от значения параметра AfterIndexKey метод работает следующим образом:
- Если в запросе отсутствует параметр
AfterIndexKey, то метод вернет начало списка найденных документов. - Если в запросе указан параметр
AfterIndexKey, то метод вернет список документов, следующих за документом с ключомAfterIndexKey; документ с ключомAfterIndexKeyв этот список не попадает.
При разработке интеграционного решения учитывайте, что в очередной странице может не быть ни одного документа.
SDK
GetDocflowsByPacketIdResponse GetDocflowsByPacketIdV2(string authToken, string boxId, GetDocflowsByPacketIdRequest request);
Пример использования (C#)
Постраничное получение документов из пакета.
byte[] pageKey = null;
while (true)
{
var request = new GetDocflowsByPacketIdRequest
{
PacketId = packetId,
AfterIndexKey = pageKey
};
var response = api.GetDocflowsByPacketIdV2(token, boxId, request);
pageKey = response.NextPageIndexKey;
Console.Out.WriteLine("Fetched {0} documents", response.Documents.Count);
if (response.NextPageIndexKey == null)
break;
}