Attributes¶

EP.Presentation¶

A Presentation EP object’s structure differs in three ways from the general form of the EpObject data block:

• Its ObjectTypeId property will be set to the appropriate EPOBJ_T value (”<number:EPOBJ_T:Presentation>”).

• When you use actions that create a new presentation, two additional properties appear in the object’s data block:

  {
      "BannerTitle": <string>,
      "BannerDescription": <string>
  }
  

• When you use actions that fetch a presentation, two additional properties appear in the object’s data block:

  {
      "BannerTitle": <string>,
      "BannerDescription": <string>
  }
  

Actions¶

DELETE /d2l/api/eP/(version)/presentation/(objectId)¶

Delete a particular presentation.

Parameters:

• version (D2LVERSION) – API version.

• objectId (D2LID) – EP object ID.

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to delete the presentation.

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

API Versions:

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

• 2.4- – Obsolete as of LMS v10.7.0.

GET /d2l/api/eP/(version)/presentation/(objectId)¶

Retrieve a particular presentation.

Parameters:

• version (D2LVERSION) – API version.

• objectId (D2LID) – EP object ID.

Query Parameters:

• c (boolean) – Optional. If “true”, include comments attached to the presentation.

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to see artifact.

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

API Versions:

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

• 2.4- – Obsolete as of LMS v10.7.0.

Return. This action retrieves a Presentation JSON data block.

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

Create a new presentation.

Parameters:

• version (D2LVERSION) – API version.

JSON Parameters:

• Presentation – Data for new presentation.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid presentation data provided.

• 403 Forbidden – No permission to create presentation.

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

API Versions:

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

• 2.4- – Obsolete as of LMS v10.7.0.

Return. This action returns a Presentation JSON data block, in the Fetch form, for the newly created presentation.

POST /d2l/api/eP/(version)/presentation/(objectId)¶

Update an existing presentation.

Parameters:

• version (D2LVERSION) – API version.

• objectId (D2LID) – EP object ID.

JSON Parameters:

• Presentation – Updated data for presentation.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Mismatch between EP object ID in route and ObjectId property in the provided JSON data, or invalid presentation data provided.

• 403 Forbidden – No permission to update presentation.

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

API Versions:

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

• 2.4- – Obsolete as of LMS v10.7.0.

Return. This action returns a Presentation JSON data block for the updated presentation.