Запрос
Адрес запроса
PUT: {{url}}/banners |
Параметры запроса
Параметр | Описание | По умолчанию | Обязательный | Комментарий |
---|---|---|---|---|
bannerId | Идентификатор баннера | - | + |
Тело запроса
При обновлении баннера используется та же модель баннера, что и в ответе методов, но при создании не следует передавать поля: id - идентификатор, lastModified - Время последнего изменения и createdOn - Время создания. Позже будет создана отдельная с соответствующими валидациями.
Модель: Баннер - Banner
Описание полей
Название | Тип данных | Описание | Комментарий |
---|---|---|---|
id | string | Идентификатор | |
name | string | Название | Латинское название/код баннера |
type | string | Тип | Возможные значения:
|
title | string | Заголовок | |
text | string | Текст | |
links | Массив LinkItem | Ссылки | Если пусто |
imageUrl | string | Ссылка на изображение | Если null, то ничего не отображаем |
lastModified | string(DateTime) | Время последнего изменения | |
createdOn | string(DateTime) | Время создания | |
enabled | bool | Активирован | По умолчанию все баннеры активны. Для отображения в списке неактивных нужно использовать в запросе параметр enabled=false |
lpus | Array of string | Список гуидов ЛПУ, для которых активен баннер |
LinkItem
Название | Тип данных | Описание | Комментарий |
---|---|---|---|
title | string | Текст ссылки | |
link | string | Ссылка |
Ответ сервера
В случае успешного выполнения сервер вернет ответ в формате JSON со следующими данными:
Модель: Баннер - Banner
Описание полей
Название | Тип данных | Описание | Комментарий |
---|---|---|---|
id | string | Идентификатор | |
name | string | Название | Латинское название/код баннера |
type | string | Тип | Возможные значения:
|
title | string | Заголовок | |
text | string | Текст | |
links | Массив LinkItem | Ссылки | Если пусто |
imageUrl | string | Ссылка на изображение | Если null, то ничего не отображаем |
lastModified | string(DateTime) | Время последнего изменения | |
createdOn | string(DateTime) | Время создания | |
enabled | bool | Активирован | По умолчанию все баннеры активны. Для отображения в списке неактивных нужно использовать в запросе параметр enabled=false |
lpus | Array of string | Список гуидов ЛПУ, для которых активен баннер |
LinkItem
Название | Тип данных | Описание | Комментарий |
---|---|---|---|
title | string | Текст ссылки | |
link | string | Ссылка |
Возможные ошибки
Код ответа сервера | Код сообщения | Сообщение | Тип ошибки |
---|---|---|---|
В случае возникновения ошибок будет возвращен стандартный ответ сервера.