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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
(Створена сторінка: =='''Функція повертає список всіх наборів, що є на карті користувача'''== Розділ містить методи, необхідні для отримання списоку всіх наборів, що є на карті користувача <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="...)
 
Немає опису редагування
 
Рядок 252: Рядок 252:
|-
|-
|-
|-
| <span style="color:#1be8e3">NonRenderedCount </span>
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#1be8e3">NonRenderedCount </span>
| <span style="color:#1be8e3">  [ ] </span>
| <span style="color:#1be8e3">  [ ] </span>
| Список не наданих послуг з набору.
| Список не наданих послуг з набору.
|-
|-
|-
|-
| <span style="color:#9411c7">RenderedCount</span>
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#9411c7">RenderedCount</span>
| <span style="color:#9411c7"> [ ] </span>
| <span style="color:#9411c7"> [ ] </span>
| Список наданих послуг з набору.
| Список наданих послуг з набору.
|-
|-
|-
|-
| <span style="color:#2fc256">ExpiredItems</span>
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">ExpiredItems</span>
| <span style="color:#2fc256"> [ ] </span>
| <span style="color:#2fc256"> [ ] </span>
| Список протермінованих послуг з наступними полями:
| Список протермінованих послуг з наступними полями:
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> CardItemID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> CardItemID
| Int
| Int
| ID в корзині
| ID в корзині
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> TarifItemID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> TarifItemID
| Int
| Int
| ID тарифної позиції
| ID тарифної позиції
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> SetID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> SetID
| Int
| Int
| ID позиції в наборі
| ID позиції в наборі
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> TarifItemName
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ServiceExecutorID
| String
| Int
| Назва тарифної позиції
| ID виконавця
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> CompanyName
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ServiceExecutorLastName
| String
| String
| Назва компанії
| Імя виконавця
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> CurrentSaleAmount
| Int
| Кількість людей, що записані на групове заняття. Не використовується в звичайних бронюваннях та є завжди null.
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> Description
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ServiceExecutorFirstName
| String
| String
| Опис до заходу
| Прізвище виконавця
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> Executed
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ServiceExecutorPatronymic
| Datetime
| String
| Час надання послуги. Якщо він null - послуга не надана.
| По батькові виконавця
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> ExecutionID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> CompanyName
| Int
| Int
| не використовується
| ID точки надання послуг
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> ExecutorID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ServicePointName
| Int
| ID виконавця послуги
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> ExecutorName
| String
| String
| Імя виконавця послуги
| Назва точки надання послуг
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> Finish
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> PlaceID
| Datetime
| Дата та час закінчення
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> ID
| Int
| Int
| ID послуги
| Місце
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> IsPaid
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> PlaceName
| Bool
| String
| Статус оплати послуги. Не використовується в груповому занятті.
| Імя місця (стола)
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> MaxSaleAmount
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> PlaceGroupID
| Int
| Int
| Кількість людей, що може бути записано на групове заняття. Не використовується в звичайних бронюваннях та є завжди null.
| ID групи місць
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> PointID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> AssignID
| Int
| Int
| ID точки надання послуг
| ID призначення в корзині
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> PointName
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ActiveStart
| String
| DateTime
| Назва точки надання послуг
| Активний з
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> ServiceType
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> ActiveFinish
| Int
| DateTime
| Тип послуги:<br> 0 - Немає,<br> 1 - Кількісна
| Активний по
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> Start
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Executed
| Datetime
| DateTime
| Дата та час початку
| Дата надання послуги
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> TarifItemID
| Int
| ID тарифної позиції
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span> UserName
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Start
| String
| DateTime
| Користувач що отримує послугу
| Дата та час старту заброньованої послуги
|-
|-
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#8A2BE2">Booked</span>
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Finish
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#8A2BE2">Booked  [ ] </span>
| DateTime
| Масив списку броней. Елементи масиву з наступними полями:
| Дата та час завершення надання послуги
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> BookedID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Payed
| Int
| DateTime
| ID бронювання = AssignID з методу </span>[https://wiki.servio.support/index.php?title=GetPersonCardItems  GetPersonCardItems  ]</span> &nbsp; чи ID з </span>[https://wiki.servio.support/index.php?title=GetAssignsByGuest  GetAssignsByGuest  ]</span> &nbsp;
| Дата та час оплати послуги
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> CardCode
| Int
| Код карти гостя
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> CardID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> BillID
| Int
| Int
| ID карти гостя
| ID рахунку
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> CardItemID
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span> &nbsp; <span style="color:#2fc256">'''|'''</span> BillNumber
| Int
| Int
| ID позиції в кошику з методу </span>[https://wiki.servio.support/index.php?title=GetPersonCardItems  GetPersonCardItems  ]</span> &nbsp;
| Номер рахунку
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> Description
| String
| Опис
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> Executed
| Bool
| true - надані,<br> false - не надані
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> IsPaid
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Started
| Bool
| DateTime
| true - сплачена,<br> false - не сплачена
| Дата та час початку дії набору
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> UserName
| String
| Імя власника карти
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#ff0000">'''|'''</span>&nbsp;<span style="color:#2fc256">'''|'''</span> Expired
| DateTime
| Дата та час протермінування послуги
|}
|}


Поточна версія на 12:18, 16 серпня 2024

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

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


Опис Отримання списку всіх наборів.
Метод 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 позиції в наборі
     | | ServiceExecutorID Int ID виконавця
     | | ServiceExecutorLastName String Імя виконавця
     | | ServiceExecutorFirstName String Прізвище виконавця
     | | ServiceExecutorPatronymic String По батькові виконавця
     | | CompanyName Int ID точки надання послуг
     | | ServicePointName String Назва точки надання послуг
     | | PlaceID Int Місце
     | | PlaceName String Імя місця (стола)
     | | PlaceGroupID Int ID групи місць
     | | AssignID Int ID призначення в корзині
     | | ActiveStart DateTime Активний з
     | | ActiveFinish DateTime Активний по
     | | Executed DateTime Дата надання послуги
     | | Start DateTime Дата та час старту заброньованої послуги
     | | Finish DateTime Дата та час завершення надання послуги
     | | Payed DateTime Дата та час оплати послуги
     | | BillID Int ID рахунку
     |   | BillNumber Int Номер рахунку
     | | Started DateTime Дата та час початку дії набору
     | | Expired DateTime Дата та час протермінування послуги
Додатковий опис вхідних параметрів
Отримано з http://wiki.servio.support/index.php?title=GetPersonSets&oldid=6682