POST /list_members_classes_schedule
To get the TOTAL COUNT of list of schedules of classes 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": "XXXXX"
},
"filter_define": {
"page_number":1,
"page_size":10,
"only_counted":"Y",
"agents_selection":"",
"classes_selection":"",
"day_no_selection":"",
"start_time_selection":"",
"end_time_selection":"",
"import_code_selection":""
}
}
To get a list of schedules of classes for multiple search criteria.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"page_number":1,
"page_size":10,
"only_counted":"N",
"agents_selection":"",
"classes_selection":"",
"day_no_selection":"",
"start_time_selection":"",
"end_time_selection":"",
"import_code_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 schedules found based on user filter criteria. 'N' = brings the list of the schedules 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 |
| agents_selection |
string |
A comma separated list of 365 agents codes (eg '102,112,02,...'). If the value is empty then no search criteria by 365 agents code is applied. Agents in 365 are equivalent with the teachers for the students. |
| classes_selection |
string |
A comma separated list of 365 classes codes (eg 'BALET,ZUMBA,GYM,...'). If the value is empty then no search criteria by 365 classes code is applied. |
| day_no_selection |
string |
A comma separated list of days as integer numbers from 1 to 7 (eg '5,7,...'). If the value is empty then no search criteria by day no is applied. |
| start_time_selection |
string |
A comma separated list of start times of the classes (eg '10:00,14:30,...'). If the value is empty then no search criteria by start time is applied. |
| end_time_selection |
string |
A comma separated list of end times of the classes (eg '12:00,16:30,...'). If the value is empty then no search criteria by end time is applied. |
| import_code_selection |
string |
A comma separated list of the schedules codes imported from a 3rd party application. If the value is empty then no search criteria by import code is applied. |
Returns
TOTAL COUNT of list of schedules for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list": 143,
"list_classes": null
}
List of schedules for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list": 2,
"list_classes": [
{
"class_code_365": "0000000001",
"class_name": "PRE-SCHOOL A",
"agent_code_365": "01",
"agent_first_name": "PAPAKYRIACOU",
"agent_last_name": "AVGI",
"day_number": 2,
"day_name": "Tuesday",
"start_time": "16:15:00",
"end_time": "16:45:00",
"import_code": ""
},
{
"class_code_365": "0000000001",
"class_name": "PRE-SCHOOL A",
"agent_code_365": "02",
"agent_first_name": "GEORGHIADOU",
"agent_last_name": "PENELOPE",
"day_number": 2,
"day_name": "Tuesday",
"start_time": "16:15:00",
"end_time": "16:45:00",
"import_code": ""
}
]
}