edu.ksu.canvas.model.status

Class CanvasErrorResponse

java.lang.Object

edu.ksu.canvas.model.status.CanvasErrorResponse

public class CanvasErrorResponse
extends Object

Class to represent JSON error messages returned by Canvas.

For some errors, Canvas returns JSON error strings that can be parsed and displayed to the user. There isn't much documentation on exactly how these messages are structured but here is an example of something that is returned (along with an HTTP 400 in this case) if a student tries to submit answers to a quiz that they are not authorized to participate in:

{"status":"bad_request","message":"you are not allowed to participate in this quiz","error_report_id":9005006}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CanvasErrorResponse.ErrorMessage

Constructor Summary

Constructors

Constructor and Description
CanvasErrorResponse()

Method Summary

Modifier and Type	Method and Description
Long	getErrorReportId()
List<CanvasErrorResponse.ErrorMessage>	getErrors()
String	getStatus()
void	setErrorReportId(Long errorReportId)
void	setErrors(List<CanvasErrorResponse.ErrorMessage> errors)
void	setStatus(String status)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CanvasErrorResponse

public CanvasErrorResponse()

Method Detail

setErrorReportId

public void setErrorReportId(Long errorReportId)

getErrorReportId

public Long getErrorReportId()

setStatus

public void setStatus(String status)

getStatus

public String getStatus()

setErrors

public void setErrors(List<CanvasErrorResponse.ErrorMessage> errors)

getErrors

public List<CanvasErrorResponse.ErrorMessage> getErrors()