Cancel Class
Method : POST
Base URL : https://api.braincert.com
API Endpoint : /v2/cancelclass?apikey=YOUR_API_KEY_HERE
All requests are POST
and sent to https://api.braincert.com/v2/cancelclass?apikey=YOUR_API_KEY_HERE You will retrieve results assuming you have added your appKey, and require parameter.
Request parameters
Parameter | Type | Description | Example |
class_id | required | class id | 10 |
isCancel | required | cancel class | - 0 Activate canceled class. - 1 Cancel one-time or current class in the recurring schedule. - 2 Cancel all classes in the recurring schedule. |
format | optional | Response data format | xml for XML response, default JSON response |
Response XML Example
https://api.braincert.com/v2/cancelclass?apikey=WbMlO5sAx1fmV&format=xmlSuccess Response
<rsp status="ok">
<method>cancelclass</method>
<class_id>10</class_id>
</rsp>
Error Response
<rsp status="error">
<method>cancelclass</method>
<message>error message</message >
</rsp>
Response JSON Example
https://api.braincert.com/v2/cancelclass?apikey=WbMlO5sAx1fmVSuccess Response
[{
"Status":"ok",
"method":"cancelclass",
"class_id":10
}]
Error Response
[{
"Status":" error ",
"error":"Invalid API KEY"
}]