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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
 
(Не показано одну проміжну версію цього користувача)
Рядок 39: Рядок 39:
{
{
   "From": "2024-05-26 09:00:00",
   "From": "2024-05-26 09:00:00",
   "To": "2024-05-30 23:59:00"
   "To": "2024-05-30 23:59:00",
  "type": "assigns"
}
}
</syntaxhighlight>
</syntaxhighlight>
Рядок 62: Рядок 63:
| Datetime
| Datetime
| Дата до
| Дата до
|-
|
| type
| String
| Фільтр. null - всі заходи на сьогодні;<br> "Assigns" - лише індивідуальні;<br> "GroupAssigns"/"Group Assigns" - лише групові;<br>
|-
|-
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
Рядок 132: Рядок 138:
             "Start": "2024-05-29 10:00:00",
             "Start": "2024-05-29 10:00:00",
             "TarifItemID": 14874,
             "TarifItemID": 14874,
             "UserName": null
             "UserName": null,
            "Booked": [
                {
                    "BookedID": 3242,
                    "CardCode": "0165191",
                    "CardID": 62327,
                    "CardItemID": 5199998,
                    "Description": null,
                    "Executed": null,
                    "GroupAssignID": 272709,
                    "IsPaid": false,
                    "UserName": "Бурлака Наталія"
                },
                {
                    "BookedID": 3244,
                    "CardCode": "0258131",
                    "CardID": 147102,
                    "CardItemID": 5197806,
                    "Description": null,
                    "Executed": null,
                    "GroupAssignID": 272709,
                    "IsPaid": false,
                    "UserName": "Проскуровський Артем"
                }
          ],
         }
         }
     ]
     ]
Рядок 341: Рядок 371:
| Користувач що отримує послугу
| Користувач що отримує послугу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> CardCode
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#8A2BE2">Booked</span>
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#8A2BE2">Booked  [ ] </span>
| Масив списку броней. Елементи масиву з наступними полями:
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> BookedID
| Int
| 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
| Int
| ID карти гостя
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> CardItemID
| 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
| Bool
| true - сплачена,<br> false - не сплачена
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#2fc256">'''|'''</span>&nbsp; <span style="color:#8A2BE2">'''|'''</span> UserName
| String
| String
| Код карти користувача що отримує послугу
| Імя власника карти
|-
|}
|}



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

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

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


Опис Отримання списку всіх заходів (послуг).
Метод POST
URL /POSExternal/GetAssigns



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
  "From": "2024-05-26 09:00:00",
  "To": "2024-05-30 23:59:00",
  "type": "assigns"
}



Типи даних Body
* Параметр Тип Опис
From Datetime Дата від
To Datetime Дата до
type String Фільтр. null - всі заходи на сьогодні;
"Assigns" - лише індивідуальні;
"GroupAssigns"/"Group Assigns" - лише групові;
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
{
    "Error": "",
    "ErrorCode": 0,
    "Success": true,
    "Assigns": [
        {
            "ArticleName": "Первинний прийом чергової медичної сестри",
            "CardID": 273935,
            "CardItemID": 5197784,
            "CompanyID": 190,
            "CompanyName": "Санаторій",
            "CurrentSaleAmount": null,
            "Description": "Первинний прийом",
            "Executed": null,
            "ExecutionID": 0,
            "ExecutorID": 5988,
            "ExecutorName": "Макаренко З.В.",
            "Finish": "2024-05-29 17:55:00",
            "ID": 2319448,
            "IsPaid": false,
            "MaxSaleAmount": null,
            "PointID": 7000,
            "PointName": "Медичний адміністратор (Корпус №4)",
            "ServiceType": 0,
            "Start": "2024-05-29 17:45:00",
            "TarifItemID": 4727,
            "UserName": "2 - Петренко"
        }
    ],
    "GroupAssigns": [
        {
            "ArticleName": "Групове заняття",
            "CardID": 0,
            "CardItemID": 0,
            "CompanyID": 0,
            "CompanyName": null,
            "CurrentSaleAmount": 0,
            "Description": "Групове щаняття №1",
            "Executed": null,
            "ExecutionID": 0,
            "ExecutorID": 3687,
            "ExecutorName": "Коваль С.І.",
            "Finish": "2024-05-29 11:00:00",
            "ID": 272659,
            "IsPaid": false,
            "MaxSaleAmount": 50,
            "PointID": 4384,
            "PointName": "Місце надання 1",
            "ServiceType": 0,
            "Start": "2024-05-29 10:00:00",
            "TarifItemID": 14874,
            "UserName": null,
            "Booked": [
                {
                    "BookedID": 3242,
                    "CardCode": "0165191",
                    "CardID": 62327,
                    "CardItemID": 5199998,
                    "Description": null,
                    "Executed": null,
                    "GroupAssignID": 272709,
                    "IsPaid": false,
                    "UserName": "Бурлака Наталія"
                },
                {
                    "BookedID": 3244,
                    "CardCode": "0258131",
                    "CardID": 147102,
                    "CardItemID": 5197806,
                    "Description": null,
                    "Executed": null,
                    "GroupAssignID": 272709,
                    "IsPaid": false,
                    "UserName": "Проскуровський Артем"
                }
           ],
        }
    ]
}



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
ErrorCode String Код помилки, що виникла
Success Bool Успіх виконання запиту
Assigns Assigns [ ] Масив списку заходів. Елементи масиву з наступними полями:
     | ArticleName String Назва заходу
     | CardID Int ID карти клієнта
     | CardItemID Int ID позиції в кошику користувача
     | CompanyID Int ID компанії
     | 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 Користувач що отримує послугу
     | CardCode String Код карти користувача що отримує послугу
GroupAssigns GroupAssigns [ ] Масив списку заходів. Елементи масиву з наступними полями:
     | ArticleName String Назва заходу
     | CardID Int ID карти клієнта
     | CardItemID Int ID позиції в кошику користувача
     | CompanyID Int ID компанії
     | 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 Імя власника карти
Додатковий опис вхідних параметрів