list_table_settings
POST /list_table_settings
To get the TOTAL COUNT of list of tables settings for multiple search criteria.
Use this method with only_counted = 'Y' FIRST to determine how many total records there are for the given criteria.
After you call this method with only_counted = 'Y', then call again this method with only_counted = 'N', and pass the required paging parameters.
{
"api_credentials": {
"token": "XXX"
},
"filter_define": {
"page_number": 1,
"page_size": 100,
"only_counted": "Y",
"store_selection": "",
"station_selection": ""
}
}
To get a list of tables settings for multiple search criteria.
{
"api_credentials": {
"token": "XXX"
},
"filter_define": {
"page_number": 1,
"page_size": 100,
"only_counted": "N",
"store_selection": "",
"station_selection": ""
}
}
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| filter_define
|
| only_counted |
string |
'Y' = brings only the total of tables settings found based on user filter criteria. 'N' = brings the list of the tables settings found based on user filter criteria |
| page_number |
integer |
The page number in the entire list. eg Page 1. |
| page_size |
integer |
The number of rows to return. eg 10 rows |
| store_selection |
string |
A comma separated list of 365 stores codes (eg '001,100,...'). If the value is empty then no search criteria by store code is applied. |
| station_selection |
string |
A comma separated list of 365 stations codes (eg '1001,0001,...'). If the value is empty then no search criteria by station code is applied. |
Returns
TOTAL COUNT of list of tables settings for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_table_settings": 3,
"list_table_settings": null
}
List of tables settings for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_table_settings": 3,
"list_table_settings": [
{
"store_code_365": "002",
"store_name": "STORE02",
"station_code_365": "0025",
"station_name": "POS 25 CRISTINA COMP",
"compartment_name": "VIP",
"display_starting_number_from": 101,
"compartment_order": 1,
"number_tables": 5,
"compartment_free_colour": "SpringGreen",
"compartment_load_colour": "Maroon",
"compartment_prebill_colour": "OrangeRed"
},
{
"store_code_365": "002",
"store_name": "STORE02",
"station_code_365": "0025",
"station_name": "POS 25 CRISTINA COMP",
"compartment_name": "GROUND",
"display_starting_number_from": 201,
"compartment_order": 2,
"number_tables": 10,
"compartment_free_colour": "AntiqueWhite",
"compartment_load_colour": "DeepPink",
"compartment_prebill_colour": "Purple"
},
{
"store_code_365": "002",
"store_name": "STORE02",
"station_code_365": "0025",
"station_name": "POS 25 CRISTINA COMP",
"compartment_name": "FLOOR 1",
"display_starting_number_from": 301,
"compartment_order": 3,
"number_tables": 15,
"compartment_free_colour": "DarkOliveGreen",
"compartment_load_colour": "Crimson",
"compartment_prebill_colour": "Purple"
}
]
}