Item API Documentation

Overview

The Item API returns representations relating to leaf item nodes in content package manifests.

URI Template

http://{host}/cartridges/{cartridge_id}/items/{item_id}.{ext}

.xml, .json: returns an OpenSocial App Data representation of a leaf item node. The first and last leaf nodes may be specified using the "@first" and "@last" selectors respectively for the item identifier path variable.

.js: returns an representation of the item to be directly embedded into any web page.

.app: redirects to a view of the item in a configured web application.

.do: redirects to a landing page about the item (such as a sign up form).

.go: redirects to the actual file referenced by the item (HTML page, PDF document etc.).

Try It

http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/@first.json
http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/@first.xml

http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/x_s103_1_1_item.json
http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/x_s103_1_1_item.xml
http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/x_s103_1_1_item.app
http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/x_s103_1_1_item.do
http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/x_s103_1_1_item.go

Embed It

http://api.icodeon.com/cartridges/OpenLearn-S103_1/items/
x_s103_1_1_item.js

Example Embed



Download content package.