Temporary Enrollment Pairings

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

Temporary Enrollment Pairings API

A TemporaryEnrollmentPairing object looks like:

// A pairing unique to that enrollment period given to a recipient of that
// temporary enrollment.
{
  // the ID of the temporary enrollment pairing
  "id": 1,
  // The current status of the temporary enrollment pairing
  "workflow_state": "active"
}

List temporary enrollment pairings

TemporaryEnrollmentPairingsApiController#index

GET /api/v1/accounts/:account_id/temporary_enrollment_pairings

Scope: url:GET|/api/v1/accounts/:account_id/temporary_enrollment_pairings

Returns the list of temporary enrollment pairings for a root account.

Returns a list of TemporaryEnrollmentPairing objects.

Get a single temporary enrollment pairing

TemporaryEnrollmentPairingsApiController#show

GET /api/v1/accounts/:account_id/temporary_enrollment_pairings/:id

Scope: url:GET|/api/v1/accounts/:account_id/temporary_enrollment_pairings/:id

Returns the temporary enrollment pairing with the given id.

Returns a TemporaryEnrollmentPairing object.

New TemporaryEnrollmentPairing

TemporaryEnrollmentPairingsApiController#new

GET /api/v1/accounts/:account_id/temporary_enrollment_pairings/new

Scope: url:GET|/api/v1/accounts/:account_id/temporary_enrollment_pairings/new

Initialize an unsaved Temporary Enrollment Pairing.

Returns a TemporaryEnrollmentPairing object.

Create Temporary Enrollment Pairing

TemporaryEnrollmentPairingsApiController#create

POST /api/v1/accounts/:account_id/temporary_enrollment_pairings

Scope: url:POST|/api/v1/accounts/:account_id/temporary_enrollment_pairings

Create a Temporary Enrollment Pairing.

Request Parameters:

Parameter

Type

Description

workflow_state

string

The workflow state of the temporary enrollment pairing.

ending_enrollment_state

string

The ending enrollment state to be given to each associated enrollment when the enrollment period has been reached. Defaults to “deleted” if no value is given. Accepted values are “deleted”, “completed”, and “inactive”.

Allowed values: deleted, completed, inactive

Returns a TemporaryEnrollmentPairing object.