Перейти к основному содержимому

Скачать архив с подписями по внешнему ID

GET 
/api/v1/clients/:clientId/documents/:documentExternalId/externalId/archive

Описание метода​

Результатом выполнения метода будет 303 See Other, а HTTP-заголовок Location будет содержать одноразовую ссылку для скачивания файла zip-архива, содержащего файл документа и файлы подписей к нему: //file.hr-link.ru/api/v1/files?token=:token Имя файла zip-архива документооборота будет сгенерированно в соответствии со следующим форматом: {СНИЛС}{ТипДокумента}№{НомерДокумента}от{ДатаДокумента}; где {СНИЛС}

  • это СНИЛС сотрудника-подписанта. Например, 13165063630_Согласие_на_обработк_№12К_от_2020-12-09. Скачать архив документооборота можно только для документов, отправленных на подписание. Для документов черновиков скачать архив документооборота нельзя. В архиве документооборота подписи файла документа могут отсутствовать, может быть одна подпись, и может быть обе подписи. Это зависит от того, кто подписал документ на момент скачивания архива документооборота.

Валидации запроса​

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Если передан IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа в системе HR-Link, то IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа соответствует формату UUID.
  • Документ должен существовать по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях..
  • Документ должен относиться к заданному клиенту.
  • Если передан IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа в системе HR-Link, документ должен относиться к заданному клиенту.
  • Документ должен не быть базовым.
  • Конвертация файла документа в PDF/A формат должна быть завершена.
  • У пользователя клиента должно быть право DOCUMENTS на уровне ролей пользователя клиента и право DOCUMENTS на уровне ролей сотрудника юрлица, к которому относится документ, и пользователь должен являться одним из подписантов документа (не важно при этом подписал он уже документ или нет).
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа задан корректно, и возвращает документ, если он существует.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, что документ относится к заданному клиенту.
  • Проверяет, что документ не является базовым.
  • Проверяет, что конвертация файла документа в PDF/A формат завершилась.
  • Пользователь имеет право DOCUMENTS на уровне ролей пользователя клиента.
  • Пользователь имеет право DOCUMENTS на уровне ролей сотрудника юрлица, к которому относится документ, тип документа и отдел сотрудника-подписанта относятся к доступным.
  • Пользователь является одним из подписантов документа (не важно при этом подписал он уже документ или нет).
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • У пользователя клиента должен быть доступ к документу, а также к файлам документа, если документ отмечен скрытый от участника после подписания.
  • Пользователь клиента является наблюдателем документа, в тот момент, когда документ уже подписан всеми руководителями-подписантами документа.
  • Проверяет наличие прав на файл документа для пользователя.
  • Проверяет наличие прав на получение данных документа относительно права на персональные данные.

Request​

Responses​

Этот код ответа не используется, при успехе выполнения метод всегда возвращает ответ с кодом 303.