writings.md

Текстовая консультация

Запрос на консультацию

POST /api/v1/writingrequest/start вернёт информацию о запущенной консультации.

Запрос:

Имя	Тип	Описание
doctorId	integer	уникальный идентификатор врача
message	string	текстовое сообщение для врача (обращение/описание проблемы)
patientFullName	string	фио пациента
beginAtUtc	datetime	(optional) время начала консультации. Если параметр не указан, то консультация начнется сразу.
attachment	file	(optional) информация с информацией о пациенте (может послужить предметом обсуждения во время консультации). Содержимое multipart/form-data. Максимальный размер вложения 10 МБ.
externalNotificationUrl	string	(optional) web-hook URL. По этому адресу будет отправлен GET-запрос без каких-либо дополнительных параметров, если был изменен статус консультации. Например, было добавлено заключение, и статус консультации был изменен на "Завершено".
messageAddedNotificationUrl	string	(optional) web-hook URL. По этому адресу будет отправлен GET-запрос без каких-либо дополнительных параметров, если в текстовой консультации появилось новое сообщение.
hasUnreadMessagesNotificationUrl	string	(optional) web-hook URL. По этому адресу будет отправлен GET-запрос без каких-либо дополнительных параметров, если доктор ожидает ответа от пациента более 15 минут.

Ответ:

Объект Текстовая консультация

{
  //.. объект текстовая консультация
}

Получение информации о консультации

GET /api/v1/writingrequest/get/{id} вернёт информацию о консультации.

Запрос

Имя	Тип	Описание
id	string	уникальный идентификатор консультации вида текстовая консультация

Ответ

Объект Текстовая консультация

{
  //.. объект текстовая консультация
}

Поиск по консультациям

GET /api/v1/writingrequest/get-all вернёт список консультаций.

Запрос

Имя	Тип	Описание
ids	array	уникальные идентификаторы консультации вида текстовая консультация
statuses	array<Request Status>	статусы консультации
order	string	сортировать по полю (Created, Status)
asc	boolean	сортировать по возрастанию
limit	integer	максимальное кол-во записей в ответе
offset	integer	смещение (сколько записей пропустить)

Ответ

Объект Текстовая консультация

{
  "items": [
    {
      //.. объект текстовая консультация
    }
  ],
  "count": 10,
  "totalCount": 10
}

Проверка наличия непрочитанных врачом сообщений

GET /api/v1/writingrequest/has-unread-messages/{id} вернёт информацию о непрочитанных врачом сообщений.

Запрос

Имя	Тип	Описание
id	string	уникальный идентификатор консультации вида текстовая консультация

Ответ

{
  "hasUnreadMessages": true
}

Отмена запроса на консультацию

POST /api/v1/writingrequest/cancel вернёт информацию об отменяемой консультации.

Запрос:

Имя	Тип	Описание
requestId	integer	уникальный идентификаторы консультации вида текстовая консультация
reason	string	причина

Ответ:

Объект Текстовая консультация

{
  //.. объект текстовая консультация
}

Прерывание консультации

POST /api/v1/writingrequest/abort вернёт информацию о прерываемой консультации.

Запрос:

Имя	Тип	Описание
requestId	integer	уникальный идентификаторы консультации вида текстовая консультация
reason	string	причина

Ответ:

Объект Текстовая консультация

{
  //.. объект текстовая консультация
}