list_classes
GET /list_classes
To get the TOTAL COUNT of the list of classes for students.
Use this method FIRST to determine how many total records there are for the given criteria.
After you call this method, then call the method below, and pass the required paging parameters.
/list_classes?token=XXXXX&active_type=all
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active classes. 'inactive' = Only the inactive classes. 'all' = All the classes(active and inactive) |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_classes": 2
}
GET /list_classes
To get a list of classes for students.
/list_classes?token=XXXXX&active_type=all&page_number=1&page_size=10
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
| active_type |
'active' = Only the active classes. 'inactive' = Only the inactive classes. 'all' = All the classes(active and inactive) |
| page_number |
The page number in the entire list. eg Page 1 |
| page_size |
The number of rows to return. eg 10 rows |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_classes": [
{
"pk_MemberClassID": 136,
"class_code_365": "0000000001",
"class_name": "PRE-SCHOOL A",
"class_category_code_365": "01",
"class_category_name": "DANCE",
"class_secondary_code": "0000000001",
"class_colour_html": "#FFFFFF",
"number_seats": 16,
"active": true
},
{
"pk_MemberClassID": 137,
"class_code_365": "0000000002",
"class_name": "PRE-SCHOOL B",
"class_category_code_365": "01",
"class_category_name": "DANCE",
"class_secondary_code": "0000000002",
"class_colour_html": "#FFFFFF",
"number_seats": 20,
"active": true
}
]
}