Skip to main content

Errors

HTTP Response Codes​

By default the API returns a HTTP StatusCode of 200 for all successfully authenticated requests, even if they otherwise result in an error due to validation of payload or a school-side problem.

To receive detailed HTTP error response codes, add the following parameter to your API calls as an additional URL parameter:

httpstatuscodes=true

For example, the call below returns a 400 response because it does not pass required parameters:

https://xporter.groupcall.com/api/v1/School/3281102/assessmentresults/?httpstatuscodes=true

Along with the following response object:

{
  "Message": "Error",
  "ExceptionType": "Exception",
  "ExceptionMessage": "Error Unable to fetch XodAssessmentResults Job (EmergeXod3281102-Data) Failed|EGCSqlException:(EPSException) At least 1 Student, 1 Aspect or 1 ResultSet required",
  "InnerException": null
}

A successful request:

https://xporter.groupcall.com/api/v1/School/3281102/assessmentresults/?Aspects=11&httpsstatuscodes=true