Attributes¶

EP.Invite¶

{
    "InviteId": <number:D2LID>,
    "ObjectId": <number:D2LID>,
    "Subject": <string>,
    "Message": <string>,
    "SentDate": <string>,
    "SenderUserId": <number:D2LID>,
    "TargetUserId": <number:D2LID>,
    "InviteType": "Invite",
    "IsRead": <boolean>
}

Action¶

GET /d2l/api/eP/(version)/invites/¶

Retrieve a list of all invites.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• unreadOnly (boolean) – Optional. If “true”, retrieve only unread invites; if not present or “false”, retrieve all invites, read and unread.

Status Codes:

• 200 OK – Action succeeded.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 2.5+ – Route first appears in EP v10.4.0.

• 2.4- – Obsolete as of EP 10.7.0.

Return. This action returns a paged result set containing all the resulting Invite JSON data blocks in a single page.

POST /d2l/api/eP/(version)/invites/delete¶

Delete a particular list of invites.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• ids (CSV) – Invite IDs to delete.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Badly formatted list of invite IDs.

• 403 Forbidden – No permission to delete invites.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 2.5+ – Route first appears in EP v10.4.0.

• 2.4- – Obsolete as of EP 10.7.0.

POST /d2l/api/eP/(version)/invites/new¶

Send an invite for a particular EP object.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• objectId (D2LID) – EP object to invite to.

• subject (string) – Subject for the invitation message.

• message (string) – Message body for the invitation message.

• profileIds (CSV) – EP sharing profile IDs to invite.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid query parameter data provided.

• 403 Forbidden – No permission to send invitation.

• 404 Not Found – Identified EP object not found.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 2.5+ – Route first appears in EP v10.4.0.

• 2.4- – Obsolete as of EP 10.7.0.

POST /d2l/api/eP/(version)/invites/status¶

Sets the read status for a set of invites.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• ids (D2LID) – List of invites for which to adjust the read status.

• read (boolean) – Boolean value. If “true”, mark all identified invites as read; if “false”, mark all identified invites as unread.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Badly formatted list of invite IDs.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 2.5+ – Route first appears in EP v10.4.0.

• 2.4- – Obsolete as of EP 10.7.0.