CanvasYearTermUsages
Canvas Year Term Usages Domain Service
Base URL: /domains/canvas/year_term_usages
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | year_term_usages |
| /{year_term} | GET | year_term_usage |
Paths
GET /
Returns the canvas usage summary for all published classes in all year terms.
Uses default content-types: application/json
- 200 OK
-
The canvas usage summary for all published classes in all year terms.
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
Example for application/json{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
} - 401 Unauthorized #/responses/401
-
Authentication required to access data
Example for application/json{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
} - 403 Forbidden #/responses/403
-
Access denied to protected data
Example for application/json{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
} - 404 Not Found #/responses/404
-
The resource does not exist
Example for application/json{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
} - 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
Example for application/json{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
GET /{year_term}
Returns the canvas usage summary for all published classes for a specific year term.
| year_term | Year Term of Class | path | string |
Uses default content-types: application/json
- 200 OK
-
The canvas usage summary for all published classes for a specific year term.
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
Example for application/json{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
} - 401 Unauthorized #/responses/401
-
Authentication required to access data
Example for application/json{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
} - 403 Forbidden #/responses/403
-
Access denied to protected data
Example for application/json{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
} - 404 Not Found #/responses/404
-
The resource does not exist
Example for application/json{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
} - 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
Example for application/json{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
Response definitions
- 400
-
Invalid Request - unable to interpret request
Example for application/json{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
} - 401
-
Authentication required to access data
Example for application/json{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
} - 403
-
Access denied to protected data
Example for application/json{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
} - 404
-
The resource does not exist
Example for application/json{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
} - 409
-
Query parameters conflict or are malformed
Example for application/json{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
Schema definitions
- year_term: string
-
- total_classes: number
-
The total number of canvas classes for the year term.
- total_published_classes: number
-
The total number of published canvas classes for the year term.
- total_section_credit_hours: number
-
The total number of enrolled credit hours for the year term.
- total_published_section_credit_hours: number
-
The total number of enrolled credit hours for published classes, for the year term.
