Engine Dispatch API documentation version v1

http://example.com/ScormEngineInterface/api/v1

Destinations

The collection of all destinations. Each dispatch has a destination, which is the client LMS that will import and launch the dispatch package.

get post delete

get

Get a list of destinations.

post

Create multiple destinations.

delete

Delete multiple destinations. Deleting a destination will also delete all dispatches for that destination, and deleting all destinations will therefore delete all dispatches.

Get a list of destinations.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • more: (string - default: )

    Value for this parameter will be provided in the 'more' property of destinations lists, where needed. An opaque value, construction and parsing may change without notice.

  • since: (string - default: )

    Only destinations updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, the server's time zone will be used.

  • courseId: (string - default: )

    Limit the results to destinations that have dispatches of the specified course.

    Example:

    1000

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "destinationListSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DestinationListSchema",
  "type": "object",
  "properties": {
    "destinations": {
      "type": "array",
      "items": {
        "$ref": "destinationIdSchema"
      },
      "required": true
    },
    "more": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Example:

{
  "destinations": [
    {
      "id": "123",
      "data": {"name": "DestinationOne"}
    },
    {
      "id": "234",
      "data": {"name": "DestinationTwo"}
    }
  ],
  "more": "/ScormEngineInterface/api/v1/default/destinations?more=sQ2JfFEBAAAOAAAA"
}

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Create multiple destinations.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "destinationListSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DestinationListSchema",
  "type": "object",
  "properties": {
    "destinations": {
      "type": "array",
      "items": {
        "$ref": "destinationIdSchema"
      },
      "required": true
    },
    "more": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Example:

{
  "destinations": [
    {
      "id": "123",
      "data": {"name": "DestinationOne"}
    },
    {
      "id": "234",
      "data": {"name": "DestinationTwo"}
    }
  ],
  "more": "/ScormEngineInterface/api/v1/default/destinations?more=sQ2JfFEBAAAOAAAA"
}

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Delete multiple destinations. Deleting a destination will also delete all dispatches for that destination, and deleting all destinations will therefore delete all dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • id: (string - default: )

    Comma-separated list of destinations IDs to delete. Default is "", which means all destinations.

    Example:

    123,234

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get put delete

An individual destination.

get

Get the destination with destinationId = {destinationId}.

put

Create or update the destination with destinationId = {destinationId}.

delete

Delete the destination with destinationId = {destinationId}.

Get the destination with destinationId = {destinationId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "destinationSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DestinationSchema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    }
  },
  "required": true,
  "additionalProperties": false
}

Example:

{
  "name": "DestinationOne"
}

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "destination not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Create or update the destination with destinationId = {destinationId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "destinationSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DestinationSchema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    }
  },
  "required": true,
  "additionalProperties": false
}

Example:

