Attributes¶

TIMEOP_T¶

Quizzing time limit accommodations allow for modifying a user’s quiz attempt time limit using different mathematical operations.

Time Limit Operation	Value
Multiply	1
AddExtra	2

Accommodations.UserAccommodations¶

All of a specific user’s accommodations for a specific org unit.

{
  "OrgUnitId": <number:D2LID>,
  "UserId": <number:D2LID>,
  "QuizzingAccommodations": { <composite:Accommodations.QuizzingAccommodations> }
}

Accommodations.QuizzingAccommodations¶

All of a user’s accommodations in the quizzing tool.

{
  "QuizzingControlAccommodation": { <composite:Accommodations.QuizzingControlAccommodation> },
  "QuizzingTimeLimitAccommodation": { <composite:Accommodations.QuizzingTimeLimitAccommodation> }
}

Accommodations.QuizzingControlAccommodation¶

An accommodation that allows a user to use the mouse right click during quiz attempts, even when it would normally be disabled.

{
  "AlwaysAllowRightClick": <boolean>
}

Accommodations.QuizzingTimeLimitAccommodation¶

An accommodation that modifies a user’s quiz attempt time limits.

{
  "TimeLimitOperation": <number:TIMEOP_T>,
  "TimeMultiplier": <number:decimal>,
  "AdditionalTime": <number:integer>
}

Actions¶

GET /d2l/api/le/(version)/accommodations/(orgUnitId)/users/(userId)¶

Retrieve a user’s accommodations in an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID

• userId (D2LID) – User ID.

Oauth2 Scopes:

accommodations:profile:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to see accommodations.

• 404 Not Found – No enrolled user found.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns a User Accommodations JSON data block representing the user’s accommodations profile in the specified org unit.

GET /d2l/api/le/(version)/accommodations/(orgUnitId)/myaccommodations¶

Retrieve the user’s accommodations in an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID

Oauth2 Scopes:

accommodations:profile:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to see accommodations.

• 404 Not Found – User not enrolled in orgunit.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns a User Accommodations JSON data block representing the user’s accommodations profile in the specified org unit.

PUT /d2l/api/le/(version)/accommodations/¶

Update a user’s accommodations in an org unit.

Parameters:

• version (D2LVERSION) – API version.

Oauth2 Scopes:

accommodations:profile:manage

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to manage accommodations.

• 404 Not Found – No enrolled user found.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. This action requires a UserAccommodations JSON data block as its input body, including the user ID and org unit ID, representing the user’s accommodations profile in the specified org unit.

Note that your provided block’s data replaces all the associated user’s accommodations data for the org unit on the service.

Return. This action returns a UserAccommodations JSON data block containing the updated accommodations profile for a user in the org unit.