Скачать архив КЭДО
GET/api/v1/clients/:clientId/applications/:applicationId/archive
Описание метода
Метод для скачивания архива КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ. заявления, содержащего файл заявления и файлы подписей к нему по IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заявления во внешней системе. Результатом выполнения метода будет 303 See Other, а HTTP-заголовок Location будет содержать одноразовую ссылку для скачивания файла zip-архива, содержащего файл заявления и файлы подписей к нему: //file.hr-link.ru/api/v1/files?token=:token Имя файла zip-архива документооборота будет сгенерированно в соответствии со следующим форматом: {СНИЛС}{ТипДокумента}№{НомерДокумента}от{ДатаДокумента}; где {СНИЛС}
- это СНИЛС сотрудника-подписанта. Например, 13165063630_Согласие_на_обработк_№12К_от_2020-12-09. Скачать архив документооборота можно только для заявлений, отправленных на подписание. В архиве документооборота может быть одна подпись, и может быть обе подписи. Это зависит от того, кто подписал заявление на момент скачивания архива документооборота.
Валидации запроса
- Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заявления сотрудника соответствует формату UUID.
- По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует заявление сотрудника.
- Заявление сотрудника по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. относится к клиенту.
- У текущего пользователя есть право получить данные заявления сотрудника.
- Есть возможность получить требуемый файл запрошенного заявления.
- Проверяет возможность получения требуемого файла и возвращает кеш валидации.
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
- По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
- Пользователь, выполняющий операцию, относится к клиенту.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заявления сотрудника, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заявления сотрудника.
- Проверяет, что по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует заявление сотрудника.
- Проверяет, что заявление сотрудника относится к клиенту.
- Пользователь клиента является создателем заявления.
- Пользователь клиента является заявителем.
- Пользователь клиента является получателем группы заявление и документооборот заявления успешно завершен подписанием со стороны всех участников.
- Заявление не является черновиком и пользователь клиента имеет право на получение заявления в качестве подписанта или на уровне роли пользователя клиента или сотрудника.
- Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
- Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
- Проверяет, что клиент не удален.
- Проверяет, что заявление не является черновиком, то есть хотя бы один подписант принял решение.
- Пользователь является подписантом заявления и уже настал момент, когда ему стало доступно подписание заявления.
- Среди подписантов заявления, которым уже стало доступно подписание заявления, есть подписант, который относится к участнику с типом
ROLEи пользователь клиента имеет необходимую роль. - Пользователь клиента имеет право на получение заявлений на уровне роли пользователя клиента или сотрудника.
Request
Responses
- 200
- 303
- 400
- 401
- 403
- 429
Этот код ответа не используется, при успехе выполнения метод всегда возвращает ответ с кодом 303.
HTTP-заголовок Location будет содержать URL, по которому скачивается файл.
✍️ Postman и некоторые другие API-клиенты по умолчанию следуют редиректам и сразу скачивают файл, указанный в
HTTP-заголовке Location. Это поведение настраивается на стороне клиента.
Response Headers
URL, по которому скачивается файл
https://host.hr-link.ru/api/v1/files?token=<<одноразовый_токен>>Ошибка при валидации данных запроса.
Запрос не аутенифицирован.
Для заданного пользователя доступ к ресурсу запрещен.
Превышен разрешенный лимит запросов за период.