Create Registration Schema

API V2 reference

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



Name Required Description Schema
courseId true String
learner true LearnerSchema
registrationId true String
xapiRegistrationId false The xapiRegistrationId to be associated with this registration. If not specified, the system will assign an xapiRegistrationId. As per the xApi specification, this must be a UUID. String
learnerTags false ListString
courseTags false ListString
registrationTags false ListString
postBack false Specifies an optional override URL for which to post activity and status data in real time as the course is completed. By default all of these settings are read from your configuration. PostBackSchema
initialRegistrationState false RegistrationSchema
initialSettings false SettingsPostSchema