Documentation: API Endpoint

Courses
1.0

Saves an asset group

POST /courses/assetgroup/save
Parameter(s)
Name Type Description Default Accepted Values
id integer Asset group ID to edit null
title string Asset group title New asset group
state integer State of asset group null
description string Short description null
unit_id integer ID of parent unit null
parent integer ID of parent asset group null
params array Parameters related to the asset group null

Reorders asset groups

POST /courses/assetgroup/reorder
Parameter(s)
Name Type Description Default Accepted Values
assetgroupitem array Required. Asset group items, in desired order null

List entries

GET /courses/assetgroup/list

Create an entry

POST /courses/assetgroup

Read an entry

GET /courses/assetgroup/{primary key}

Update an entry

PUT /courses/assetgroup/{primary key}

Delete an entry

DELETE /courses/assetgroup/{primary key}

Gets the asset handlers for a given extension

POST /courses/asset/handlers
Parameter(s)
Name Type Description Default Accepted Values
name string Required. Name of file to be uploaded null

Creates a new asset

POST /courses/asset/new
Parameter(s)
Name Type Description Default Accepted Values
files array Files to upload null
type string Content type being created null
handler string The file handler to use null

Retrieves the asset edit page

POST /courses/asset/edit
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset to edit null

Previews an asset

POST /courses/asset/preview
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset to preview null

Saves an asset

POST /courses/asset/save
Parameter(s)
Name Type Description Default Accepted Values
id integer ID of asset to save null
title string Asset title New asset
published string Asset state null
state integer Asset state null

Deletes an asset

POST /courses/asset/delete
Parameter(s)
Name Type Description Default Accepted Values
asset_id integer Required. ID of asset to delete null
scope string Required. Asset scope null
scope_id integer Required. Asset scope ID null

Deletes an asset file

POST /courses/asset/deletefile
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset owning file null
filename string Required. Name of file to delete null

Reorders assets

POST /courses/asset/reorder
Parameter(s)
Name Type Description Default Accepted Values
asset array Required. Array of IDs of assets to reorder null
scope string Required. Asset scope null
scope_id integer Required. Asset scope ID null

Toggles the published state of an asset

POST /courses/asset/togglepublished
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset to toggle state null

Looks up the form id based on the asset id

GET /courses/asset/getformid
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset to look up null

Looks up the form id and deployment id based on the asset id

GET /courses/asset/getformanddepid

fixme: : combine this with method above

Parameter(s)
Name Type Description Default Accepted Values
id integer Required. ID of asset to look up null

List entries

GET /courses/asset/list

Create an entry

POST /courses/asset

Read an entry

GET /courses/asset/{primary key}

Update an entry

PUT /courses/asset/{primary key}

Lists course catalog

POST /courses/list
Parameter(s)
Name Type Description Default Accepted Values
limit integer Number of records to return 25
limitstart integer Offset of Records to return 0

Create an entry

POST /courses

Read an entry

GET /courses/{primary key}

Update an entry

PUT /courses/{primary key}

Delete an entry

DELETE /courses/{primary key}

Gets form images

GET /courses/form/image
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. Form ID null
form_version integer Form version number null
file string Required. Image filename null
token string Required. Session authentication token null

List entries

GET /courses/form/list

Create an entry

POST /courses/form

Read an entry

GET /courses/form/{primary key}

Update an entry

PUT /courses/form/{primary key}

Delete an entry

DELETE /courses/form/{primary key}

Passport badges. Placeholder for now.

POST /courses/passport/badge
Parameter(s)
Name Type Description Default Accepted Values
action string Required. Badge action null
badge_id integer Required. Passport badge ID null
user_email string Required. Email address to which the badge was asserted null

List entries

GET /courses/passport/list

Create an entry

POST /courses/passport

Read an entry

GET /courses/passport/{primary key}

Update an entry

PUT /courses/passport/{primary key}

Delete an entry

DELETE /courses/passport/{primary key}

Adds a new prerequisite

POST /courses/prerequisite/new
Parameter(s)
Name Type Description Default Accepted Values
item_scope string Items having prerequisites asset
item_id integer Required. Item ID null
requisite_scope string Items that are prerequisites asset
requisite_id integer Required. Requisite ID null
section_id integer Required. Section ID null

Deletes a prerequisite

POST /courses/prerequisite/delete
Parameter(s)
Name Type Description Default Accepted Values
id integer Required. Prerequisite ID null

List entries

GET /courses/prerequisite/list

Create an entry

POST /courses/prerequisite

Read an entry

GET /courses/prerequisite/{primary key}

Update an entry

PUT /courses/prerequisite/{primary key}

Saves a course unit

POST /courses/unit/save
Parameter(s)
Name Type Description Default Accepted Values
id integer Unit ID to edit null
section_id integer Section ID of unit null
offering_id integer Offering ID of unit null
title string Unit title New Unit
publish_up string Start publishing date null
publish_down string Stop publishing date null

List entries

GET /courses/unit/list

Create an entry

POST /courses/unit

Read an entry

GET /courses/unit/{primary key}

Update an entry

PUT /courses/unit/{primary key}

Delete an entry

DELETE /courses/unit/{primary key}

Processes grade save from unity app

POST /courses/unity/save
Parameter(s)
Name Type Description Default Accepted Values
referrer string Host page $_SERVER['HTTP_REFERER']
payload string Required. Score notes/content null

List entries

GET /courses/unity/list

Create an entry

POST /courses/unity

Read an entry

GET /courses/unity/{primary key}

Update an entry

PUT /courses/unity/{primary key}