CanvasUsage

Canvas Usage Domain Service

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/canvas/usage

Version: v1

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/{year_term} GET

canvas_usage

Paths

canvas_usage

GET /{year_term}

Returns the course data for canvas courses

year_term

Year Term of Class

path string #/parameters/year_term

Uses default content-types: application/json

200 OK

The enrolled_courses for the student

Example for application/json
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"canvas_id": "none",
"catalog_number_suffix": "none",
"credit_hours": "3",
"enrolled_hours": "369",
"enrolled_students": "123",
"fixed_or_variable": "F",
"min_credit_hours": "3",
"published": "Y",
"section_number": "none",
"teaching_area": "none",
"year_term": "20175"
},
{
"canvas_id": "20175-CS-236-001",
"catalog_number_suffix": "236",
"credit_hours": "3",
"enrolled_hours": "369",
"enrolled_students": "123",
"fixed_or_variable": "F",
"min_credit_hours": "3",
"published": "Y",
"section_number": "001",
"teaching_area": "C S",
"year_term": "20175"
}
]
}
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"
}
}
}

Parameter definitions

year_term year_term

Year Term of Class

path string

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"
}
}
}
default

Unexpected error

Example for application/json
{
"metadata": {
"validation_response": {
"code": 500,
"message": "Internal Server Error"
}
}
}

Schema definitions

canvas_usage: object

year_term: string

The year_term being queried

canvas_id: string

The unique canvas indetifier with the format (year_term)-(teaching_area)-(catalog_number)(catalog_suffix)-(section_number) without spaces or &.

teaching_area: string

The course teaching area (dept_name)

catalog_number_suffix: string

The catalog_number and catalog_suffix together

section_number: string

The course section number

fixed_or_variable: string

Whether or not the credit hours are fixed or variable credit

credit_hours: string

If fixed credit, the credit hours of the course. If variable credit, the max credit hours of the course.

min_credit_hours: string

If fixed credit, the credit hours of the course. If variable credit, the minimum credit hours of the course.

enrolled_students: string

The number of enrolled students, including students with W grades.

enrolled_hours: string

enrolled_students * credit_hours

published: string

Whether or not the course was published in Canvas

canvas_usages: object[]

StringResponse: string

Service Path: 
/domains/canvas/usage
Domain or University API: 
/domains/canvas/usage

Community

 

Don't see your question listed here? Ask!