edu.ksu.canvas.model.status.CanvasErrorResponse Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

There is a newer version: 2.0.0

package edu.ksu.canvas.model.status;

import java.util.List;

/**
 * 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}
 */
public class CanvasErrorResponse {

    private Long errorReportId;
    private String status;
    private List errors;

    public void setErrorReportId(Long errorReportId) {
        this.errorReportId = errorReportId;
    }

    public Long getErrorReportId() {
        return errorReportId;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public String getStatus() {
        return status;
    }

    public void setErrors(List errors) {
        this.errors = errors;
    }

    public List getErrors() {
        return errors;
    }

    public class ErrorMessage {
        private String message;

        public void setMessage(String message) {
            this.message = message;
        }

        public String getMessage() {
            return message;
        }
    }
}