{
  "name": "NewDestinationOne"
}

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Delete the destination with destinationId = {destinationId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 204

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get delete

A collection of related dispatches.

get

Get a list of related dispatches.

delete

Delete all related dispatches.

Get a list of related dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • more: (string - default: )

    Value for this parameter will be provided in the 'more' property of dispatches lists, where needed. An opaque value, construction and parsing may change without notice.

  • since: (string - default: )

    Only dispatches updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, the server's time zone will be used.

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "dispatchListSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DispatchListSchema",
  "type": "object",
  "properties": {
    "dispatches": {
      "type": "array",
      "items": {
        "$ref": "dispatchIdSchema"
      },
      "required": true
    },
    "more": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Example:

{
  "dispatches": [
    {
      "id": "123",
      "data": {
        "destinationId": "234",
        "courseId": "CourseId|1001",
        "allowNewRegistrations": true,
        "instanced": true,
        "registrationCap": 100,
        "expirationDate": "2017-01-01",
        "externalConfig": ""
      }
    },
    {
      "id": "321",
      "data": {
        . . .
      }
    }
  ],
  "more": "/ScormEngineInterface/api/v1/default/dispatches?more=sQ2JfFEBAAAOAAAA"
}

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Delete all related dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

post

Subresource that allows enabling or disabling all related dispatches.

post

Enable or disable all related dispatches.

Enable or disable all related dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{ "type": "boolean", "required": true }

Example:

true

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

post

Enable or disable registration instancing for all related dispatches.

post

Enable or disable registration instancing.

Enable or disable registration instancing.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{ "type": "boolean", "required": true }

Example:

true

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get delete

Aggregate registration counts for all related dispatches.

get

Get an aggregate count of all related dispatch registrations.

delete

Reset registration counts for all related dispatches.

Get an aggregate count of all related dispatch registrations.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{ "type": "integer", "required": true }

Example:

412

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Reset registration counts for all related dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 204

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get

ZIP file containing all related dispatch packages.

get

Get a ZIP file containing all related dispatch packages.

Get a ZIP file containing all related dispatch packages.

Secured by basic

URI Parameters

  • tenant: required (string)
  • destinationId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • type: (string - default: )

    The type of dispatch package to export (SCORM12, SCORM2004-3RD or AICC)

HTTP status code 200

Headers

  • Content-Disposition: (string)

    Example:

    attachment; filename="dispatches.zip"

Body

Type: application/zip

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Dispatches

The collection of all dispatches.

get post delete

get

Get a list of dispatches.

post

Create multiple dispatches.

delete

Delete multiple dispatches.

Get a list of dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • more: (string - default: )

    Value for this parameter will be provided in the 'more' property of dispatches lists, where needed. An opaque value, construction and parsing may change without notice.

  • since: (string - default: )

    Only dispatches updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, the server's time zone will be used.

  • courseId: (string - default: )

    Limit the results to dispatches of the specified course.

    Example:

    1000

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "dispatchListSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DispatchListSchema",
  "type": "object",
  "properties": {
    "dispatches": {
      "type": "array",
      "items": {
        "$ref": "dispatchIdSchema"
      },
      "required": true
    },
    "more": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Example:

{
  "dispatches": [
    {
      "id": "123",
      "data": {
        "destinationId": "234",
        "courseId": "CourseId|1001",
        "allowNewRegistrations": true,
        "instanced": true,
        "registrationCap": 100,
        "expirationDate": "2017-01-01",
        "externalConfig": ""
      }
    },
    {
      "id": "321",
      "data": {
        . . .
      }
    }
  ],
  "more": "/ScormEngineInterface/api/v1/default/dispatches?more=sQ2JfFEBAAAOAAAA"
}

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Create multiple dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "dispatchListSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DispatchListSchema",
  "type": "object",
  "properties": {
    "dispatches": {
      "type": "array",
      "items": {
        "$ref": "dispatchIdSchema"
      },
      "required": true
    },
    "more": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Example:

{
  "dispatches": [
    {
      "id": "123",
      "data": {
        "destinationId": "234",
        "courseId": "CourseId|1001",
        "allowNewRegistrations": true,
        "instanced": true,
        "registrationCap": 100,
        "expirationDate": "2017-01-01",
        "externalConfig": ""
      }
    },
    {
      "id": "321",
      "data": {
        . . .
      }
    }
  ],
  "more": "/ScormEngineInterface/api/v1/default/dispatches?more=sQ2JfFEBAAAOAAAA"
}

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Delete multiple dispatches.

Secured by basic

URI Parameters

  • tenant: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • id: (string - default: )

    Comma-separated list of dispatches IDs to delete. Default is "", which means all dispatches.

    Example:

    123,234

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get put delete

An individual dispatch.

get

Get the dispatch with dispatchId = {dispatchId}.

put

Create or update the dispatch with dispatchId = {dispatchId}.

delete

Delete the dispatch with dispatchId = {dispatchId}.

Get the dispatch with dispatchId = {dispatchId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "dispatchSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DispatchSchema",
  "type": "object",
  "properties": {
    "destinationId": {
      "description": "Destination ID.",
      "type": "string",
      "required": true
    },
    "courseId": {
      "description": "Serialized external package ID.",
      "type": "string",
      "required": true
    },
    "allowNewRegistrations": {
      "description": "If true, then new registrations can be created for this dispatch.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "instanced": {
      "description": "If true, then a new registration instance will be created if the client LMS doesn't provide launch data for an existing one. Otherwise, the same instance will always be used for the given cmi.learner_id.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "registrationCap": {
      "description": "The maximum number of registrations that can be created for this dispatch, where '0' means 'unlimited registrations'.",
      "type": "integer",
      "required": false,
      "default": 0
    },
    "expirationDate": {
      "description": "The date after which this dispatch will be disabled as an ISO 8601 string, or \"none\" for no expiration date.",
      "type": "string",
      "required": false,
      "default": "none"
    },
    "externalConfig": {
      "description": "Serialized external configuration information to include when launching the dispatched package.",
      "type": "string",
      "required": false,
      "default": ""
    },
    "enabled": {
      "description": "If true, then this dispatch can be launched.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "registrationCount": {
      "description": "The number of registrations created for this dispatch.",
      "type": "integer",
      "required": false,
      "default": 0
    },
    "registrationResetDate": {
      "description": "The date the dispatch registration count was reset to 0 as an ISO 8601 string, or \"none\" for no reset date.",
      "type": "string",
      "required": false,
      "default": ""
    }
  },
  "required": true,
  "additionalProperties": false
}

Example:

{
  "destinationId": "234",
  "courseId": "CourseId|1001",
  "allowNewRegistrations": true,
  "instanced": true,
  "registrationCap": 100,
  "expirationDate": "2017-01-01",
  "externalConfig": ""
}

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "dispatch not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Create or update the dispatch with dispatchId = {dispatchId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "dispatchSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.DispatchSchema",
  "type": "object",
  "properties": {
    "destinationId": {
      "description": "Destination ID.",
      "type": "string",
      "required": true
    },
    "courseId": {
      "description": "Serialized external package ID.",
      "type": "string",
      "required": true
    },
    "allowNewRegistrations": {
      "description": "If true, then new registrations can be created for this dispatch.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "instanced": {
      "description": "If true, then a new registration instance will be created if the client LMS doesn't provide launch data for an existing one. Otherwise, the same instance will always be used for the given cmi.learner_id.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "registrationCap": {
      "description": "The maximum number of registrations that can be created for this dispatch, where '0' means 'unlimited registrations'.",
      "type": "integer",
      "required": false,
      "default": 0
    },
    "expirationDate": {
      "description": "The date after which this dispatch will be disabled as an ISO 8601 string, or \"none\" for no expiration date.",
      "type": "string",
      "required": false,
      "default": "none"
    },
    "externalConfig": {
      "description": "Serialized external configuration information to include when launching the dispatched package.",
      "type": "string",
      "required": false,
      "default": ""
    },
    "enabled": {
      "description": "If true, then this dispatch can be launched.",
      "type": "boolean",
      "required": false,
      "default": false
    },
    "registrationCount": {
      "description": "The number of registrations created for this dispatch.",
      "type": "integer",
      "required": false,
      "default": 0
    },
    "registrationResetDate": {
      "description": "The date the dispatch registration count was reset to 0 as an ISO 8601 string, or \"none\" for no reset date.",
      "type": "string",
      "required": false,
      "default": ""
    }
  },
  "required": true,
  "additionalProperties": false
}

Example:

{
  "destinationId": "234",
  "courseId": "CourseId|1001",
  "allowNewRegistrations": true,
  "instanced": true,
  "registrationCap": 100,
  "expirationDate": "2017-01-01",
  "externalConfig": ""
}

HTTP status code 204

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Delete the dispatch with dispatchId = {dispatchId}.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 204

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get put

Dispatches may be enabled or disabled to control the ability to launch from client LMSs.

get

True if the dispatch is enabled, or false if it is disabled.

put

Enable or disabled the dispatch.

True if the dispatch is enabled, or false if it is disabled.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{ "type": "boolean", "required": true }

Example:

true

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "<<resourcePathName|!singularize>> not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Enable or disabled the dispatch.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

Body

Type: application/json

Schema:

{ "type": "boolean", "required": true }

Example:

true

HTTP status code 204

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "<<resourcePathName|!singularize>> not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get delete

The number of registrations created for this dispatch since it was created, or since the count was last reset.

get

Get the registration count for this dispatch, and the date and time of the last count reset, if any.

delete

Reset the registration count for this dispatch.

Get the registration count for this dispatch, and the date and time of the last count reset, if any.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "registrationCountSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.RegistrationCountSchema",
  "type": "object",
  "properties": {
    "registrationCount": {
      "type": "integer",
      "required": true
    },
    "lastResetTime": {
      "type": "string",
      "required": false
    }
  },
  "additionalProperties": false
}

Example:

{
  "registrationCount": 2185,
  "lastResetDate": "2015-10-09T04:30:08Z"
}

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

Reset the registration count for this dispatch.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 204

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "<<resourcePathName|!singularize>> not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get

The information necessary to launch this course using the IMS LTI specification.

get

Get the information necessary to launch this dispatch using the IMS LTI specification.

Get the information necessary to launch this dispatch using the IMS LTI specification.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "ltiInfoSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.LtiInfoSchema",
  "type": "object",
  "properties": {
    "url": {
      "description": "The LTI launch URL for this dispatch",
      "type": "string",
      "required": true
    },
    "consumerKey": {
      "description": "The OAuth consumer key that identifies the tool consumer for this dispatch.",
      "type": "string",
      "required": true
    },
    "sharedSecret": {
      "description": "The OAuth secret to be used for LTI authentication for this dispatch.",
      "type": "string",
      "required": true
    }
  },
  "required": true,
  "additionalProperties": false
}

Example:

{
  "url": "http://example.org/ScormEngineInterface/dispatch/DispatchRequest.aspx?methodName=BltiLaunch&tenant=default",
  "consumerKey": "myDispatchId",
  "sharedSecret": "p4SsW0rD"
}

HTTP status code 400

Bad request.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "Explanation of why the request is bad." }

HTTP status code 404

Not found.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema#",
  "title": "messageSchema",
  "javaType": "RusticiSoftware.ScormContentPlayer.api.model.MessageSchema",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "required": true
    }
  },
  "additionalProperties": false
}

Example:

{ "message": "<<resourcePathName|!singularize>> not found" }

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.

get

The ZIP dispatch package.

get

Get the ZIP dispatch package.

Get the ZIP dispatch package.

Secured by basic

URI Parameters

  • tenant: required (string)
  • dispatchId: required (string)

Query Parameters

  • configuration: (string - default: )

    External configuration information. Optional unless GetConnectionString is overridden in your integration layer.

    Example:

    CompanyId|123
  • type: (string - default: )

    The type of dispatch package to export (SCORM12, SCORM2004-3RD or AICC)

HTTP status code 200

Headers

  • Content-Disposition: (string)

    Example:

    attachment; filename="dispatch.zip"

Body

Type: application/zip

Secured by basic

Headers

  • Authorization: (string)

    An HTTP Basic Authentication header as described in RFC 2617.

HTTP status code 401

Not authorized.

HTTP status code 403

Forbidden.