Подтвердить подписание (УНЭП)
PUT/api/v1/clients/:clientId/documents/:documentId/sign/nqes
Описание метода
⚠️ Будьте осторожны!
Методы PUT перезаписывают запись целиком: любые непереданные поля считаются null и затирают данные в БД. Поэтому при обновлении нужно указывать все поля. Подтверждение заключается в передаче кода, отправленного в СМС на номер телефона, который был указан при выпуске сертификата пользователя. Получение ответа на этот запрос не означает, что документ уже подписан. Документ станет подписанным через некоторое время после этого. Чтобы понять, что документ подписался, можно запрашивать нужный документ (см. получение данных документа) и в данных смотреть, подписался ли файл подписантом или весь целиком.
Валидации запроса
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа должен соответствовать формату UUID.
- Тело запроса задано.
- Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
- Документ с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должен существовать.
- Документ должен относиться к заданному клиенту.
- Документ не является «Согласием на установление КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.».
- Документ не является базовым.
- Документ не является черновиком.
- Документ не удален.
- Подписанты документа находятся в корректном состоянии для подписания.
- Запрос на подписание документа текущим подписантом должен существовать.
- Запрос на подписание документа текущим подписантом не истек.
- Активных подтверждений подписания документа не должно существовать.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа.
- IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
- По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
- Пользователь, выполняющий операцию, относится к клиенту.
- Проверяет, что документ существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает документ, если он существует.
- Проверяет, что документ относится к заданному клиенту.
- Проверяет, что документ не является «Согласием на установление КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.».
- Проверяет, что запрос на подписание существует и возвращает его в случае, когда он существует.
- Проверяет, что запрос на подписание не истек.
- Проверяет, что не существует активных подтверждений подписания документа.
- Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
- Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
- Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
- Проверяет, что клиент не удален.
- Проверяет существование документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.
Request
Responses
- 200
- 400
- 401
- 403
- 429
Успешная операция.
Ошибка при валидации данных запроса.
Запрос не аутенифицирован.
Для заданного пользователя доступ к ресурсу запрещен.
Превышен разрешенный лимит запросов за период.