API V2 Reference beta

Description

In addition to api v2 reference documentation below, you can also make use of the interactive api reference.

Security

APP_MANAGEMENT (HTTP Basic Authentication)

APP_NORMAL (HTTP Basic Authentication)

LAUNCH_TOKEN (API Key)

Name: launchToken

Located in: query

OAUTH (OAuth 2.0)

Flow: application

Token URL: https://cloud.scorm.com/api/v2/oauth/authenticate/application/token

Scopes

Scope Description
admin Grants read, write, and account management access
delete Grants deletion access
delete:appmgmt Grants deletion access to app management methods
delete:course Grants deletion access to course methods
delete:dispatch Grants deletion access to dispatch methods
delete:invitation Grants deletion access to invitation methods
delete:registration Grants deletion access to registration methods
delete:xapicredential Grants deletion access to xapi credential methods
delete:xapipipe Grants deletion access to xapi pipe methods
read Grants read access
read:appmgmt Grants read access to app management methods
read:course Grants read access to course methods
read:dispatch Grants read access to dispatch methods
read:invitation Grants read access to invitation methods
read:ping Grants read access to the ping method
read:registration Grants read access to registration methods
read:reporting Grants read access to reporting methods
read:xapicredential Grants read access to xapi credential methods
read:xapipipe Grants read access to xapi pipe methods
write Grants write access
write:appmgmt Grants write access to app management methods
write:course Grants write access to course methods
write:dispatch Grants write access to dispatch methods
write:invitation Grants write access to invitation methods
write:registration Grants write access to registration methods
write:xapicredential Grants write access to xapi credential methods
write:xapipipe Grants write access to xapi pipe methods

URL_TOKEN (API Key)

Name: authtoken

Located in: query

APPLICATION MANAGEMENT

PUT /appManagement/applications/{applicationName}

Summary

Create a new application

Parameters

Name Located in Required Type Format Properties Description
applicationName path Yes string      

Request

Responses

200

Success

Type: ApplicationSchema

Example:

{
    "id": "somestring",
    "name": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write:appmgmt

POST /appManagement/{childAppId}/credentials

Summary

Create credential

Parameters

Name Located in Required Type Format Properties Description
childAppId path Yes string      

Request

Body
Name Required Type Format Properties Description
active No boolean     A flag denoting if the key is available for use.
name No string     name for this credential
{
    "active": true,
    "name": "somestring"
}

Responses

200

Information about the created credential

Type: CredentialCreatedSchema

Example:

{
    "credential": "somestring",
    "id": "somestring",
    "name": "somestring",
    "pensCredential": "somestring",
    "status": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write:appmgmt

POST /appManagement/token

Summary

Create token

Description

Creates, signs and returns a token based on the provided permissions, if the credentials used to request the token have the permissions being requested. Note: the token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.

Request

Body
Name Required Type Format Properties Description
expiry Yes string date-time   Expiration of the token. This should not be set far in the future, as there is no way to invalidate an individual token.
permissions Yes PermissionsSchema      
{
    "expiry": "2015-01-01T15:00:00.000Z",
    "permissions": {
        "applicationName": "somestring",
        "scopes": [
            "somestring",
            "somestring"
        ]
    }
}

Responses

200

The token

Type: StringResultSchema

Example:

{
    "result": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  

DELETE /appManagement/applications/{childAppId}

Summary

Delete an application. If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.

Parameters

Name Located in Required Type Format Properties Description
childAppId path Yes string      

Request

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}
409

Content still exists in application.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete:appmgmt

DELETE /appManagement/{childAppId}/credentials/{credentialId}

Summary

Removes credentialId credentials

Parameters

Name Located in Required Type Format Properties Description
childAppId path Yes string      
credentialId path Yes string      

Request

Responses

204

Deleted credential successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

credentialId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete:appmgmt

GET /appManagement/configuration

Summary

Returns all configuration settings for this level

Parameters

Name Located in Required Type Format Properties Description
learningStandard query No string   {“enum”: [“SCORM_11”, “SCORM_12”, “SCORM_2004_2ND_EDITION”, “SCORM_2004_3RD_EDITION”, “SCORM_2004_4TH_EDITION”, “AICC”, “XAPI”, “CMI5”]} If specified, the request will be scoped to the provided learning standard.
singleSco query No boolean     Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
includeMetadata query No boolean      

Request

Responses

200

List of configuration settings for this level

Type: SettingListSchema

Example:

{
    "settingItems": [
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        },
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read:appmgmt

GET /appManagement/applications

Summary

Get list of all applications in this realm.

Request

Responses

200

List of applications

Type: ApplicationListSchema

Example:

{
    "applications": [
        {
            "id": "somestring",
            "name": "somestring"
        },
        {
            "id": "somestring",
            "name": "somestring"
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read:appmgmt

GET /appManagement/{childAppId}/credentials

Summary

List of credentials

Parameters

Name Located in Required Type Format Properties Description
childAppId path Yes string      

Request

Responses

200

List of credentials for this application

Type: CredentialListSchema

Example:

{
    "credentials": [
        {
            "credential": "somestring",
            "id": "somestring",
            "name": "somestring",
            "pensCredential": "somestring",
            "status": "somestring"
        },
        {
            "credential": "somestring",
            "id": "somestring",
            "name": "somestring",
            "pensCredential": "somestring",
            "status": "somestring"
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read:appmgmt

POST /appManagement/configuration

Summary

Set configuration settings for this level.

Parameters

Name Located in Required Type Format Properties Description
learningStandard query No string   {“enum”: [“SCORM_11”, “SCORM_12”, “SCORM_2004_2ND_EDITION”, “SCORM_2004_3RD_EDITION”, “SCORM_2004_4TH_EDITION”, “AICC”, “XAPI”, “CMI5”]} If specified, the request will be scoped to the provided learning standard.
singleSco query No boolean     Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.

Request

Body
Name Required Type Format Properties Description
settings No array of SettingsIndividualSchema      
{
    "settings": [
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        },
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        }
    ]
}

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write:appmgmt

PUT /appManagement/{childAppId}/credentials/{credentialId}

Summary

Update the name or status associated with credentialId

Parameters

Name Located in Required Type Format Properties Description
childAppId path Yes string      
credentialId path Yes string      

Request

Body
Name Required Type Format Properties Description
active No boolean     A flag denoting if the key is available for use.
name No string     name for this credential
{
    "active": true,
    "name": "somestring"
}

Responses

204

Updated credential successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
401

Not authorized to make this request.

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

credentialId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write:appmgmt

AUTHENTICATION

POST /oauth/authenticate/application/token

Summary

Authenticates for a oauth token

Parameters

Name Located in Required Type Format Properties Description
scope formData Yes string      
expiration formData No integer int32 {“default”: 300, “maximum”: 43200, “minimum”: 60}  

Request

Responses

200

Successful token authentication request

Type: ApplicationToken

Example:

{
    "access_token": "somestring",
    "expires_in": 1,
    "token_type": "somestring"
}

COURSE

POST /courses/{courseId}/preview

Summary

Returns the launch link to use to preview this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
cssUrl query No string      

Request

Body
Name Required Type Format Properties Description
additionalvalues No array of ItemValuePairSchema      
courseTags No array of string      
cssUrl No string     A Url pointing to custom css for the player to use.
culture No string     This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used.
expiry No integer int32 {‘default’: 120} Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s
learnerTags No array of string      
redirectOnExitUrl No string     The URL the application should redirect to when the learner exits a course. If not specified, configured value will be used.
registrationTags No array of string      
startSco No string     For SCORM, SCO identifier to override launch, overriding the normal sequencing.
tracking No boolean   {‘default’: True} Should this launch be tracked? If false, Engine will avoid tracking to the extent possible for the standard being used.
{
    "additionalvalues": [
        {
            "item": "somestring",
            "value": "somestring"
        },
        {
            "item": "somestring",
            "value": "somestring"
        }
    ],
    "courseTags": [
        "somestring",
        "somestring"
    ],
    "cssUrl": "somestring",
    "culture": "somestring",
    "expiry": 120,
    "learnerTags": [
        "somestring",
        "somestring"
    ],
    "redirectOnExitUrl": "somestring",
    "registrationTags": [
        "somestring",
        "somestring"
    ],
    "startSco": "somestring",
    "tracking": true
}

Responses

200

Type: LaunchLinkSchema

Example:

{
    "launchLink": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

POST /courses/{courseId}/versions/{versionId}/preview

Summary

Returns the link to use to preview this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version

Request

Body
Name Required Type Format Properties Description
additionalvalues No array of ItemValuePairSchema      
courseTags No array of string      
cssUrl No string     A Url pointing to custom css for the player to use.
culture No string     This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used.
expiry No integer int32 {‘default’: 120} Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s
learnerTags No array of string      
redirectOnExitUrl No string     The URL the application should redirect to when the learner exits a course. If not specified, configured value will be used.
registrationTags No array of string      
startSco No string     For SCORM, SCO identifier to override launch, overriding the normal sequencing.
tracking No boolean   {‘default’: True} Should this launch be tracked? If false, Engine will avoid tracking to the extent possible for the standard being used.
{
    "additionalvalues": [
        {
            "item": "somestring",
            "value": "somestring"
        },
        {
            "item": "somestring",
            "value": "somestring"
        }
    ],
    "courseTags": [
        "somestring",
        "somestring"
    ],
    "cssUrl": "somestring",
    "culture": "somestring",
    "expiry": 120,
    "learnerTags": [
        "somestring",
        "somestring"
    ],
    "redirectOnExitUrl": "somestring",
    "registrationTags": [
        "somestring",
        "somestring"
    ],
    "startSco": "somestring",
    "tracking": true
}

Responses

200

The preview launch link for this version

Type: LaunchLinkSchema

Example:

{
    "launchLink": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

POST /courses/importJobs

Summary

Start a job to fetch and import a course.

Description

An import job will be started to fetch and import the referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided."

Parameters

Name Located in Required Type Format Properties Description
courseId query Yes string     A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
mayCreateNewVersion query No boolean     Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn’t already exist.
postbackUrl query No string     An optional parameter that specifies a URL to send a postback to when the course has finished uploading.

Request

Body

Request to import a course by downloading it from a url

Name Required Type Format Properties Description
url Yes string     URL path to the .zip package to download to import this course
{
    "url": "somestring"
}

Responses

200

ID of the created import job

Type: StringResultSchema

Example:

{
    "result": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
409

conflict, courseId exists and mayCreateNewVersion is false

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

POST /courses/importJobs/upload

Summary

Upload a course and start an import job for it.

Description

An import job will be started to import the posted file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.

Parameters

Name Located in Required Type Format Properties Description
courseId query Yes string     A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
mayCreateNewVersion query No boolean     Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn’t already exist.
file formData No file     The zip file of the course contents to import.
postbackUrl query No string     An optional parameter that specifies a URL to send a postback to when the course has finished uploading.

Request

Responses

200

ID of the created import job

Type: StringResultSchema

Example:

{
    "result": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
409

conflict, courseId exists and mayCreateNewVersion is false

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

DELETE /courses/{courseId}

Summary

Delete courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId, version not found

Type: ResponseError

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete, delete:course

DELETE /courses/{courseId}/configuration/{settingId}

Summary

Clears the settingId value for this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
settingId path Yes string      

Request

Responses

204

Cleared setting successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

DELETE /courses/{courseId}/tags

Summary

Delete tags for this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Body
Name Required Type Format Properties Description
tags No array of string      
{
    "tags": [
        "somestring",
        "somestring"
    ]
}

Responses

204

Set tags successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

DELETE /courses/{courseId}/versions/{versionId}

Summary

Delete version versionId of courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version

Request

Responses

204
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId version versionId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete, delete:course

DELETE /courses/{courseId}/versions/{versionId}/configuration/{settingId}

Summary

Clears the settingId value for this course and version.

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version
settingId path Yes string      

Request

Responses

204

Cleared setting successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

GET /courses/{courseId}

Summary

Get information about courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
includeRegistrationCount query No boolean     Include the registration count in the results
includeCourseMetadata query No boolean     Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.

Request

Responses

200

Type: CourseSchema

Example:

{
    "activityId": "somestring",
    "courseLearningStandard": "UNKNOWN",
    "created": "2015-01-01T15:00:00.000Z",
    "dispatched": true,
    "id": "somestring",
    "metadata": {
        "description": "somestring",
        "descriptionLanguage": "somestring",
        "duration": "somestring",
        "keywords": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "titleLanguage": "somestring",
        "typicaltime": "somestring"
    },
    "registrationCount": 1,
    "rootActivity": {
        "activityType": "UNKNOWN",
        "children": [
            {},
            {}
        ],
        "externalIdentifier": "somestring",
        "href": "somestring",
        "itemIdentifier": "somestring",
        "resourceIdentifier": "somestring",
        "scaledPassingScore": "somestring",
        "title": "somestring"
    },
    "tags": [
        "somestring",
        "somestring"
    ],
    "title": "somestring",
    "updated": "2015-01-01T15:00:00.000Z",
    "version": 1,
    "xapiActivityId": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/configuration

Summary

Returns all configuration settings for this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
includeMetadata query No boolean      

Request

Responses

200

Type: SettingListSchema

Example:

{
    "settingItems": [
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        },
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/xAPIStatements

Summary

Get xAPI statements for courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
learnerId query No string     Only entries for the specified learner id will be included.
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Request

Responses

200

Course statements

Type: XapiStatementResult

Example:

{
    "more": "somestring",
    "statements": [
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        },
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/tags

Summary

Get the tags for this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Responses

200

List of tags for this course

Type: TagListSchema

Example:

{
    "tags": [
        "somestring",
        "somestring"
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/versions/{versionId}/configuration

Summary

Returns all configuration settings for this course and version.

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version
includeMetadata query No boolean      

Request

Responses

200

Type: SettingListSchema

Example:

{
    "settingItems": [
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        },
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/versions/{versionId}

Summary

Get version versionId of courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version
includeRegistrationCount query No boolean     Include the registration count in the results
includeCourseMetadata query No boolean     Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.

Request

Responses

200

Type: CourseSchema

Example:

{
    "activityId": "somestring",
    "courseLearningStandard": "UNKNOWN",
    "created": "2015-01-01T15:00:00.000Z",
    "dispatched": true,
    "id": "somestring",
    "metadata": {
        "description": "somestring",
        "descriptionLanguage": "somestring",
        "duration": "somestring",
        "keywords": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "titleLanguage": "somestring",
        "typicaltime": "somestring"
    },
    "registrationCount": 1,
    "rootActivity": {
        "activityType": "UNKNOWN",
        "children": [
            {},
            {}
        ],
        "externalIdentifier": "somestring",
        "href": "somestring",
        "itemIdentifier": "somestring",
        "resourceIdentifier": "somestring",
        "scaledPassingScore": "somestring",
        "title": "somestring"
    },
    "tags": [
        "somestring",
        "somestring"
    ],
    "title": "somestring",
    "updated": "2015-01-01T15:00:00.000Z",
    "version": 1,
    "xapiActivityId": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId version versionId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/versions/{versionId}/xAPIStatements

Summary

Get xAPI statements for version versionId of courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version
learnerId query No string     Only entries for the specified learner id will be included.
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Request

Responses

200

Course version statements

Type: XapiStatementResult

Example:

{
    "more": "somestring",
    "statements": [
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        },
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/{courseId}/versions

Summary

Get all versions of courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
includeRegistrationCount query No boolean     Include the registration count in the results
includeCourseMetadata query No boolean     Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.

Request

Responses

200

Type: CourseListNonPagedSchema

Example:

{
    "courses": [
        {
            "activityId": "somestring",
            "courseLearningStandard": "UNKNOWN",
            "created": "2015-01-01T15:00:00.000Z",
            "dispatched": true,
            "id": "somestring",
            "metadata": {
                "description": "somestring",
                "descriptionLanguage": "somestring",
                "duration": "somestring",
                "keywords": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "titleLanguage": "somestring",
                "typicaltime": "somestring"
            },
            "registrationCount": 1,
            "rootActivity": {
                "activityType": "UNKNOWN",
                "children": [
                    {},
                    {}
                ],
                "externalIdentifier": "somestring",
                "href": "somestring",
                "itemIdentifier": "somestring",
                "resourceIdentifier": "somestring",
                "scaledPassingScore": "somestring",
                "title": "somestring"
            },
            "tags": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "updated": "2015-01-01T15:00:00.000Z",
            "version": 1,
            "xapiActivityId": "somestring"
        },
        {
            "activityId": "somestring",
            "courseLearningStandard": "UNKNOWN",
            "created": "2015-01-01T15:00:00.000Z",
            "dispatched": true,
            "id": "somestring",
            "metadata": {
                "description": "somestring",
                "descriptionLanguage": "somestring",
                "duration": "somestring",
                "keywords": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "titleLanguage": "somestring",
                "typicaltime": "somestring"
            },
            "registrationCount": 1,
            "rootActivity": {
                "activityType": "UNKNOWN",
                "children": [
                    {},
                    {}
                ],
                "externalIdentifier": "somestring",
                "href": "somestring",
                "itemIdentifier": "somestring",
                "resourceIdentifier": "somestring",
                "scaledPassingScore": "somestring",
                "title": "somestring"
            },
            "tags": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "updated": "2015-01-01T15:00:00.000Z",
            "version": 1,
            "xapiActivityId": "somestring"
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses

Summary

Get all courses for appId

Parameters

Name Located in Required Type Format Properties Description
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
filter query No string     Optional string which filters results by a specified field (described by filterBy).
filterBy query No string   {“enum”: [“title”, “course_id”, “tags”]} Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
orderBy query No string   {“enum”: [“title_asc”, “title_desc”, “creation_date_asc”, “creation_date_desc”]} Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc.
includeRegistrationCount query No boolean     Include the registration count in the results
includeCourseMetadata query No boolean     Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
tags query No array of string      

Request

Responses

200

Type: CourseListSchema

Example:

{
    "courses": [
        {
            "activityId": "somestring",
            "courseLearningStandard": "UNKNOWN",
            "created": "2015-01-01T15:00:00.000Z",
            "dispatched": true,
            "id": "somestring",
            "metadata": {
                "description": "somestring",
                "descriptionLanguage": "somestring",
                "duration": "somestring",
                "keywords": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "titleLanguage": "somestring",
                "typicaltime": "somestring"
            },
            "registrationCount": 1,
            "rootActivity": {
                "activityType": "UNKNOWN",
                "children": [
                    {},
                    {}
                ],
                "externalIdentifier": "somestring",
                "href": "somestring",
                "itemIdentifier": "somestring",
                "resourceIdentifier": "somestring",
                "scaledPassingScore": "somestring",
                "title": "somestring"
            },
            "tags": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "updated": "2015-01-01T15:00:00.000Z",
            "version": 1,
            "xapiActivityId": "somestring"
        },
        {
            "activityId": "somestring",
            "courseLearningStandard": "UNKNOWN",
            "created": "2015-01-01T15:00:00.000Z",
            "dispatched": true,
            "id": "somestring",
            "metadata": {
                "description": "somestring",
                "descriptionLanguage": "somestring",
                "duration": "somestring",
                "keywords": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "titleLanguage": "somestring",
                "typicaltime": "somestring"
            },
            "registrationCount": 1,
            "rootActivity": {
                "activityType": "UNKNOWN",
                "children": [
                    {},
                    {}
                ],
                "externalIdentifier": "somestring",
                "href": "somestring",
                "itemIdentifier": "somestring",
                "resourceIdentifier": "somestring",
                "scaledPassingScore": "somestring",
                "title": "somestring"
            },
            "tags": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "updated": "2015-01-01T15:00:00.000Z",
            "version": 1,
            "xapiActivityId": "somestring"
        }
    ],
    "more": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

GET /courses/importJobs/{importJobId}

Summary

Check the status of an import job.

Parameters

Name Located in Required Type Format Properties Description
importJobId path Yes string     Id received when the import job was submitted to the importJobs resource.

Request

Responses

200

Type: ImportJobResultSchema

Example:

{
    "importResult": {
        "course": {
            "activityId": "somestring",
            "courseLearningStandard": "UNKNOWN",
            "created": "2015-01-01T15:00:00.000Z",
            "dispatched": true,
            "id": "somestring",
            "metadata": {
                "description": "somestring",
                "descriptionLanguage": "somestring",
                "duration": "somestring",
                "keywords": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "titleLanguage": "somestring",
                "typicaltime": "somestring"
            },
            "registrationCount": 1,
            "rootActivity": {
                "activityType": "UNKNOWN",
                "children": [
                    {},
                    {}
                ],
                "externalIdentifier": "somestring",
                "href": "somestring",
                "itemIdentifier": "somestring",
                "resourceIdentifier": "somestring",
                "scaledPassingScore": "somestring",
                "title": "somestring"
            },
            "tags": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "updated": "2015-01-01T15:00:00.000Z",
            "version": 1,
            "xapiActivityId": "somestring"
        },
        "courseLanguages": [
            "somestring",
            "somestring"
        ],
        "parserWarnings": [
            "somestring",
            "somestring"
        ],
        "webPathToCourse": "somestring"
    },
    "jobId": "somestring",
    "message": "somestring",
    "status": "RUNNING"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

importJobId not found

Type: ResponseError

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:course

PUT /courses/{courseId}/tags

Summary

Set the tags for this course

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Body
Name Required Type Format Properties Description
tags No array of string      
{
    "tags": [
        "somestring",
        "somestring"
    ]
}

Responses

204

Set tags successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

PUT /courses/tags

Summary

Sets all of the provided tags on all of the provided courses

Request

Body
Name Required Type Format Properties Description
courseIds Yes array of string      
tags Yes array of string      
{
    "courseIds": [
        "somestring",
        "somestring"
    ],
    "tags": [
        "somestring",
        "somestring"
    ]
}

Responses

204

Set tags successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

POST /courses/{courseId}/configuration

Summary

Set configuration settings for this course.

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Body
Name Required Type Format Properties Description
settings No array of SettingsIndividualSchema      
{
    "settings": [
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        },
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        }
    ]
}

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

PUT /courses/{courseId}/title

Summary

Sets the course title for courseId

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      

Request

Body
Name Required Type Format Properties Description
title No string      
{
    "title": "somestring"
}

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

POST /courses/{courseId}/versions/{versionId}/configuration

Summary

Set configuration settings for this course and version.

Parameters

Name Located in Required Type Format Properties Description
courseId path Yes string      
versionId path Yes integer int32   The course version

Request

Body
Name Required Type Format Properties Description
settings No array of SettingsIndividualSchema      
{
    "settings": [
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        },
        {
            "explicit": true,
            "settingId": "somestring",
            "value": "somestring"
        }
    ]
}

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

courseId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:course

PING

GET /ping

Summary

Get back a message indicating that the API is working.

Request

Responses

200

pong response

Type: PingSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:ping

REGISTRATION

POST /registrations/{registrationId}/instances

Summary

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

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Responses

204

Created registration instance successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:registration

POST /registrations

Summary

Create a registration.

Parameters

Name Located in Required Type Format Properties Description
courseVersion query No integer int32   The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.

Request

Body
Name Required Type Format Properties Description
courseId Yes string      
courseTags No array of string      
initialRegistrationState No RegistrationSchema      
initialSettings No SettingsPostSchema      
learner Yes LearnerSchema      
learnerTags No array of string      
postBack No PostBackSchema     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.
registrationId Yes string      
registrationTags No array of string      
xapiRegistrationId No string     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.
{
    "courseId": "somestring",
    "courseTags": [
        "somestring",
        "somestring"
    ],
    "initialRegistrationState": {
        "activityDetails": {
            "activityCompletion": "UNKNOWN",
            "activitySuccess": "UNKNOWN",
            "attempts": 1,
            "children": [
                {},
                {}
            ],
            "completionAmount": {
                "scaled": 1
            },
            "id": "somestring",
            "objectives": [
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                },
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                }
            ],
            "runtime": {
                "completionStatus": "somestring",
                "credit": "somestring",
                "entry": "somestring",
                "exit": "somestring",
                "learnerComments": [
                    {
                        "dateTime": "somestring",
                        "location": "somestring",
                        "value": "somestring"
                    },
                    {
                        "dateTime": "somestring",
                        "location": "somestring",
                        "value": "somestring"
                    }
                ],
                "learnerPreference": {
                    "audioCaptioning": 1,
                    "audioLevel": 1,
                    "deliverySpeed": 1,
                    "language": "somestring"
                },
                "lmsComments": [
                    {
                        "dateTime": "somestring",
                        "location": "somestring",
                        "value": "somestring"
                    },
                    {
                        "dateTime": "somestring",
                        "location": "somestring",
                        "value": "somestring"
                    }
                ],
                "location": "somestring",
                "mode": "somestring",
                "progressMeasure": "somestring",
                "runtimeInteractions": [
                    {
                        "correctResponses": [
                            "somestring",
                            "somestring"
                        ],
                        "description": "somestring",
                        "id": "somestring",
                        "latency": "somestring",
                        "learnerResponse": "somestring",
                        "objectives": [
                            "somestring",
                            "somestring"
                        ],
                        "result": "somestring",
                        "timestamp": "somestring",
                        "timestampUtc": "somestring",
                        "type": "TrueFalse",
                        "weighting": "somestring"
                    },
                    {
                        "correctResponses": [
                            "somestring",
                            "somestring"
                        ],
                        "description": "somestring",
                        "id": "somestring",
                        "latency": "somestring",
                        "learnerResponse": "somestring",
                        "objectives": [
                            "somestring",
                            "somestring"
                        ],
                        "result": "somestring",
                        "timestamp": "somestring",
                        "timestampUtc": "somestring",
                        "type": "TrueFalse",
                        "weighting": "somestring"
                    }
                ],
                "runtimeObjectives": [
                    {
                        "description": "somestring",
                        "id": "somestring",
                        "progressMeasure": "somestring",
                        "runtimeObjectiveCompletionStatus": "UNKNOWN",
                        "runtimeObjectiveSuccessStatus": "UNKNOWN",
                        "scoreMax": "somestring",
                        "scoreMin": "somestring",
                        "scoreRaw": "somestring",
                        "scoreScaled": "somestring"
                    },
                    {
                        "description": "somestring",
                        "id": "somestring",
                        "progressMeasure": "somestring",
                        "runtimeObjectiveCompletionStatus": "UNKNOWN",
                        "runtimeObjectiveSuccessStatus": "UNKNOWN",
                        "scoreMax": "somestring",
                        "scoreMin": "somestring",
                        "scoreRaw": "somestring",
                        "scoreScaled": "somestring"
                    }
                ],
                "runtimeSuccessStatus": "UNKNOWN",
                "scoreMax": "somestring",
                "scoreMin": "somestring",
                "scoreRaw": "somestring",
                "scoreScaled": "somestring",
                "suspendData": "somestring",
                "timeTracked": "somestring",
                "totalTime": "somestring"
            },
            "score": {
                "scaled": 1
            },
            "staticProperties": {
                "completionThreshold": "somestring",
                "launchData": "somestring",
                "maxTimeAllowed": "somestring",
                "scaledPassingScore": 1,
                "scaledPassingScoreUsed": true,
                "timeLimitAction": "somestring"
            },
            "suspended": true,
            "timeTracked": "somestring",
            "title": "somestring"
        },
        "completedDate": "2015-01-01T15:00:00.000Z",
        "course": {
            "id": "somestring",
            "title": "somestring",
            "version": 1
        },
        "createdDate": "2015-01-01T15:00:00.000Z",
        "dispatchId": "somestring",
        "firstAccessDate": "2015-01-01T15:00:00.000Z",
        "globalObjectives": [
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            },
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            }
        ],
        "id": "somestring",
        "instance": 1,
        "lastAccessDate": "2015-01-01T15:00:00.000Z",
        "learner": {
            "email": "somestring",
            "firstName": "somestring",
            "id": "somestring",
            "lastName": "somestring"
        },
        "registrationCompletion": "UNKNOWN",
        "registrationCompletionAmount": 1,
        "registrationSuccess": "UNKNOWN",
        "score": {
            "scaled": 1
        },
        "sharedData": [
            {
                "id": "somestring",
                "value": "somestring"
            },
            {
                "id": "somestring",
                "value": "somestring"
            }
        ],
        "suspendedActivityId": "somestring",
        "totalSecondsTracked": 1,
        "updated": "2015-01-01T15:00:00.000Z",
        "xapiRegistrationId": "somestring"
    },
    "initialSettings": {
        "settings": [
            {
                "explicit": true,
                "settingId": "somestring",
                "value": "somestring"
            },
            {
                "explicit": true,
                "settingId": "somestring",
                "value": "somestring"
            }
        ]
    },
    "learner": {
        "email": "somestring",
        "firstName": "somestring",
        "id": "somestring",
        "lastName": "somestring"
    },
    "learnerTags": [
        "somestring",
        "somestring"
    ],
    "postBack": {
        "authType": "UNDEFINED",
        "password": "somestring",
        "resultsFormat": "COURSE",
        "url": "somestring",
        "userName": "somestring"
    },
    "registrationId": "somestring",
    "registrationTags": [
        "somestring",
        "somestring"
    ],
    "xapiRegistrationId": "somestring"
}

Responses

204

Request succeeded

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:registration

DELETE /registrations/{registrationId}

Summary

Delete registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Responses

204

Registration successfully deleted

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete, delete:registration

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

Summary

Clears the settingId value for this registration

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
settingId path Yes string      

Request

Responses

204

Cleared setting successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:registration

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

Summary

Clears the settingId value for this registration instance

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
instanceId path Yes integer int32   The instance of this registration
settingId path Yes string      

Request

Responses

204

Cleared setting successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:registration

DELETE /registrations/{registrationId}/progress

Summary

Delete registration progress (clear registration)

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete, delete:registration

DELETE /registrations/{registrationId}/tags

Summary

Delete tags for this registration

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Body
Name Required Type Format Properties Description
tags No array of string      
{
    "tags": [
        "somestring",
        "somestring"
    ]
}

Responses

204

Set tags successfully

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH write, write:registration

DELETE /registrations/{registrationId}/globalData

Summary

Delete global data associated with registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Responses

204

Success

400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH delete, delete:registration

GET /registrations/{registrationId}/configuration

Summary

Returns all configuration settings for this registration

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
includeMetadata query No boolean      

Request

Responses

200

Configuration settings for this registration

Type: SettingListSchema

Example:

{
    "settingItems": [
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        },
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

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

Summary

Returns all configuration settings for this registration instance

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
instanceId path Yes integer int32   The instance of this registration
includeMetadata query No boolean      

Request

Responses

200

Configuration settings for this registration

Type: SettingListSchema

Example:

{
    "settingItems": [
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        },
        {
            "effectiveValue": "somestring",
            "effectiveValueSource": "default",
            "explicitValue": "somestring",
            "id": "somestring",
            "metadata": {
                "dataType": "somestring",
                "default": "somestring",
                "fallback": "somestring",
                "learningStandardVariant": "either",
                "learningStandards": [
                    "somestring",
                    "somestring"
                ],
                "level": "somestring",
                "settingDescription": "somestring",
                "validValues": [
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    },
                    {
                        "value": "somestring",
                        "valueDescription": "somestring"
                    }
                ]
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId was not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

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

Summary

Returns history of this registration’s launches

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
instanceId path Yes integer int32   The instance of this registration
includeHistoryLog query No boolean     Whether to include the history log in the launch history

Request

Responses

200

The launch history

Type: LaunchHistoryListSchema

Example:

{
    "launchHistory": [
        {
            "completionStatus": "UNKNOWN",
            "exitTime": "2015-01-01T15:00:00.000Z",
            "historyLog": "somestring",
            "id": "somestring",
            "instance": 1,
            "lastRuntimeUpdate": "2015-01-01T15:00:00.000Z",
            "launchTime": "2015-01-01T15:00:00.000Z",
            "score": {
                "scaled": 1
            },
            "successStatus": "UNKNOWN",
            "totalSecondsTracked": 1
        },
        {
            "completionStatus": "UNKNOWN",
            "exitTime": "2015-01-01T15:00:00.000Z",
            "historyLog": "somestring",
            "id": "somestring",
            "instance": 1,
            "lastRuntimeUpdate": "2015-01-01T15:00:00.000Z",
            "launchTime": "2015-01-01T15:00:00.000Z",
            "score": {
                "scaled": 1
            },
            "successStatus": "UNKNOWN",
            "totalSecondsTracked": 1
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

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

Summary

Get registration progress for instance instanceId of registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
instanceId path Yes integer int32   The instance of this registration
includeChildResults query No boolean     Include information about each learning object, not just the top level in the results
includeInteractionsAndObjectives query No boolean     Include interactions and objectives in the results
includeRuntime query No boolean     Include runtime details in the results

Request

Responses

200

Registration instance progress

Type: RegistrationSchema

Example:

{
    "activityDetails": {
        "activityCompletion": "UNKNOWN",
        "activitySuccess": "UNKNOWN",
        "attempts": 1,
        "children": [
            {},
            {}
        ],
        "completionAmount": {
            "scaled": 1
        },
        "id": "somestring",
        "objectives": [
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            },
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            }
        ],
        "runtime": {
            "completionStatus": "somestring",
            "credit": "somestring",
            "entry": "somestring",
            "exit": "somestring",
            "learnerComments": [
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                },
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                }
            ],
            "learnerPreference": {
                "audioCaptioning": 1,
                "audioLevel": 1,
                "deliverySpeed": 1,
                "language": "somestring"
            },
            "lmsComments": [
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                },
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                }
            ],
            "location": "somestring",
            "mode": "somestring",
            "progressMeasure": "somestring",
            "runtimeInteractions": [
                {
                    "correctResponses": [
                        "somestring",
                        "somestring"
                    ],
                    "description": "somestring",
                    "id": "somestring",
                    "latency": "somestring",
                    "learnerResponse": "somestring",
                    "objectives": [
                        "somestring",
                        "somestring"
                    ],
                    "result": "somestring",
                    "timestamp": "somestring",
                    "timestampUtc": "somestring",
                    "type": "TrueFalse",
                    "weighting": "somestring"
                },
                {
                    "correctResponses": [
                        "somestring",
                        "somestring"
                    ],
                    "description": "somestring",
                    "id": "somestring",
                    "latency": "somestring",
                    "learnerResponse": "somestring",
                    "objectives": [
                        "somestring",
                        "somestring"
                    ],
                    "result": "somestring",
                    "timestamp": "somestring",
                    "timestampUtc": "somestring",
                    "type": "TrueFalse",
                    "weighting": "somestring"
                }
            ],
            "runtimeObjectives": [
                {
                    "description": "somestring",
                    "id": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeObjectiveCompletionStatus": "UNKNOWN",
                    "runtimeObjectiveSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring"
                },
                {
                    "description": "somestring",
                    "id": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeObjectiveCompletionStatus": "UNKNOWN",
                    "runtimeObjectiveSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring"
                }
            ],
            "runtimeSuccessStatus": "UNKNOWN",
            "scoreMax": "somestring",
            "scoreMin": "somestring",
            "scoreRaw": "somestring",
            "scoreScaled": "somestring",
            "suspendData": "somestring",
            "timeTracked": "somestring",
            "totalTime": "somestring"
        },
        "score": {
            "scaled": 1
        },
        "staticProperties": {
            "completionThreshold": "somestring",
            "launchData": "somestring",
            "maxTimeAllowed": "somestring",
            "scaledPassingScore": 1,
            "scaledPassingScoreUsed": true,
            "timeLimitAction": "somestring"
        },
        "suspended": true,
        "timeTracked": "somestring",
        "title": "somestring"
    },
    "completedDate": "2015-01-01T15:00:00.000Z",
    "course": {
        "id": "somestring",
        "title": "somestring",
        "version": 1
    },
    "createdDate": "2015-01-01T15:00:00.000Z",
    "dispatchId": "somestring",
    "firstAccessDate": "2015-01-01T15:00:00.000Z",
    "globalObjectives": [
        {
            "firstScoreScaled": 1,
            "firstSuccessTimeStamp": "somestring",
            "id": "somestring",
            "objectiveCompletion": "UNKNOWN",
            "objectiveSuccess": "UNKNOWN",
            "previousObjectiveSuccess": "UNKNOWN",
            "previousScoreScaled": 1,
            "primary": true,
            "progressMeasure": 1,
            "score": {
                "scaled": 1
            },
            "scoreMax": 1,
            "scoreMin": 1,
            "scoreRaw": 1
        },
        {
            "firstScoreScaled": 1,
            "firstSuccessTimeStamp": "somestring",
            "id": "somestring",
            "objectiveCompletion": "UNKNOWN",
            "objectiveSuccess": "UNKNOWN",
            "previousObjectiveSuccess": "UNKNOWN",
            "previousScoreScaled": 1,
            "primary": true,
            "progressMeasure": 1,
            "score": {
                "scaled": 1
            },
            "scoreMax": 1,
            "scoreMin": 1,
            "scoreRaw": 1
        }
    ],
    "id": "somestring",
    "instance": 1,
    "lastAccessDate": "2015-01-01T15:00:00.000Z",
    "learner": {
        "email": "somestring",
        "firstName": "somestring",
        "id": "somestring",
        "lastName": "somestring"
    },
    "registrationCompletion": "UNKNOWN",
    "registrationCompletionAmount": 1,
    "registrationSuccess": "UNKNOWN",
    "score": {
        "scaled": 1
    },
    "sharedData": [
        {
            "id": "somestring",
            "value": "somestring"
        },
        {
            "id": "somestring",
            "value": "somestring"
        }
    ],
    "suspendedActivityId": "somestring",
    "totalSecondsTracked": 1,
    "updated": "2015-01-01T15:00:00.000Z",
    "xapiRegistrationId": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

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

Summary

Get xAPI statements for instance instanceId of registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
instanceId path Yes integer int32   The instance of this registration
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Request

Responses

200

Registration instance statements

Type: XapiStatementResult

Example:

{
    "more": "somestring",
    "statements": [
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        },
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "attachments": [
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                },
                {
                    "contentType": "somestring",
                    "description": {},
                    "display": {},
                    "fileUrl": "somestring",
                    "length": 1,
                    "sha2": "somestring",
                    "usageType": "somestring"
                }
            ],
            "authority": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "context": {
                "contextActivities": {
                    "category": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "grouping": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "other": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ],
                    "parent": [
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        },
                        {
                            "definition": {
                                "choices": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "correctResponsesPattern": [
                                    "somestring",
                                    "somestring"
                                ],
                                "description": {},
                                "extensions": {
                                    "extensions-mapped": {}
                                },
                                "interactionType": "somestring",
                                "moreInfo": "somestring",
                                "name": {},
                                "scale": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "source": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "steps": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "target": [
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    },
                                    {
                                        "description": {},
                                        "id": "somestring"
                                    }
                                ],
                                "type": "somestring"
                            },
                            "id": "somestring",
                            "objectType": "Activity"
                        }
                    ]
                },
                "extensions": {
                    "extensions-mapped": {}
                },
                "instructor": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                },
                "language": "somestring",
                "platform": "somestring",
                "registration": "somestring",
                "revision": "somestring",
                "statement": {
                    "id": "somestring",
                    "objectType": "StatementRef"
                },
                "team": {
                    "account": {
                        "homePage": "somestring",
                        "name": "somestring"
                    },
                    "mbox": "somestring",
                    "mbox_sha1sum": "somestring",
                    "member": [
                        {},
                        {}
                    ],
                    "name": "somestring",
                    "objectType": "Agent",
                    "openid": "somestring"
                }
            },
            "id": "somestring",
            "objectActivity": {
                "definition": {
                    "choices": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "correctResponsesPattern": [
                        "somestring",
                        "somestring"
                    ],
                    "description": {},
                    "extensions": {
                        "extensions-mapped": {}
                    },
                    "interactionType": "somestring",
                    "moreInfo": "somestring",
                    "name": {},
                    "scale": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "source": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "steps": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "target": [
                        {
                            "description": {},
                            "id": "somestring"
                        },
                        {
                            "description": {},
                            "id": "somestring"
                        }
                    ],
                    "type": "somestring"
                },
                "id": "somestring",
                "objectType": "Activity"
            },
            "objectAgentGroup": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},
                    {}
                ],
                "name": "somestring",
                "objectType": "Agent",
                "openid": "somestring"
            },
            "objectStatementReference": {
                "id": "somestring",
                "objectType": "StatementRef"
            },
            "objectSubStatement": {},
            "result": {
                "completion": true,
                "duration": "somestring",
                "extensions": {
                    "extensions-mapped": {}
                },
                "response": "somestring",
                "score": {
                    "max": 1,
                    "min": 1,
                    "raw": 1,
                    "scaled": 1
                },
                "success": true
            },
            "stored": "2015-01-01T15:00:00.000Z",
            "timestamp": "2015-01-01T15:00:00.000Z",
            "verb": {
                "display": {},
                "id": "somestring"
            }
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

GET /registrations/{registrationId}/instances

Summary

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

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
includeChildResults query No boolean     Include information about each learning object, not just the top level in the results
includeInteractionsAndObjectives query No boolean     Include interactions and objectives in the results
includeRuntime query No boolean     Include runtime details in the results

Request

Responses

200

List of registration instances

Type: RegistrationListSchema

Example:

{
    "more": "somestring",
    "registrations": [
        {
            "activityDetails": {
                "activityCompletion": "UNKNOWN",
                "activitySuccess": "UNKNOWN",
                "attempts": 1,
                "children": [
                    {},
                    {}
                ],
                "completionAmount": {
                    "scaled": 1
                },
                "id": "somestring",
                "objectives": [
                    {
                        "firstScoreScaled": 1,
                        "firstSuccessTimeStamp": "somestring",
                        "id": "somestring",
                        "objectiveCompletion": "UNKNOWN",
                        "objectiveSuccess": "UNKNOWN",
                        "previousObjectiveSuccess": "UNKNOWN",
                        "previousScoreScaled": 1,
                        "primary": true,
                        "progressMeasure": 1,
                        "score": {
                            "scaled": 1
                        },
                        "scoreMax": 1,
                        "scoreMin": 1,
                        "scoreRaw": 1
                    },
                    {
                        "firstScoreScaled": 1,
                        "firstSuccessTimeStamp": "somestring",
                        "id": "somestring",
                        "objectiveCompletion": "UNKNOWN",
                        "objectiveSuccess": "UNKNOWN",
                        "previousObjectiveSuccess": "UNKNOWN",
                        "previousScoreScaled": 1,
                        "primary": true,
                        "progressMeasure": 1,
                        "score": {
                            "scaled": 1
                        },
                        "scoreMax": 1,
                        "scoreMin": 1,
                        "scoreRaw": 1
                    }
                ],
                "runtime": {
                    "completionStatus": "somestring",
                    "credit": "somestring",
                    "entry": "somestring",
                    "exit": "somestring",
                    "learnerComments": [
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        },
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        }
                    ],
                    "learnerPreference": {
                        "audioCaptioning": 1,
                        "audioLevel": 1,
                        "deliverySpeed": 1,
                        "language": "somestring"
                    },
                    "lmsComments": [
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        },
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        }
                    ],
                    "location": "somestring",
                    "mode": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeInteractions": [
                        {
                            "correctResponses": [
                                "somestring",
                                "somestring"
                            ],
                            "description": "somestring",
                            "id": "somestring",
                            "latency": "somestring",
                            "learnerResponse": "somestring",
                            "objectives": [
                                "somestring",
                                "somestring"
                            ],
                            "result": "somestring",
                            "timestamp": "somestring",
                            "timestampUtc": "somestring",
                            "type": "TrueFalse",
                            "weighting": "somestring"
                        },
                        {
                            "correctResponses": [
                                "somestring",
                                "somestring"
                            ],
                            "description": "somestring",
                            "id": "somestring",
                            "latency": "somestring",
                            "learnerResponse": "somestring",
                            "objectives": [
                                "somestring",
                                "somestring"
                            ],
                            "result": "somestring",
                            "timestamp": "somestring",
                            "timestampUtc": "somestring",
                            "type": "TrueFalse",
                            "weighting": "somestring"
                        }
                    ],
                    "runtimeObjectives": [
                        {
                            "description": "somestring",
                            "id": "somestring",
                            "progressMeasure": "somestring",
                            "runtimeObjectiveCompletionStatus": "UNKNOWN",
                            "runtimeObjectiveSuccessStatus": "UNKNOWN",
                            "scoreMax": "somestring",
                            "scoreMin": "somestring",
                            "scoreRaw": "somestring",
                            "scoreScaled": "somestring"
                        },
                        {
                            "description": "somestring",
                            "id": "somestring",
                            "progressMeasure": "somestring",
                            "runtimeObjectiveCompletionStatus": "UNKNOWN",
                            "runtimeObjectiveSuccessStatus": "UNKNOWN",
                            "scoreMax": "somestring",
                            "scoreMin": "somestring",
                            "scoreRaw": "somestring",
                            "scoreScaled": "somestring"
                        }
                    ],
                    "runtimeSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring",
                    "suspendData": "somestring",
                    "timeTracked": "somestring",
                    "totalTime": "somestring"
                },
                "score": {
                    "scaled": 1
                },
                "staticProperties": {
                    "completionThreshold": "somestring",
                    "launchData": "somestring",
                    "maxTimeAllowed": "somestring",
                    "scaledPassingScore": 1,
                    "scaledPassingScoreUsed": true,
                    "timeLimitAction": "somestring"
                },
                "suspended": true,
                "timeTracked": "somestring",
                "title": "somestring"
            },
            "completedDate": "2015-01-01T15:00:00.000Z",
            "course": {
                "id": "somestring",
                "title": "somestring",
                "version": 1
            },
            "createdDate": "2015-01-01T15:00:00.000Z",
            "dispatchId": "somestring",
            "firstAccessDate": "2015-01-01T15:00:00.000Z",
            "globalObjectives": [
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                },
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                }
            ],
            "id": "somestring",
            "instance": 1,
            "lastAccessDate": "2015-01-01T15:00:00.000Z",
            "learner": {
                "email": "somestring",
                "firstName": "somestring",
                "id": "somestring",
                "lastName": "somestring"
            },
            "registrationCompletion": "UNKNOWN",
            "registrationCompletionAmount": 1,
            "registrationSuccess": "UNKNOWN",
            "score": {
                "scaled": 1
            },
            "sharedData": [
                {
                    "id": "somestring",
                    "value": "somestring"
                },
                {
                    "id": "somestring",
                    "value": "somestring"
                }
            ],
            "suspendedActivityId": "somestring",
            "totalSecondsTracked": 1,
            "updated": "2015-01-01T15:00:00.000Z",
            "xapiRegistrationId": "somestring"
        },
        {
            "activityDetails": {
                "activityCompletion": "UNKNOWN",
                "activitySuccess": "UNKNOWN",
                "attempts": 1,
                "children": [
                    {},
                    {}
                ],
                "completionAmount": {
                    "scaled": 1
                },
                "id": "somestring",
                "objectives": [
                    {
                        "firstScoreScaled": 1,
                        "firstSuccessTimeStamp": "somestring",
                        "id": "somestring",
                        "objectiveCompletion": "UNKNOWN",
                        "objectiveSuccess": "UNKNOWN",
                        "previousObjectiveSuccess": "UNKNOWN",
                        "previousScoreScaled": 1,
                        "primary": true,
                        "progressMeasure": 1,
                        "score": {
                            "scaled": 1
                        },
                        "scoreMax": 1,
                        "scoreMin": 1,
                        "scoreRaw": 1
                    },
                    {
                        "firstScoreScaled": 1,
                        "firstSuccessTimeStamp": "somestring",
                        "id": "somestring",
                        "objectiveCompletion": "UNKNOWN",
                        "objectiveSuccess": "UNKNOWN",
                        "previousObjectiveSuccess": "UNKNOWN",
                        "previousScoreScaled": 1,
                        "primary": true,
                        "progressMeasure": 1,
                        "score": {
                            "scaled": 1
                        },
                        "scoreMax": 1,
                        "scoreMin": 1,
                        "scoreRaw": 1
                    }
                ],
                "runtime": {
                    "completionStatus": "somestring",
                    "credit": "somestring",
                    "entry": "somestring",
                    "exit": "somestring",
                    "learnerComments": [
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        },
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        }
                    ],
                    "learnerPreference": {
                        "audioCaptioning": 1,
                        "audioLevel": 1,
                        "deliverySpeed": 1,
                        "language": "somestring"
                    },
                    "lmsComments": [
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        },
                        {
                            "dateTime": "somestring",
                            "location": "somestring",
                            "value": "somestring"
                        }
                    ],
                    "location": "somestring",
                    "mode": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeInteractions": [
                        {
                            "correctResponses": [
                                "somestring",
                                "somestring"
                            ],
                            "description": "somestring",
                            "id": "somestring",
                            "latency": "somestring",
                            "learnerResponse": "somestring",
                            "objectives": [
                                "somestring",
                                "somestring"
                            ],
                            "result": "somestring",
                            "timestamp": "somestring",
                            "timestampUtc": "somestring",
                            "type": "TrueFalse",
                            "weighting": "somestring"
                        },
                        {
                            "correctResponses": [
                                "somestring",
                                "somestring"
                            ],
                            "description": "somestring",
                            "id": "somestring",
                            "latency": "somestring",
                            "learnerResponse": "somestring",
                            "objectives": [
                                "somestring",
                                "somestring"
                            ],
                            "result": "somestring",
                            "timestamp": "somestring",
                            "timestampUtc": "somestring",
                            "type": "TrueFalse",
                            "weighting": "somestring"
                        }
                    ],
                    "runtimeObjectives": [
                        {
                            "description": "somestring",
                            "id": "somestring",
                            "progressMeasure": "somestring",
                            "runtimeObjectiveCompletionStatus": "UNKNOWN",
                            "runtimeObjectiveSuccessStatus": "UNKNOWN",
                            "scoreMax": "somestring",
                            "scoreMin": "somestring",
                            "scoreRaw": "somestring",
                            "scoreScaled": "somestring"
                        },
                        {
                            "description": "somestring",
                            "id": "somestring",
                            "progressMeasure": "somestring",
                            "runtimeObjectiveCompletionStatus": "UNKNOWN",
                            "runtimeObjectiveSuccessStatus": "UNKNOWN",
                            "scoreMax": "somestring",
                            "scoreMin": "somestring",
                            "scoreRaw": "somestring",
                            "scoreScaled": "somestring"
                        }
                    ],
                    "runtimeSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring",
                    "suspendData": "somestring",
                    "timeTracked": "somestring",
                    "totalTime": "somestring"
                },
                "score": {
                    "scaled": 1
                },
                "staticProperties": {
                    "completionThreshold": "somestring",
                    "launchData": "somestring",
                    "maxTimeAllowed": "somestring",
                    "scaledPassingScore": 1,
                    "scaledPassingScoreUsed": true,
                    "timeLimitAction": "somestring"
                },
                "suspended": true,
                "timeTracked": "somestring",
                "title": "somestring"
            },
            "completedDate": "2015-01-01T15:00:00.000Z",
            "course": {
                "id": "somestring",
                "title": "somestring",
                "version": 1
            },
            "createdDate": "2015-01-01T15:00:00.000Z",
            "dispatchId": "somestring",
            "firstAccessDate": "2015-01-01T15:00:00.000Z",
            "globalObjectives": [
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                },
                {
                    "firstScoreScaled": 1,
                    "firstSuccessTimeStamp": "somestring",
                    "id": "somestring",
                    "objectiveCompletion": "UNKNOWN",
                    "objectiveSuccess": "UNKNOWN",
                    "previousObjectiveSuccess": "UNKNOWN",
                    "previousScoreScaled": 1,
                    "primary": true,
                    "progressMeasure": 1,
                    "score": {
                        "scaled": 1
                    },
                    "scoreMax": 1,
                    "scoreMin": 1,
                    "scoreRaw": 1
                }
            ],
            "id": "somestring",
            "instance": 1,
            "lastAccessDate": "2015-01-01T15:00:00.000Z",
            "learner": {
                "email": "somestring",
                "firstName": "somestring",
                "id": "somestring",
                "lastName": "somestring"
            },
            "registrationCompletion": "UNKNOWN",
            "registrationCompletionAmount": 1,
            "registrationSuccess": "UNKNOWN",
            "score": {
                "scaled": 1
            },
            "sharedData": [
                {
                    "id": "somestring",
                    "value": "somestring"
                },
                {
                    "id": "somestring",
                    "value": "somestring"
                }
            ],
            "suspendedActivityId": "somestring",
            "totalSecondsTracked": 1,
            "updated": "2015-01-01T15:00:00.000Z",
            "xapiRegistrationId": "somestring"
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

GET /registrations/{registrationId}/launchHistory

Summary

Returns history of this registration’s launches

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
includeHistoryLog query No boolean     Whether to include the history log in the launch history

Request

Responses

200

The launch history

Type: LaunchHistoryListSchema

Example:

{
    "launchHistory": [
        {
            "completionStatus": "UNKNOWN",
            "exitTime": "2015-01-01T15:00:00.000Z",
            "historyLog": "somestring",
            "id": "somestring",
            "instance": 1,
            "lastRuntimeUpdate": "2015-01-01T15:00:00.000Z",
            "launchTime": "2015-01-01T15:00:00.000Z",
            "score": {
                "scaled": 1
            },
            "successStatus": "UNKNOWN",
            "totalSecondsTracked": 1
        },
        {
            "completionStatus": "UNKNOWN",
            "exitTime": "2015-01-01T15:00:00.000Z",
            "historyLog": "somestring",
            "id": "somestring",
            "instance": 1,
            "lastRuntimeUpdate": "2015-01-01T15:00:00.000Z",
            "launchTime": "2015-01-01T15:00:00.000Z",
            "score": {
                "scaled": 1
            },
            "successStatus": "UNKNOWN",
            "totalSecondsTracked": 1
        }
    ]
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

POST /registrations/{registrationId}/launchLink

Summary

Returns the link to use to launch this registration

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration

Request

Body
Name Required Type Format Properties Description
additionalvalues No array of ItemValuePairSchema      
courseTags No array of string      
cssUrl No string     A Url pointing to custom css for the player to use.
culture No string     This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used.
expiry No integer int32 {‘default’: 120} Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s
learnerTags No array of string      
redirectOnExitUrl No string     The URL the application should redirect to when the learner exits a course. If not specified, configured value will be used.
registrationTags No array of string      
startSco No string     For SCORM, SCO identifier to override launch, overriding the normal sequencing.
tracking No boolean   {‘default’: True} Should this launch be tracked? If false, Engine will avoid tracking to the extent possible for the standard being used.
{
    "additionalvalues": [
        {
            "item": "somestring",
            "value": "somestring"
        },
        {
            "item": "somestring",
            "value": "somestring"
        }
    ],
    "courseTags": [
        "somestring",
        "somestring"
    ],
    "cssUrl": "somestring",
    "culture": "somestring",
    "expiry": 120,
    "learnerTags": [
        "somestring",
        "somestring"
    ],
    "redirectOnExitUrl": "somestring",
    "registrationTags": [
        "somestring",
        "somestring"
    ],
    "startSco": "somestring",
    "tracking": true
}

Responses

200

Type: LaunchLinkSchema

Example:

{
    "launchLink": "somestring"
}
400

Bad request, redirectOnExitUrl is not a valid url, expiry is out of range, or other invalid query parameter

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

GET /registrations/{registrationId}

Summary

Get registration progress for registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
includeChildResults query No boolean     Include information about each learning object, not just the top level in the results
includeInteractionsAndObjectives query No boolean     Include interactions and objectives in the results
includeRuntime query No boolean     Include runtime details in the results

Request

Responses

200

Registration Progress

Type: RegistrationSchema

Example:

{
    "activityDetails": {
        "activityCompletion": "UNKNOWN",
        "activitySuccess": "UNKNOWN",
        "attempts": 1,
        "children": [
            {},
            {}
        ],
        "completionAmount": {
            "scaled": 1
        },
        "id": "somestring",
        "objectives": [
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            },
            {
                "firstScoreScaled": 1,
                "firstSuccessTimeStamp": "somestring",
                "id": "somestring",
                "objectiveCompletion": "UNKNOWN",
                "objectiveSuccess": "UNKNOWN",
                "previousObjectiveSuccess": "UNKNOWN",
                "previousScoreScaled": 1,
                "primary": true,
                "progressMeasure": 1,
                "score": {
                    "scaled": 1
                },
                "scoreMax": 1,
                "scoreMin": 1,
                "scoreRaw": 1
            }
        ],
        "runtime": {
            "completionStatus": "somestring",
            "credit": "somestring",
            "entry": "somestring",
            "exit": "somestring",
            "learnerComments": [
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                },
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                }
            ],
            "learnerPreference": {
                "audioCaptioning": 1,
                "audioLevel": 1,
                "deliverySpeed": 1,
                "language": "somestring"
            },
            "lmsComments": [
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                },
                {
                    "dateTime": "somestring",
                    "location": "somestring",
                    "value": "somestring"
                }
            ],
            "location": "somestring",
            "mode": "somestring",
            "progressMeasure": "somestring",
            "runtimeInteractions": [
                {
                    "correctResponses": [
                        "somestring",
                        "somestring"
                    ],
                    "description": "somestring",
                    "id": "somestring",
                    "latency": "somestring",
                    "learnerResponse": "somestring",
                    "objectives": [
                        "somestring",
                        "somestring"
                    ],
                    "result": "somestring",
                    "timestamp": "somestring",
                    "timestampUtc": "somestring",
                    "type": "TrueFalse",
                    "weighting": "somestring"
                },
                {
                    "correctResponses": [
                        "somestring",
                        "somestring"
                    ],
                    "description": "somestring",
                    "id": "somestring",
                    "latency": "somestring",
                    "learnerResponse": "somestring",
                    "objectives": [
                        "somestring",
                        "somestring"
                    ],
                    "result": "somestring",
                    "timestamp": "somestring",
                    "timestampUtc": "somestring",
                    "type": "TrueFalse",
                    "weighting": "somestring"
                }
            ],
            "runtimeObjectives": [
                {
                    "description": "somestring",
                    "id": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeObjectiveCompletionStatus": "UNKNOWN",
                    "runtimeObjectiveSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring"
                },
                {
                    "description": "somestring",
                    "id": "somestring",
                    "progressMeasure": "somestring",
                    "runtimeObjectiveCompletionStatus": "UNKNOWN",
                    "runtimeObjectiveSuccessStatus": "UNKNOWN",
                    "scoreMax": "somestring",
                    "scoreMin": "somestring",
                    "scoreRaw": "somestring",
                    "scoreScaled": "somestring"
                }
            ],
            "runtimeSuccessStatus": "UNKNOWN",
            "scoreMax": "somestring",
            "scoreMin": "somestring",
            "scoreRaw": "somestring",
            "scoreScaled": "somestring",
            "suspendData": "somestring",
            "timeTracked": "somestring",
            "totalTime": "somestring"
        },
        "score": {
            "scaled": 1
        },
        "staticProperties": {
            "completionThreshold": "somestring",
            "launchData": "somestring",
            "maxTimeAllowed": "somestring",
            "scaledPassingScore": 1,
            "scaledPassingScoreUsed": true,
            "timeLimitAction": "somestring"
        },
        "suspended": true,
        "timeTracked": "somestring",
        "title": "somestring"
    },
    "completedDate": "2015-01-01T15:00:00.000Z",
    "course": {
        "id": "somestring",
        "title": "somestring",
        "version": 1
    },
    "createdDate": "2015-01-01T15:00:00.000Z",
    "dispatchId": "somestring",
    "firstAccessDate": "2015-01-01T15:00:00.000Z",
    "globalObjectives": [
        {
            "firstScoreScaled": 1,
            "firstSuccessTimeStamp": "somestring",
            "id": "somestring",
            "objectiveCompletion": "UNKNOWN",
            "objectiveSuccess": "UNKNOWN",
            "previousObjectiveSuccess": "UNKNOWN",
            "previousScoreScaled": 1,
            "primary": true,
            "progressMeasure": 1,
            "score": {
                "scaled": 1
            },
            "scoreMax": 1,
            "scoreMin": 1,
            "scoreRaw": 1
        },
        {
            "firstScoreScaled": 1,
            "firstSuccessTimeStamp": "somestring",
            "id": "somestring",
            "objectiveCompletion": "UNKNOWN",
            "objectiveSuccess": "UNKNOWN",
            "previousObjectiveSuccess": "UNKNOWN",
            "previousScoreScaled": 1,
            "primary": true,
            "progressMeasure": 1,
            "score": {
                "scaled": 1
            },
            "scoreMax": 1,
            "scoreMin": 1,
            "scoreRaw": 1
        }
    ],
    "id": "somestring",
    "instance": 1,
    "lastAccessDate": "2015-01-01T15:00:00.000Z",
    "learner": {
        "email": "somestring",
        "firstName": "somestring",
        "id": "somestring",
        "lastName": "somestring"
    },
    "registrationCompletion": "UNKNOWN",
    "registrationCompletionAmount": 1,
    "registrationSuccess": "UNKNOWN",
    "score": {
        "scaled": 1
    },
    "sharedData": [
        {
            "id": "somestring",
            "value": "somestring"
        },
        {
            "id": "somestring",
            "value": "somestring"
        }
    ],
    "suspendedActivityId": "somestring",
    "totalSecondsTracked": 1,
    "updated": "2015-01-01T15:00:00.000Z",
    "xapiRegistrationId": "somestring"
}
400

Bad request

Type: MessageSchema

Example:

{
    "message": "somestring"
}
404

registrationId not found

Type: MessageSchema

Example:

{
    "message": "somestring"
}

Security

Security Schema Scopes
APP_NORMAL  
OAUTH read, read:registration

GET /registrations/{registrationId}/xAPIStatements

Summary

Get xAPI statements for registrationId

Parameters

Name Located in Required Type Format Properties Description
registrationId path Yes string     id for this registration
since query No string date-time   Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
until query No string date-time   Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
more query No string     Value for this parameter will be provided in the ‘more’ property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Request

Responses

200

Registration statements

Type: XapiStatementResult

Example:

{
    "more": "somestring",
    "statements": [
        {
            "actor": {
                "account": {
                    "homePage": "somestring",
                    "name": "somestring"
                },
                "mbox": "somestring",
                "mbox_sha1sum": "somestring",
                "member": [
                    {},