Registration Service

API V2 reference

This page applies to SCORM Cloud API V2. If you're looking for our V1 api reference see here

Registration Service


This service provides calls for creating and removing registrations, and getting links for launching existing registrations.


buildRegistrationLaunchLink

POST /registrations/{registrationId}/launchLink

Summary

Returns the link to use to launch this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Body launchLinkRequest true LaunchLinkRequestSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 The link to launch the registration LaunchLinkSchema
400 Bad request, redirectOnExitUrl is not a valid url, expiry is out of range, or other invalid query parameter MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




createNewRegistrationInstance

POST /registrations/{registrationId}/instances

Summary

Create a new instance for this registration specified by the registration ID.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Created registration instance successfully
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




createRegistration

POST /registrations

Summary

This method is used to create a new registration. A registration will contain a few pieces of information such as a learner name, a learner id, and optionally, information about where activity data should be posted (for client consumption), as well as a way to specify simple authentication schemes for posting said data. A registration must be tied to a specific course at creation time. When the created registration is “launched”, the course specified at creation time will be launched.

Parameters

Consumes: application/json

Type Name Required Schema
Body registration true CreateRegistrationSchema
Query courseVersion false Integer

Responses:

Produces: application/json

HTTP Code Description Schema
204 Request succeeded
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




deleteRegistration

DELETE /registrations/{registrationId}

Summary

Delete registrationId. This includes all instances of this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Registration successfully deleted
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:registration
delete




deleteRegistrationConfigurationSetting

DELETE /registrations/{registrationId}/configuration/{settingId}

Summary

Clears the settingId value for this registration. The effective value will become the value at the next level which has an explicit value set. Possibilities are course, application, or default.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path settingId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Cleared setting successfully
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




deleteRegistrationGlobalData

DELETE /registrations/{registrationId}/globalData

Summary

Delete global data associated with registrationId’. Calling this method will reset all global objectives associated with this registration, if any exist.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:registration
delete




deleteRegistrationInstanceConfigurationSetting

DELETE /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}

Summary

Clears the settingId value for this registration instance.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Path settingId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Cleared setting successfully
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




deleteRegistrationProgress

DELETE /registrations/{registrationId}/progress

Summary

This method will reset the specified registration. This is essentially the same as deleting and recreating the registration, and as such, will delete all the data associated with the registration (including launch history, etc.). If the course for which the registration is registered has multiple versions, the registration being reset will automatically be registered for the latest version.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:registration
delete




deleteRegistrationTags

DELETE /registrations/{registrationId}/tags

Summary

Delete the provided tags for this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




getRegistration

HEAD /registrations/{registrationId}

Summary

This method is meant to check if a registration with registrationId exists in the system.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 Registration exists
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationConfiguration

GET /registrations/{registrationId}/configuration

Summary

Returns all configuration settings for this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Query includeMetadata false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Configuration settings for this registration SettingListSchema
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationInstanceConfiguration

GET /registrations/{registrationId}/instances/{instanceId}/configuration

Summary

Returns all configuration settings for this registration instance.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Query includeMetadata false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Configuration settings for this registration SettingListSchema
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationInstanceLaunchHistory

GET /registrations/{registrationId}/instances/{instanceId}/launchHistory

Summary

Returns history of the launches of the specified instance of this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Query includeHistoryLog false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 The launch history LaunchHistoryListSchema
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationInstanceProgress

GET /registrations/{registrationId}/instances/{instanceId}

Summary

Get registration progress for instance instanceId of registrationId

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Query includeChildResults false Boolean
Query includeInteractionsAndObjectives false Boolean
Query includeRuntime false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Registration instance progress RegistrationSchema
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationInstanceStatements

GET /registrations/{registrationId}/instances/{instanceId}/xAPIStatements

Summary

Get xAPI statements for instance instanceId of registrationId.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Query since false Date
Query until false Date
Query more false String

Responses:

Produces: application/json

HTTP Code Description Schema
200 Registration instance statements XapiStatementResult
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationInstances

GET /registrations/{registrationId}/instances

Summary

Get all the instances of this the registration specified by the registration ID

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Query until false Date
Query since false Date
Query more false String
Query includeChildResults false Boolean
Query includeInteractionsAndObjectives false Boolean
Query includeRuntime false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 List of registration instances RegistrationListSchema
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationLaunchHistory

GET /registrations/{registrationId}/launchHistory

Summary

Returns history of this registration’s launches.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Query includeHistoryLog false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 The launch history LaunchHistoryListSchema
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationProgress

GET /registrations/{registrationId}

Summary

Get detailed information about the latest instance of registrationId. Additional detail may be obtained by using the optional query parameters.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Query includeChildResults false Boolean
Query includeInteractionsAndObjectives false Boolean
Query includeRuntime false Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Registration Progress RegistrationSchema
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationStatements

GET /registrations/{registrationId}/xAPIStatements

Summary

Get xAPI statements for registrationId.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Query since false Date
Query until false Date
Query more false String

Responses:

Produces: application/json

HTTP Code Description Schema
200 Registration statements XapiStatementResult
400 Bad request MessageSchema
404 registrationId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrationTags

GET /registrations/{registrationId}/tags

Summary

Get a list of the tags applied to this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 List of tags for this registration TagListSchema
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




getRegistrations

GET /registrations

Summary

Gets a list of registrations including a summary of the status of each registration.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId false String
Query learnerId false String
Query since false Date
Query until false Date
Query more false String
Query includeChildResults false Boolean
Query includeInteractionsAndObjectives false Boolean
Query includeRuntime false Boolean
Query tags false ListList

Responses:

Produces: application/json

HTTP Code Description Schema
200 List of registrations RegistrationListSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:registration




putRegistrationTags

PUT /registrations/{registrationId}/tags

Summary

Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




putRegistrationTagsBatch

PUT /registrations/tags

Summary

Sets all of the provided tags on all of the provided registrations.

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 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




setRegistrationConfiguration

POST /registrations/{registrationId}/configuration

Summary

Set configuration settings for this registration.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Body configurationSettings true SettingsPostSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




setRegistrationInstanceConfiguration

POST /registrations/{registrationId}/instances/{instanceId}/configuration

Summary

Set configuration settings for this registration instance.

Parameters

Consumes: application/json

Type Name Required Schema
Path registrationId true String
Path instanceId true Integer
Body configurationSettings true SettingsPostSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 registrationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration




testRegistrationPostback

POST /registrations/postBackTest

Summary

This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.

Parameters

Consumes: application/json

Type Name Required Schema
Body postBack true PostBackSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Postback successfully sent
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write
write:registration