POST /list_members_classes
To get the TOTAL COUNT of list of classes assigned to each student 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":"",
"students_selection":"",
"start_date_selection":"",
"end_date_selection":"",
"student_status":"all",
"examination_date_selection":"",
"examination_grade_selection":"",
"examination_status":"all"
}
}
To get a list of classes assigned to each student for multiple search criteria.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"page_number":1,
"page_size":10,
"only_counted":"N",
"agents_selection":"",
"classes_selection":"",
"students_selection":"",
"start_date_selection":"",
"end_date_selection":"",
"student_status":"all",
"examination_date_selection":"",
"examination_grade_selection":"",
"examination_status":"all"
}
}
| 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. |
| students_selection |
string |
A comma separated list of 365 customer codes (eg '100014,0010003,...'). If the value is empty then no search criteria by student is applied. |
| start_date_selection |
string |
A comma separated list of start dates of the classes (eg '2017-01-15,2017-05-10,...'). If the value is empty then no search criteria by start date is applied. |
| end_date_selection |
string |
A comma separated list of end dates of the classes (eg '2017-01-15,2017-05-10,...'). If the value is empty then no search criteria by end date is applied. |
| student_status |
string |
'all' = all students, 'enrolled' - only enrolled students, 'onwaitlist' - only students on wait list |
| examination_date_selection |
string |
A comma separated list of examination dates (eg '2017-01-15,2017-05-10,...'). If the value is empty then no search criteria by examination date is applied. |
| examination_grade_selection |
string |
A comma separated list of examination grades (eg '10.00,25.50,...'). If the value is empty then no search criteria by examination grade is applied. |
| examination_status |
string |
'all' = all students, 'failed' - only students with failed examination, 'passed' - only students with passed examination, 'notexamined' - only students not examined |
Returns
TOTAL COUNT of list of classes assigned for each student 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 classes assigned for each student for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list": 2,
"list_classes": [
{
"member_code_365": "00100003",
"member_name": "ANA S.",
"class_code_365": "0000000009",
"class_name": "GRADE 1B",
"agent_code_365": "01",
"agent_first_name": "PAPAKYRIACOU",
"agent_last_name": "AVGI",
"start_date": "2014-09-15",
"end_date": "",
"student_status": "enrolled",
"examination_date": "",
"examination_grade": 0,
"examination_status": "notexamined"
},
{
"member_code_365": "00100448",
"member_name": "OLGA KARJANEVSKAIA",
"class_code_365": "0000000044",
"class_name": "ZUMBA MYRTO",
"agent_code_365": "09",
"agent_first_name": "CHRYSOSTOMOU",
"agent_last_name": "AGA",
"start_date": "2011-09-12",
"end_date": "",
"student_status": "enrolled",
"examination_date": "",
"examination_grade": 0,
"examination_status": "notexamined"
}
]
}