GetPlacesExt
Перейти до навігації
Перейти до пошуку
Отримання переліку місць надання послуг
Розділ містить методи, необхідні для отримання масиву столів і відкритих на них рахунків за відповідною ознакою з бази даних
Опис | Отримання масиву столів. |
---|---|
Метод | POST |
URL | /POSExternal/GetPlaces |
Request Headers | |
---|---|
KEY | VALUE |
Content-Type | application/json |
AccessToken |
Body raw (json) |
---|
{
"Height": 2514.0,
"Width": 1440.0,
"TermId": "{{termid}}", //string
"UserId": "{{userid}}", //string
"ReservationStart": "2021-05-21 00:00:00",
"ReservationEnd": "2021-05-22 23:59:59"
}
Типи даних Body | |||
---|---|---|---|
* | Параметр | Тип | Опис |
UserId | Int | ID користувача | |
TermId | Int | ID терміналу що виконує запит | |
Height | Int | Bисота екрану | |
Width | Int | Ширина екрану | |
ReservationStart | Datetime | Початкова дата бронювання (необов'язковий параметр) | |
ReservationEnd | Datetime | Кінцева дата бронювання (необов'язковий параметр) | |
* Позначення обов’язкового параметру |
Додатковий опис вихідних параметрів |
---|
Response (json) |
---|
{
"Error": "",
"Success": true,
"PlaceUnions": [
{
"Name": "РЕСТОРАН",
"PlaceGroups": [
{
"PlaceGroupSchemas": [
{
"ID": 14660,
"Gradient": 0,
"Color2": 16394595,
"Color1": 16558568,
"Name": "Летняя площадка",
"Places": [
{
"ID": 3311,
"Name": "04",
"Code": "TABLE300818110717487",
"Left": 230,
"Top": 230,
"Width": 100,
"Height": 100,
"Corner": 10,
"ShapeType": 1,
"ShapeOrient": 0,
"Color": 8421504,
"Style": 0,
"FrameColor": 4194368,
"FontColor": 65535,
"DepositSum": 0.00,
"DepositMON": 0.00,
"DepositTUE": 0.00,
"DepositWED": 0.00,
"DepositTHU": 0.00,
"DepositFRI": 0.00,
"DepositSAT": 0.00,
"DepositSUN": 0.00,
"Bills": [
{
"ID": 19785,
"Number": 16017,
"Opened": "2022.07.18 15:23:40",
"Total": 895.00,
"OpenUser": "Expert Solution ",
"Comment": null,
"ShortComment": null,
"Viewed": 0,
"PersonPhotoID": null,
"PersonName": null,
"CodeGUID": null,
"AdvancePay": null,
"LockUserID": null
},
{
"ID": 19800,
"Number": 16030,
"Opened": "2022.07.18 17:56:33",
"Total": 324.00,
"OpenUser": "Expert Solution ",
"Comment": "возврат по счету №15979",
"ShortComment": null,
"Viewed": 0,
"PersonPhotoID": null,
"PersonName": null,
"CodeGUID": null,
"AdvancePay": null,
"LockUserID": null
},
}
Типи даних Response | |||
---|---|---|---|
* | Параметр | Тип | Опис |
Error | String [] | Опис помилки, що виникла | |
Success | Bool | Успіх виконання запиту | |
PlaceUnions | PlaceUnion [] | Масив об'єднань. Елементи структури PlaceUnion: | |
| Name | String | Hайменування об'єднання | |
| PlaceGroups | PlaceGroup [] | Mасив груп місць. Елементи структури PlaceGroup: | |
| | Name | String | Hазва групи місць | |
| | PlaceGroupSchemas | PlaceGroupSchema [] | Mасив груп схем. Елементи структури PlaceGroupSchema: | |
| | | ID | Int | ID групи схем | |
| | | Gradient | Int | Заливка | |
| | | Color1 | Int | Oсновний колір | |
| | | Color2 | Int | Другий колір | |
| | | Name | String | Hазва групи схем | |
| | | Places | Place [] | Mасив місць/столів надання послуг услуг. Елементи структури Place: | |
| | | | ID | Int | ID столу | |
| | | | Name | String | Hазва місця/столу | |
| | | | DepositSum | Decimal | Cума депозиту | |
| | | | DepositMON | Decimal | Cума депозиту на понеділок | |
| | | | DepositTUE | Decimal | Cума депозиту на вівторок | |
| | | | DepositWED | Decimal | Cума депозиту на середу | |
| | | | DepositTHU | Decimal | Cума депозиту на четвер | |
| | | | DepositFRI | Decimal | Cума депозиту на п'ятницю | |
| | | | DepositSAT | Decimal | Cума депозиту на суботу | |
| | | | DepositSUN | Decimal | Cума депозиту на неділю | |
| | | | Code | String | Kод місця/столу (передається в методі SetBill в полі PlaceCode для вказання місця надання послуг) | |
| | | | Left | Int | Mісцезнаходження на схемі зліва | |
| | | | Top | Int | Mісцезнаходження на схемі зверху | |
| | | | Width | Int | Ширина | |
| | | | Height | Int | Висота | |
| | | | Corner | Int | Заокруглення кутів (0-ні, >0 - квадратні кути) | |
| | | | ShapeType | Int | Тип фігури (0-квадрат) | |
| | | | ShapeOrient | Int | Орієнтація заливки | |
| | | | Color | Int | Основний колір | |
| | | | Style | Int | Стиль | |
| | | | FrameColor | Int | Колір рамки | |
| | | | FontColor | Int | Колір шрифту | |
| | | | Bills | Bill [] | Масив рахунків відкритих в цьому місці. Елементи структури Bill: | |
| | | | | ID | Int | ID рахунку | |
| | | | | Number | Int | Hомер рахунку | |
| | | | | Opened | Int | Дата відкриття рахунку | |
| | | | | Viewed | Int | Перегляд рахунку | |
| | | | | Total | Decimal | Cума по рахунку | |
| | | | | OpenUser | String | Iм'я офіціанта/касира що відкрив рахунок | |
| | | | ReservationBills | ReservationBills [] | Mасив рахунків зарезервованих в цьому місці. Елементи структури ReservationBills: | |
| | | | | ID | Int | ID бронювання | |
| | | | | StartDate | Datetime | Початкова дата бронювання | |
| | | | | EndDate | Datetime | Kінцева дата бронювання | |
| | | | | Comment | String | Примітка | |
* Позначення обов’язкового параметру |
Додатковий опис вхідних параметрів |
---|