Xapi Service

API V2 reference

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

createStatementPipe

POST /xapi/statementPipes

Summary

Create an xAPI statement pipe.

Parameters

Consumes: application/json

Type Name Required Schema
Body xapiStatementPipe true XapiStatementPipePostSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 StringResultSchema
400 bad request, xapiPipe is not XapiPipePostSchema MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:xapipipe
write




createXapiCredential

POST /xapi/credentials

Summary

Create a xAPI credential.

Parameters

Consumes: application/json

Type Name Required Schema
Body xapiCredential true XapiCredentialPostSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 StringResultSchema
400 bad request, xapiCredentials is not XapiCredentialsPostSchema MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:xapicredential
write




deleteStatementPipe

DELETE /xapi/statementPipes/{statementPipeId}

Summary

Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.

Parameters

Consumes: application/json

Type Name Required Schema
Path statementPipeId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204
404 xapiPipeId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:xapipipe
delete




deleteXapiCredential

DELETE /xapi/credentials/{xapiCredentialId}

Summary

Deletes the xAPI credentials specified by the xAPI credentials id

Parameters

Consumes: application/json

Type Name Required Schema
Path xapiCredentialId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 The xAPI credential with id xapiCredentialsId was deleted
404 xapiCredentialsId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:xapicredential
delete




getStatementPipe

GET /xapi/statementPipes/{statementPipeId}

Summary

Retrieves xAPI pipe for xapiPipeId

Parameters

Consumes: application/json

Type Name Required Schema
Path statementPipeId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The specified xAPI pipe XapiStatementPipeSchema
404 xapiPipeIdnot found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:xapipipe




getStatementPipes

GET /xapi/statementPipes

Summary

Get all of the xapiPipes for appId

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of xAPI pipes XapiStatementPipeListSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:xapipipe




getXapiCredential

GET /xapi/credentials/{xapiCredentialId}

Summary

Retrieves the xAPI credentials specified by the xAPI credentials id.

Parameters

Consumes: application/json

Type Name Required Schema
Path xapiCredentialId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The specified xAPI credentials XapiCredentialSchema
404 xapiCredentialsId not found MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:xapicredential




getXapiCredentials

GET /xapi/credentials

Summary

Get the list of xapiCredentials

Parameters

Consumes: application/json

Type Name Required Schema
Query since Date
Query more String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of xAPI credentials XapiCredentialsListSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:xapicredential




setStatementPipe

PUT /xapi/statementPipes/{statementPipeId}

Summary

Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. If the pipe being edited is currently being processed, the this request will fail with a status code of 409.

Parameters

Consumes: application/json

Type Name Required Schema
Path statementPipeId true String
Body xapiStatementPipe true XapiStatementPipeSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200 StringResultSchema
400 bad request, xapiPipe is not XapiPipeSchema MessageSchema
409 conflict, pipe is currently being processed MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:xapipipe
write




setXapiCredential

PUT /xapi/credentials/{xapiCredentialId}

Summary

Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id

Parameters

Consumes: application/json

Type Name Required Schema
Path xapiCredentialId true String
Body xapiCredential true XapiCredentialPostSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 The creation or edit of the xAPI credential was successful
400 bad request, xapiCredentials is not XapiCredentialsPostSchema MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:xapicredential
write