3.2.10. Метод получения списка документооборотов по заданным параметрам
Метод GetList возвращает список документооборотов, соответствующих указанным параметрам, начиная с заданного момента времени.
Для получения списка документооборотов необходимо предварительно авторизоваться по имени пользователя и паролю сотрудника организации или по зарегистрированному в системе сертификату ЭП.
HTTP-запрос
HTTP-метод: GET
|
Адрес запроса (URI)
| |
|
https://<server>.taxcom.ru/v<version>/API/GetList
| |
|
Заголовок запроса
| |
|
Assistant-Key
|
Маркер временного доступа (Authorization token)
|
|
Integrator-Id
|
Идентификатор интеграционного решения.
COMPANY_AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA
|
HTTP-ответ
XML файл cо списком документооборотов участника ЭДО и статусами этих документооборотов.
Параметры
|
Параметр
|
Значения параметра
|
Пояснения
|
|
date
|
Формат параметра: yyyy-MM-ddTHH:mm:ss
|
Этот параметр устанавливает момент времени, начиная с которого будут отобраны данные о документооборотах участника ЭДО, данные которого содержатся в авторизационном токене.
|
|
status
|
При вызове метода указывается только одно из перечисленных ниже значений параметра status.
| |
|
Sending
|
- для документооборота входящего или исходящего документа, для которого выполнение регламентных транзакций не завершено,
или для документооборота исходящего документа, для которого выполнение предусмотренных Регламентом транзакций не началось.
| |
|
ResignWaiting
|
- для документооборота входящего двухстороннего документа, ожидающего подписания или отклонения.
| |
|
Succeed
|
- для успешно завершенного документооборота.
| |
|
CompletedWithWarning
|
- для документооборота, отклонённого получателем документа.
| |
|
Fail
|
- при остановке доставки документа из-за ошибки.
| |
|
WaitingForCancellation
|
- в ожидании аннулирования.
| |
|
Cancelled
|
- аннулирован.
| |
|
CompletedWithDivergences
|
- завершен с расхождениями.
| |
|
NotAccepted
|
- документ не принят.
| |
|
direction
|
Ingoing
|
Для отбора при фильтрации записей о документах только одного из направлений:
|
|
Outgoing
| ||
|
includeExtendedDocflowStatuses
|
true
|
Если этому параметру задано значение true, то результат вызова учитывает значения статусов CompletedWithDivergences и NotAccepted.
Если false (значение по умолчанию), или параметр не задан, - то вместо статуса CompletedWithDivergences или NotAccepted возвращается значение Succeed.
|
|
false (значение по умолчанию)
| ||