Запрос

Адрес запроса

PUT: {{url}}/banners/{{bannerId}}

Параметры запроса

ПараметрОписаниеПо умолчаниюОбязательныйКомментарий
bannerIdИдентификатор баннера-+

Тело запроса

При обновлении баннера используется та же модель баннера, что и в ответе методов, но при создании не следует передавать поля: id - идентификатор, lastModified - Время последнего изменения и createdOn - Время создания. Позже будет создана отдельная с соответствующими валидациями.


Модель: Баннер - Banner

Описание полей

Название

Тип данных

Описание

Комментарий
idstringИдентификатор
namestringНазваниеЛатинское название/код баннера
typestringТип

Возможные значения:

  • general - обычный баннер, который создается через админку
titlestringЗаголовок
textstringТекст
linksМассив LinkItemСсылкиЕсли пусто
imageUrlstringСсылка на изображениеЕсли null, то ничего не отображаем
lastModifiedstring(DateTime)Время последнего изменения
createdOnstring(DateTime)Время создания
enabledboolАктивированПо умолчанию все баннеры активны. Для отображения в списке неактивных нужно использовать в запросе параметр enabled=false
lpusArray of stringСписок гуидов ЛПУ, для которых активен баннер


LinkItem

Название

Тип данных

Описание

Комментарий
titlestringТекст ссылки
linkstringСсылка




Пример модели в формате JSON 
{
    "id": "5d1dc69d00951a198ccb8c82",
    "name": "Test2",
    "type": "General",
    "title": "boo2",
    "text": "Test-post-text",
    "links": [],
    "imageUrl": null,
    "lastModified": null,
    "createdOn": null,
    "enabled": true,
    "lpus": [
        "ed501fc9-1653-47b5-a939-863922d010e4"
    ]
}

Ответ сервера

В случае успешного выполнения сервер вернет ответ в формате JSON со следующими данными:

Модель: Баннер - Banner

Описание полей

Название

Тип данных

Описание

Комментарий
idstringИдентификатор
namestringНазваниеЛатинское название/код баннера
typestringТип

Возможные значения:

  • general - обычный баннер, который создается через админку
titlestringЗаголовок
textstringТекст
linksМассив LinkItemСсылкиЕсли пусто
imageUrlstringСсылка на изображениеЕсли null, то ничего не отображаем
lastModifiedstring(DateTime)Время последнего изменения
createdOnstring(DateTime)Время создания
enabledboolАктивированПо умолчанию все баннеры активны. Для отображения в списке неактивных нужно использовать в запросе параметр enabled=false
lpusArray of stringСписок гуидов ЛПУ, для которых активен баннер


LinkItem

Название

Тип данных

Описание

Комментарий
titlestringТекст ссылки
linkstringСсылка




Пример модели в формате JSON 
{
    "id": "5d1dc69d00951a198ccb8c82",
    "name": "Test2",
    "type": "General",
    "title": "boo2",
    "text": "Test-post-text",
    "links": [],
    "imageUrl": null,
    "lastModified": null,
    "createdOn": null,
    "enabled": true,
    "lpus": [
        "ed501fc9-1653-47b5-a939-863922d010e4"
    ]
}

Возможные ошибки

Код ответа сервераКод сообщенияСообщениеТип ошибки



В случае возникновения ошибок будет возвращен стандартный ответ сервера.


  • Нет меток