List Classes

Method : POST

Base URL : https://api.braincert.com

API Endpoint : /v2/listclass?apikey=YOUR_API_KEY_HERE

All requests are POST and sent to https://api.braincert.com/v2/listclass?apikey=YOUR_API_KEY_HERE You will retrieve results assuming you have added your appKey, and require parameter.

Request parameters

ParameterTypeDescriptionExample
formatoptionalResponse data formatxml for XML response, default JSON response
publishedoptionalList published classes only1 for list published classes, default to list all classes
limitstartoptionalStart limit of list classdefault value is 0
limitoptionalLimit of list classdefault value is 10
searchoptionalClass titlestring

Response XML Example

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

Success Response

<xml>
  <total>1</total>
  <classes>
    <class>
      <id>790</id>
      <user_id>43</user_id>
      <title>abcd</title>
      <date>2014-09-24</date>
      <start_time>9:45 PM</start_time>
      <end_time>10:15PM</end_time>
      <timezone>33</timezone>
      <end_date>0000-00-00</end_date>
      <description/>
      <record>0</record>
      <ispaid>0</ispaid>
      <currency>usd</currency>
      <status>Live</status>
      <weekdays>5,6,7</weekdays>
      <duration>1800</duration>
      <language>13</language>
      <seat_attendees>10</seat_attendees>
      <label>India Standard Time</label>
      <privacy>0</privacy>
      <published>1</published>
      <isBoard>0</isBoard>
      <isScreenshare>0</isScreenshare>
      <isCorporate>0</isCorporate>

    </class>
  </classes>
</xml>

Error Response

<rsp status="error">
   <errors> error </errors>
</rsp>

Response JSON Example

https://api.braincert.com/v2/listclass?apikey=WbMlO5sAx1fmV

Success Response

{
  "total":1,
  "classes":[{
    "id":"618",
    "user_id":"43",
    "title":"test-api",
    "date":"2014-09-24",
    "start_time":"9:45 PM",
    "end_time":"10:15PM",
    "timezone":"33",
    "end_date":"0000-00-00",
    "description":"",
    "record":"0",
    "ispaid":"0",
    "currency":"usd",
    "status":"Live",
    "weekdays":"5,6,7",    
    "duration":"3600",
    "seat_attendees":"10",
    "language":"13",
    "label":"India Standard Time",
    "privacy":"0",
    "published":"0"
    "isBoard":"0"
    "isScreenshare":"0"
    "isCorporate":"0"
  }]
}

Error Response

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