Page tree
Skip to end of metadata
Go to start of metadata

Запрос

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

GET: {{url}}/banners?lpu={{lpu}}

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

ПараметрОписаниеПо умолчаниюОбязательныйКомментарий
lpuГуид ЛПУ--Если не указать ЛПУ, то отобразятся все баннеры без привязки к ЛПУ
enabledПолучить активныеtrue-Позволяет скрывать неактивные. Если указать false, то получается полный список.

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

В случае успешного выполнения сервер вернет ответ в формате 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"
    ]
}

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

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





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


  • No labels

3 Comments

  1. enabled=true
    видимо false? и в этой доке в адресе нет такого параметра
    1. Верно. Очепятка

    2. А по поводу того, что нет - это потому что он необязательный. Будет работать и без него - просто по умолчанию будет считаться что он передал true.