GetBrands: відмінності між версіями

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
(Створена сторінка: =='''Функція повертає список брендів'''== Розділ містить методи, необхідні для отримання списку брендів <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Опис | style="background:#fff...)
 
 
Рядок 155: Рядок 155:
| Адреса російською
| Адреса російською
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">Banners</span>  
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">Banners</span>  
| <span style="color:#008F39">BannersList[]</span>
| <span style="color:#008F39">BannersList[]</span>
| Список банерів. Елементи масиву з наступними полями:
| Список банерів. Елементи масиву з наступними полями:
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> ID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> ID
| Int
| Int
| ID  
| ID  
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> Name
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> Name
| String
| String
| Назва
| Назва
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> Description
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span> Description
| String
| String
| Опис
| Опис
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span>LinkUA, LinkEN, LinkRu
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span><span style="color:#008F39">'''|'''</span>LinkUA, LinkEN, LinkRu
| String
| String
| Посилання для різних мов під різні платформи
| Посилання для різних мов під різні платформи: <br>
* Android <br>
* Android_manager <br>
* Apple_watch <br>
* Desktop <br>
* Ipad_iphone_v2 <br>
* Iphone <br>
* Mobile
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Description
| String
| Опис
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Enabled
| Bool
| Активність
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> FullDescription
| String
| Повний опис
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> FullDescriptionEn
| String
| Повний опис англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> FullDescriptionRu
| String
| Повний опис російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ID
| Int
| ID
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#C2B078">Image, Logo, Logo_pin, Logo_Button</span>
|
| Посилання на зображення виду
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#C2B078">'''|'''</span> Path
| String
| Шлях до зображення
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#C2B078">'''|'''</span> Type
| String
| Тип зображення
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  Locations
| String
| Точки розміщення через ; (Latitude, Longitude; приклад - 123.6,2341.56;453.6,7341.56)
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  Name
| String
| Назва
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  NameEn
| String
| Назва англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  NameRu
| String
| Назва російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  Phones
| String
| Телефони
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  Schedule
| String
| Розклад
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  ScheduleEn
| String
| Розклад англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  ScheduleRu
| String
| Розклад російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>  SiteUrl
| String
| Сайт
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">TradeActions</span>
| <span style="color:#063971">TradeActions[]</span>
| Акції
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionID
| Int
| ID акції
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionName
| String
| Назва акції
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionNameRu
| String
| Назва акції російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionNameEn
| String
| Назва акції англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionDescription
| String
| Опис
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionDescriptionRu
| String
| Опис російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionDescriptionEn
| String
| Опис англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionComment
| String
| Короткий опис
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionCommentRu
| String
| Короткий опис російською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ActionCommentEn
| String
| Короткий опис англійською
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> ValidDate
| Datetime
| Дата, до котрої активна
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> <span style="color:#063971">'''|'''</span> Pos
| Int
| Позиція
|}
|}



Поточна версія на 07:54, 14 березня 2023

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

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


Опис Отримання списку брендів.
Метод 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 Позиція
Додатковий опис вхідних параметрів