GetBrands

Матеріал з SERVIO
Версія від 07:54, 14 березня 2023, створена Shulgina.a (обговорення | внесок) (→‎Функція повертає список брендів)
(різн.) ← Попередня версія | Поточна версія (різн.) | Новіша версія → (різн.)
Перейти до навігації Перейти до пошуку

Функція повертає список брендів

Розділ містить методи, необхідні для отримання списку брендів


Опис Отримання списку брендів.
Метод POST
URL /POSExternal/GetBrands



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
 {
    
 }



Типи даних Body
* Параметр Тип Опис
ShowDisabled Bool Відображати не активні бренди (не обов'язковий параметр)
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "Success": true,
    "Brands": [
        {
            "Address": "",
            "AddressEn": "",
            "AddressRu": "",
            "Banners": [],
            "Description": "",
            "Enabled": true,
            "FullDescription": "",
            "FullDescriptionEn": "",
            "FullDescriptionRu": "",
            "ID": 1,
            "Image": {
                "Path": null,
                "Type": "image/jpeg"
            },
            "Locations": "",
            "Logo": {
                "Path": null,
                "Type": "image/jpeg"
            },
            "Logo_Button": {
                "Path": null,
                "Type": "image/jpeg"
            },
            "Logo_pin": {
                "Path": null,
                "Type": "image/jpeg"
            },
            "Name": "SERVIO",
            "NameEn": "",
            "NameRu": "",
            "Phones": "",
            "Schedule": "",
            "ScheduleEn": "",
            "ScheduleRu": "",
            "SiteUrl": "",
            "TradeActions": []
        }
    ]
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
Brands BrandsList [] Масив опису брендів. Елементи масиву з наступними полями:
     | Address String Адреса
     | AddressEn String Адреса англійською
     | AddressRu String Адреса російською
         |Banners BannersList[] Список банерів. Елементи масиву з наступними полями:
         || ID Int ID
         || Name String Назва
         || Description String Опис
         ||LinkUA, LinkEN, LinkRu String Посилання для різних мов під різні платформи:
  • Android
  • Android_manager
  • Apple_watch
  • Desktop
  • Ipad_iphone_v2
  • Iphone
  • Mobile
     | Description String Опис
     | Enabled Bool Активність
     | FullDescription String Повний опис
     | FullDescriptionEn String Повний опис англійською
     | FullDescriptionRu String Повний опис російською
     | ID Int ID
     | Image, Logo, Logo_pin, Logo_Button Посилання на зображення виду
         | | Path String Шлях до зображення
         | | Type String Тип зображення
     | Locations String Точки розміщення через ; (Latitude, Longitude; приклад - 123.6,2341.56;453.6,7341.56)
     | Name String Назва
     | NameEn String Назва англійською
     | NameRu String Назва російською
     | Phones String Телефони
     | Schedule String Розклад
     | ScheduleEn String Розклад англійською
     | ScheduleRu String Розклад російською
     | SiteUrl String Сайт
     | TradeActions TradeActions[] Акції
         | | ActionID Int ID акції
         | | ActionName String Назва акції
         | | ActionNameRu String Назва акції російською
         | | ActionNameEn String Назва акції англійською
         | | ActionDescription String Опис
         | | ActionDescriptionRu String Опис російською
         | | ActionDescriptionEn String Опис англійською
         | | ActionComment String Короткий опис
         | | ActionCommentRu String Короткий опис російською
         | | ActionCommentEn String Короткий опис англійською
         | | ValidDate Datetime Дата, до котрої активна
         | | Pos Int Позиція
Додатковий опис вхідних параметрів