GetDocflowsByPacketId (V2)

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

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

Метод GetDocflowsByPacketId возвращает список документов, находящихся в пакете.

POST /V2/GetDocflowsByPacketId

Query Parameters:

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

Request Headers:

Authorization – данные, необходимые для авторизации.

Request Body:

Тело запроса должно содержать структуру GetDocflowsByPacketIdRequest.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит список документов, представленный структурой GetDocflowsByPacketIdResponse.

В ответе вернутся только те документы, к которым у пользователя есть доступ.

Список документов Documents в ответе GetDocflowsByPacketIdResponse может содержать не больше 100 элементов. Поэтому:

Если найденных документов меньше 100, то метод вернет их полностью.

Если найденных документов больше 100, то в ответе Documents вернутся только первые 100 элементов. В этом случае получить весь список найденных документов можно постранично. Для этого вызывайте метод GetDocflowsByPacketId с теми же параметрами запроса и с указанием параметра AfterIndexKey структуры запроса GetDocflowsByPacketIdRequest до тех пор, пока список документов не будет вычитан полностью. В качестве параметра AfterIndexKey нужно указывать ключ документа из поля FetchedDocument.IndexKey.

В зависимости от значения параметра AfterIndexKey метод работает следующим образом:

Если в запросе отсутствует параметр AfterIndexKey, то метод вернет начало списка найденных документов.

Если в запросе указан параметр AfterIndexKey, то метод вернет список документов, следующих за документом с ключом AfterIndexKey; документ с ключом AfterIndexKey в этот список не попадает.

При разработке интеграционного решения учитывайте, что в очередной странице может не быть ни одного документа.

SDK

GetDocflowsByPacketIdResponse GetDocflowsByPacketId(string authToken, string boxId, GetDocflowsByPacketIdRequest request);

Пример использования (C#)

Постраничное получение документов из пакета.

byte[] pageKey = null;
while (true)
{
    var request = new GetDocflowsByPacketIdRequest
    {
        PacketId = packetId,
        AfterIndexKey = pageKey
    };
    var response = api.GetDocflowsByPacketId(token, boxId, request);
    pageKey = response.NextPageIndexKey;
    Console.Out.WriteLine("Fetched {0} documents", response.Documents.Count);
    if (response.NextPageIndexKey == null)
        break;
}