GetPersonSets

Матеріал з SERVIO
Версія від 10:03, 16 серпня 2024, створена Sushchuk.a (обговорення | внесок) (Створена сторінка: =='''Функція повертає список всіх наборів, що є на карті користувача'''== Розділ містить методи, необхідні для отримання списоку всіх наборів, що є на карті користувача <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="...)
(різн.) ← Попередня версія | Поточна версія (різн.) | Новіша версія → (різн.)
Перейти до навігації Перейти до пошуку

Функція повертає список всіх наборів, що є на карті користувача

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


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



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
  "CardID": 216795,
  "ShowRendered": true,
  "ShowNonRendered": true,
  "ShowExpired": true
}



Типи даних Body
* Параметр Тип Опис
CardID Int ID карти клієнта
ShowRendered Bool true - Відображувати надані
false - Не відображувати надані
ShowNonRendered Bool true - Відображувати не надані
false - Не відображувати не надані
ShowExpired Bool true - Відображувати протерміновані
false - Не відображувати протерміновані
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "ErrorCode": 0,
    "Success": true,
    "Sets": [
        {
            "ID": 139341,
            "TarifItemID": 4723,
            "CardID": 216795,
            "SetItemName": "Групові заняття",
            "SetTotal": 0.00,
            "Code": "PCS-43E3F39A855E4E7DBE32",
            "State": "Active",
            "Sold": "2024-08-07 16:05:27",
            "Started": "2024-08-07 16:05:27",
            "Expired": "2024-08-16 12:13:58",
            "Freezed": null,
            "PayExpired": null,
            "NonRenderedCount": 19,
            "RenderedCount": 0,
            "ExpiredCount": 0,
            "NonRenderedItems": [
                {
                    "CardItemID": 5200160,
                    "TarifItemID": 4163,
                    "SetID": 139341,
                    "TarifItemName": "Групові заняття ЛФК, 25 хв.",
                    "ServiceExecutorID": null,
                    "ServiceExecutorLastName": null,
                    "ServiceExecutorFirstName": null,
                    "ServiceExecutorPatronymic": null,
                    "ServicePointID": null,
                    "ServicePointName": null,
                    "PlaceID": null,
                    "PlaceName": null,
                    "PlaceGroupID": null,
                    "PlaceGroupName": null,
                    "AssignID": null,
                    "ActiveStart": null,
                    "ActiveFinish": null,
                    "Executed": null,
                    "Start": null,
                    "Finish": null,
                    "Payed": "2024-08-07 16:05:27",
                    "BillID": 274599,
                    "BillNumber": 344242
                },
                {
                    "CardItemID": 5200159,
                    "TarifItemID": 4165,
                    "SetID": 139341,
                    "TarifItemName": "Інструктаж з Нордичної ходьби, 30 хв.",
                    "ServiceExecutorID": null,
                    "ServiceExecutorLastName": null,
                    "ServiceExecutorFirstName": null,
                    "ServiceExecutorPatronymic": null,
                    "ServicePointID": null,
                    "ServicePointName": null,
                    "PlaceID": null,
                    "PlaceName": null,
                    "PlaceGroupID": null,
                    "PlaceGroupName": null,
                    "AssignID": null,
                    "ActiveStart": null,
                    "ActiveFinish": null,
                    "Executed": null,
                    "Start": null,
                    "Finish": null,
                    "Payed": "2024-08-07 16:05:27",
                    "BillID": 274599,
                    "BillNumber": 344242
                }               
            ],
            "RenderedItems": [],
            "ExpiredItems": []
        }
    ]
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
ErrorCode String Код помилки, що виникла
Success Bool Успіх виконання запиту
Sets Sets [ ] Масив наборів. Елементи масиву з наступними полями:
     | ID Int ID набору.
     | TarifItemID Int ID Тарифної позиції, що є набором.
     | CardID Int Id карти до якої належежить набір
     | SetItemName String Назва набору
     | SetTotal Decimal Ціна набору
     | Code String Код набору
     | State String Статус:

Active - активна,
Inactive - не активна
Freezed - заморожена

     | Sold Datetime Дата та час продажі набору.
     | Started Datetime Дата та час початку дії набору.
     | Expired Datetime Дата та час початку завершення дії набору.
     | Freezed Datetime Дата та час початку замороження набору.
     | PayExpired Datetime Дата та час після якої заборонено оплачувати набір частинами.
NonRenderedCount [ ] Список не наданих послуг з набору.
RenderedCount [ ] Список наданих послуг з набору.
ExpiredItems [ ] Список протермінованих послуг з наступними полями:
     | CardItemID Int ID в корзині
     | TarifItemID Int ID тарифної позиції
     | SetID Int ID позиції в наборі
     | TarifItemName String Назва тарифної позиції
     | CompanyName String Назва компанії
     | CurrentSaleAmount Int Кількість людей, що записані на групове заняття. Не використовується в звичайних бронюваннях та є завжди null.
     | Description String Опис до заходу
     | Executed Datetime Час надання послуги. Якщо він null - послуга не надана.
     | ExecutionID Int не використовується
     | ExecutorID Int ID виконавця послуги
     | ExecutorName String Імя виконавця послуги
     | Finish Datetime Дата та час закінчення
     | ID Int ID послуги
     | IsPaid Bool Статус оплати послуги. Не використовується в груповому занятті.
     | MaxSaleAmount Int Кількість людей, що може бути записано на групове заняття. Не використовується в звичайних бронюваннях та є завжди null.
     | PointID Int ID точки надання послуг
     | PointName String Назва точки надання послуг
     | ServiceType Int Тип послуги:
0 - Немає,
1 - Кількісна
     | Start Datetime Дата та час початку
     | TarifItemID Int ID тарифної позиції
     | UserName String Користувач що отримує послугу
       Booked        Booked [ ] Масив списку броней. Елементи масиву з наступними полями:
     |  | BookedID Int ID бронювання = AssignID з методу GetPersonCardItems   чи ID з GetAssignsByGuest  
     |  | CardCode Int Код карти гостя
     |  | CardID Int ID карти гостя
     |  | CardItemID Int ID позиції в кошику з методу GetPersonCardItems  
     |  | Description String Опис
     |  | Executed Bool true - надані,
false - не надані
     |  | IsPaid Bool true - сплачена,
false - не сплачена
     |  | UserName String Імя власника карти
Додатковий опис вхідних параметрів