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

Отметить как просмотренный

PUT 
/api/v1/clients/:clientId/documents/:documentId/markAsSeen

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

⚠️ Будьте осторожны!

Методы PUT перезаписывают запись целиком: любые непереданные поля считаются null и затирают данные в БД. Поэтому при обновлении нужно указывать все поля. Отмечает документ как просмотренный, если текущий пользователь является одним из его подписантов.

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

  • IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа должен соответствовать формату UUID.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Документ с заданным IDidВнутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должен существовать.
  • Документ должен относиться к заданному клиенту.
  • Документ должен быть не черновиком.
  • Текущий пользователь должен быть одним из подписантов документа.
  • Проверяет, что 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 при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.

Request​

Responses​

Успешная операция.