Invitations Service

API V2 reference

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

createPrivateInvitation

POST /invitations/private

Summary

Create a private invitation to a course. The provided information will be used to create new registrations for all of the provided e-mail addresses, and send asynchronously send e-mails to those addresses inviting them to the course. To check the status of this process, a subsequent call to /invitations/private/{invitationId}/status must be made.

Parameters

Consumes: application/json

Type Name Required Schema
Body privateInvitationRequest true CreatePrivateInvitationSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 Information about the newly created invitation. InvitationSummarySchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation
write




createPublicInvitation

POST /invitations/public

Summary

Create a publicly accessible invitation to a course.

Parameters

Consumes: application/json

Type Name Required Schema
Body publicInvitationRequest true CreatePublicInvitationSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 A representation of the newly created invitation. PublicInvitationSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation
write




deleteInvitationTags

DELETE /invitations/{invitationId}/tags

Summary

Delete the tags for this invitation

Parameters

Consumes: application/json

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

Responses:

Produces: application/json

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

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation




getAllInvitations

GET /invitations

Summary

Get a summary of all the invitations for an appId, both public and private.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId String
Query since Date
Query until Date
Query datetimeFilter String
Query tags List
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of invitation summaries. InvitationSummaryList
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getInvitationTags

GET /invitations/{invitationId}/tags

Summary

Get the tags for this invitation

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String

Responses:

Produces: application/json

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

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation




getPrivateInvitation

GET /invitations/private/{invitationId}

Summary

Get a information about a private invitation.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Query includeRegistrationCount Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Information about a private invitation. PrivateInvitationSchema
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPrivateInvitationJobStatus

GET /invitations/private/{invitationId}/jobStatus

Summary

Get the status of a job to send out private invitations.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 Status of the invitation job. InvitationJobStatusSchema
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPrivateInvitations

GET /invitations/private

Summary

Retrieves a list of all private invitations, optionally filtered by the given parameters.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId String
Query since Date
Query until Date
Query datetimeFilter String
Query tags List
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of private invitations. PrivateInvitationList
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPrivateUserInvitations

GET /invitations/private/{invitationId}/userInvitations

Summary

Get a list of objects which contain the specific information about each user to whom this invitation was sent.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Query since Date
Query until Date
Query includeRegistrationReport Boolean
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of user invitations. UserInvitationList
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPublicInvitation

GET /invitations/public/{invitationId}

Summary

Get a information about a public invitation.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Query includeRegistrationCount Boolean

Responses:

Produces: application/json

HTTP Code Description Schema
200 Information about a public invitation. PublicInvitationSchema
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPublicInvitations

GET /invitations/public

Summary

Retrieves a list of all public invitations, optionally filtered by the given parameters.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId String
Query since Date
Query until Date
Query datetimeFilter String
Query tags List
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of public invitations. PublicInvitationList
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




getPublicUserInvitations

GET /invitations/public/{invitationId}/userInvitations

Summary

Get a list of objects which contain the specific information about each user who visited the invitation link.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Query since Date
Query until Date
Query includeRegistrationReport Boolean
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of user invitations. UserInvitationList
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read:invitation
read




putInvitationTags

PUT /invitations/{invitationId}/tags

Summary

Set the tags for this invitation

Parameters

Consumes: application/json

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

Responses:

Produces: application/json

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

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation




putInvitationTagsBatch

PUT /invitations/tags

Summary

Sets all of the provided tags on all of the provided invitations

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

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation




updatePrivateInvitation

PUT /invitations/private/{invitationId}

Summary

Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - invitationEmail - postBack - expirationDate NOTE: Any attributes not in the above list will not be considered for update.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Body invitationUpdateSchema true PrivateInvitationSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 Representation of the updated invitation. PrivateInvitationSchema
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation
write




updatePublicInvitation

PUT /invitations/public/{invitationId}

Summary

Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - allowNewRegistrations - postBack - expirationDate - registrationCap NOTE: Any attributes not in the above list will not be considered for update.

Parameters

Consumes: application/json

Type Name Required Schema
Path invitationId true String
Body invitationUpdateSchema true PublicInvitationSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 New state of the updated invitation. PublicInvitationSchema
400 Bad request MessageSchema
404 invitationId was not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:invitation
write