Public Invitation Schema

API V2 reference

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

PublicInvitationSchema

Fields

Name Required Description Schema
id false The invitationId for this invitation. String
courseId false Course Id for this Invitation. String
allowLaunch false If true, then new registrations can be created for this dispatch. Boolean
allowNewRegistrations false If true, then new registrations can be created for this dispatch. Boolean
url false The launch URL for the invitation String
createDate false The create date for the invitation Date
updated false Date
postBack false Specifies a URL for which to post activity and status data in real time as the course is completed PostBackSchema
expirationDate false The date this invitation will expire and can not be launched (formatted yyyyMMddHHmmss in UTC time). Date
registrationCap false Integer value that limits the amount of registrations a public invitation can generate. Integer
registrationCount false The count of registrations for this invitation Integer