Enrollments

List enrollments

get

Authorizations

AuthorizationstringRequired

Query parameters

listing_idintegerOptional

Only include enrollments for the specified listing

Responses

200

enrollments listed

application/json

get/api/v1/enrollments

GET /api/v1/enrollments HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

enrollments listed

{
  "enrollments": [
    {
      "id": 1,
      "user": {
        "id": 1
      },
      "listing": {
        "id": 1,
        "title": "text",
        "type": "text",
        "canvas_course_id": 1
      },
      "enrolled_at": "text",
      "status": "text",
      "requirement_details": {
        "requirement_count": 1,
        "requirement_completed_count": 1,
        "requirement_completed_percentage": 1
      }
    }
  ]
}

Create an enrollment

post

Authorizations

AuthorizationstringRequired

Query parameters

create_orderbooleanOptional

Create an order record for this enrollment (default: true)

send_emailbooleanOptional

Send an enrollment email to the user (default: true)

Body

Responses

201

enrollment created

application/json

post/api/v1/enrollments

POST /api/v1/enrollments HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "enrollment": {
    "listing_id": 1,
    "canvas_user_id": 1
  }
}

201

enrollment created

{
  "enrollment": {
    "id": 1,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1
    },
    "enrolled_at": "text",
    "status": "text",
    "requirement_details": {
      "requirement_count": 1,
      "requirement_completed_count": 1,
      "requirement_completed_percentage": 1
    }
  }
}

Get a specific enrollment

get

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Identifier for this enrollment

Responses

200

enrollment found

application/json

get/api/v1/enrollments/{id}

GET /api/v1/enrollments/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

enrollment found

{
  "enrollment": {
    "id": 1,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1
    },
    "enrolled_at": "text",
    "status": "text",
    "requirement_details": {
      "requirement_count": 1,
      "requirement_completed_count": 1,
      "requirement_completed_percentage": 1
    }
  }
}

Delete an enrollment

delete

An additional request must be made to Canvas to delete the enrollment and remove it from the Catalog Student Dashboard.

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Identifier for this enrollment

Responses

204

enrollment deleted

No content

delete/api/v1/enrollments/{id}

DELETE /api/v1/enrollments/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

204

enrollment deleted

No content