Developer Platform (July 2017)

ePortfolio Learning Objective

«  ePortfolio Reflection   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  ePortfolio Collections  »

Contents

Attributes

EP.LearningObjective

A Learning Objective 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:LearningObjective>").

Actions

DELETE /d2l/api/eP/(version)/learningobjective/(objectiveId)/association/(objectId)

Remove association between a learning objective and an associated EP object.

Parameters:
  • version (D2LVERSION) – API version.
  • objectiveId (D2LID) – EP object ID for learning objective.
  • objectId (D2LID) – EP object ID for associated object.
Status Codes:
  • 200 OK – Action succeeded.
  • 400 Bad Request – Unable to retrieve learning objective, or unable to retrieve EP object, or unable to remove the association between the two.
  • 403 Forbidden – No permission to delete association.
  • 404 Not Found – Learning objective not found, or association to EP object not found.
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)/learningobjective/(objectiveId)

Delete a learning objective.

Parameters:
  • version (D2LVERSION) – API version.
  • objectiveId (D2LID) – EP object ID for learning objective.
Status Codes:
  • 200 OK – Action succeeded.
  • 400 Bad Request – EP object is not a learning objective, or unable to retrieve the learning objective.
  • 403 Forbidden – No permission to delete learning objective.
  • 404 Not Found – Learning objective not found.
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)/learningobjective/(objectiveId)

Retrieve a learning objective.

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

POST /d2l/api/eP/(version)/learningobjective/(objectiveId)

Update an existing learning objective.

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

POST /d2l/api/eP/(version)/learningobjective/(objectiveId)/association/(objectId)

Create an association between a learning objective and another EP object.

Parameters:
  • version (D2LVERSION) – API version.
  • objectiveId (D2LID) – EP object ID for learning objective.
  • objectId (D2LID) – EP object ID for associated object.
Status Codes:
  • 200 OK – Action succeeded.
  • 400 Bad Request – Unable to retrieve learning objective, or unable to retrieve EP object, or unable to create association between the two.
  • 403 Forbidden – No permission to create association.
  • 404 Not Found – Learning objective not found, or EP object not found.
API Versions:
  • 2.5+ – Route first appears in LMS v10.4.0.
  • 2.4-Obsolete as of LMS v10.7.0.

«  ePortfolio Reflection   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  ePortfolio Collections  »