Learner Service
The Learner Service can be a little misleading in that learners don’t technically exist in SCORM Cloud. What we consider a ‘learner’ is simply the personal information about a learner that is on a registration. As such, the methods in this service are actually for acting on the personal information on registrations.
Tagging for learners can allow for SCORM Cloud to group registrations under these learner tags to generate reports based on those tags.
The deleteAllLearnerData method is largely for your convenience if your application
receives a GDPR request.
deleteAllLearnerData
POST /learner/{learnerId}/delete-information
Summary
Deletes all of the information associated with a learner in an application, by learner id. This is meant for use with complying with GDPR requests from learners.
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Path | learnerId | true | String |
| Query | userEmail | true | String |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Operation started to destroy learner’s data | |
| 403 | The initiating email address does not have sufficient privilege in this application to perform this delete operation. | MessageSchema |
| 404 | A learner with the learner id could not be found in the application | MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | admin |
deleteLearnerTags
DELETE /learner/{learnerId}/tags
Summary
Delete the tags for this learner
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Path | learnerId | true | String |
| Body | tags | true | TagListSchema |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Set tags successfully | |
| 400 | Bad request | MessageSchema |
| 404 | learnerId was not found |
MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | write:learner |
getLearnerTags
GET /learner/{learnerId}/tags
Summary
Get the tags for this learner
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Path | learnerId | true | String |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | List of tags for this learner | TagListSchema |
| 400 | Bad request | MessageSchema |
| 404 | learnerId was not found |
MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | read:learner |
putLearnerTags
PUT /learner/{learnerId}/tags
Summary
Set the tags for this learner
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Path | learnerId | true | String |
| Body | tags | true | TagListSchema |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Set tags successfully | |
| 400 | Bad request | MessageSchema |
| 404 | learnerId was not found |
MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | write:learner |
putLearnerTagsBatch
PUT /learner/tags
Summary
Sets all of the provided tags on all of the provided learners
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Body | batch | true | BatchTagsSchema |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Set tags successfully | |
| 400 | Bad request | MessageSchema |
| 404 | learnerId was not found |
MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | write:learner |
updateLearnerInfo
POST /learner/{learnerId}/updateInfo
Summary
A learner in SCORM Cloud is not an entity on its own. In fact,
learners only exist as information on individual registrations.
This method will update the information on each of the registrations
that the provided learnerId is attached to.
You may update any of the values available in the LearnerSchema which is posted. Any values you do not wish to alter, omit from the post. Depending on the field, providing something like an empty string may have unintended consequences.
Lastly, it’s important to note that this method is asynchronous. A success status will be returned, and that signifies that a background process has been spun up to alter the learner’s info. As such, you may find a short period of delay in seeing the changes shown on all registrations.
Parameters
Consumes: application/json
| Type | Name | Required | Schema |
|---|---|---|---|
| Path | learnerId | true | String |
| Body | learnerInfo | true | LearnerSchema |
Responses:
Produces: application/json
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Update job began successfully | |
| 404 | learnerId was not found |
MessageSchema |
Authentication:
| Type | Name | Scopes |
|---|---|---|
| basic | APP_NORMAL | |
| oauth2 | OAUTH | write:learner |