Developer Platform (July 2017)

ePortfolio Reflection

«  ePortfolio Artifacts   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  ePortfolio Learning Objective  »

Contents

Attributes

EP.Reflection

A Reflection EP object’s structure does not differ from the general form of the EpObject, except it has an appropriate EPOBJ_T value for the ObjectTypeId property ("<number:EPOBJ_T:Reflection>").

Description

Note that the description property for Reflection EP objects, unlike other EP objects, is expected by the back end to be lightly marked up with HTML (and not just plain text).

For example. In order to provide two blocks of text in the description, divided as paragraphs, it’s not sufficient to send a string like "This is the first paragraph.\nThis is the second paragraph." Rather, you need to provide <BR> elements, or wrap the text in <P> elements to format the text to provide the line-break: "<p>This is the first paragraph.</p><p>This is the second paragraph." or "This is the first paragraph.<br/>This is the second paragraph."

You should also note that leading white space at the beginning of lines gets removed as part of HTML-formatted text: if you want to include leading space in a line, you must pad with &nbsp; entities.

You should HTML-escape your Reflection description strings when providing them to the service, so that characters like angle-brackets get used “as entered” and do not get stripped out.

Actions

DELETE /d2l/api/eP/(version)/reflection/(objectId)

Delete a reflection.

Parameters:
  • version (D2LVERSION) – API version.
  • objectId (D2LID) – EP object ID for reflection.
Status Codes:
API Versions:
  • 2.5+ – Route first appears in LMS v10.4.0.
  • 2.4-Obsolete as of LMS v10.7.0.
DELETE /d2l/api/eP/(version)/reflection/(reflectionId)/on/(objectId)

Remove the association between a reflection and another EP object.

Parameters:
  • version (D2LVERSION) – API version.
  • reflectionId (D2LID) – EP object ID for reflection.
  • objectId (D2LID) – EP object ID for target object.
Status Codes:
  • 200 OK – Action succeeded.
  • 403 Forbidden – No permission to delete association between reflection and EP object.
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)/reflection/(objectId)

Retrieve a reflection.

Parameters:
  • version (D2LVERSION) – API version.
  • objectId (D2LID) – EP object ID for reflection.
Query Parameters:
 
  • c (boolean) – Optional. If “true”, include all the comments associated with the reflection object.
Status Codes:
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 Reflection JSON data block for the identified reflection.

POST /d2l/api/eP/(version)/reflections/new

Create a new reflection.

Parameters:
JSON Parameters:
 
Status Codes:
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 Reflection JSON data block for the new reflection created.

POST /d2l/api/eP/(version)/reflection/(objectId)

Update an existing reflection.

Parameters:
  • version (D2LVERSION) – API version.
  • objectId (D2LID) – EP object ID for reflection.
JSON Parameters:
 
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 reflection data provided.
  • 403 Forbidden – No permission to update reflection.
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 Reflection JSON data block for the updated reflection.

POST /d2l/api/eP/(version)/reflection/(reflectionId)/on/(objectId)

Associate a reflection with another EP object.

Parameters:
  • version (D2LVERSION) – API version.
  • reflectionId (D2LVERSION) – EP object ID for reflection.
  • objectId (D2LVERSION) – EP object ID for target object.
Status Codes:
  • 200 OK – Action succeeded.
  • 403 Forbidden – No permission to associate reflection with object.
API Versions:
  • 2.5+ – Route first appears in LMS v10.4.0.
  • 2.4-Obsolete as of LMS v10.7.0.

«  ePortfolio Artifacts   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  ePortfolio Learning Objective  »