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

ParameterTypeDescriptionExample
class_idrequiredclass id10
isCancelrequiredcancel class- 0 Activate canceled class.
- 1 Cancel one-time or current class in the recurring schedule.
- 2 Cancel all classes in the recurring schedule.
formatoptionalResponse data formatxml for XML response, default JSON response

Response XML Example

https://api.braincert.com/v2/cancelclass?apikey=WbMlO5sAx1fmV&format=xml

Success 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=WbMlO5sAx1fmV

Success Response

[{
   "Status":"ok",
   "method":"cancelclass",
   "class_id":10
}]

Error Response

[{
   "Status":" error ",
   "error":"Invalid API KEY"
}]