Curriculum

A curriculum is one of the core models of the Adaptemy system. It defines what the learner is trying to learn, the framework against which content is mapped and learner profile is estimated.

The Curriculum Design Process

This API provides the endpoints for creating, updating and analysing curriculum models. However the design, structuring and tagging of your curriculum for a course is a careful authoring process.

The principles of Curriculum Design are detailed on the Adaptemy site, and Adaptemy offer workshops to train your team on Curriculum Design. This can be tailored to your subject areas and learning products.

While a curriculumobject is a defined data structure that can be created in any text/XML editor, Adaptemy also offer a Curriculum Design tool to enable easier visual design and updating of curriculumobjects.

The Curriculum object

The Curriculum object returned by the Adaptemy API contains the curriculum xml definition along with various properties relating to its deployment in the Adaptemy system.

Property	Description
name	Internal name of the Curriculum
guid	Internal persistent ID of the curriculum object
version	Contains the latest version of the curriculum deployed to this environment
version.id	Incrementing integer version of the curriculum, generated by the Curriculum Design tool
version.savedOn	Datetime that the last edit was made to this curriculum version
version.deployedOn	Datetime that this curriculum version was deployed to this environment
version.description	Any description of this version
version.xml	The XML definition of this curriculum
courses	Contains an array of courses to which this curriculum is attached
courses.name	Course name
courses.guid	Internal persistent ID of the course
courses.externalID	The external ID of the course

Curriculum xml schema

The xml schema of the curriculumobject is available at: https://www.adaptemy.com/xml/curriculum.xsd

The schema allows for metadata extensions ("Configurations") to be added to any curriculum. These metadata extensions should be agreed following the Learning Design phase of any implementation.

curriculums

GET https://api.adaptemy.io/curriculums

Returns a list of all curriculums that your account has access to, filtered by any query parameters.

Query Parameters

Name	Type	Description
guid	string	The internal ID of the curriculum in the Adaptemy system.

200

[
  {
    name: "Junior Cert Maths",
    guid: "898e59a8-ced3-4f2b-b4ac-5a057f8f5a36",
    version: {
      id: 12,
      description: "Renamed 'Coordinate Geometry' to 'Coordinate Geometry 1'",
      saved_on: "2015-11-05T9:15:30Z",
      deployed_on: "2015-12-01T13:10:00Z",
      xml: "...the xml...",
    }
    "courses": [
      {
        "name": "BuildUp Maths JC",
        "guid": "guid-2222444-85757",
        "externalId": "ext-id-22333"
      }
    ]
  }
]

401 The authorization token was not recognised.

404 No curriculums were found that match the query parameters.

curriculums

POST https://api.adaptemy.io/curriculums

This method allows a new curriculum object to be deployed to the environment. Use with caution, this has severe consequences for any live course! The typical lifecycle of a curriculum version is: 1. Edit and review the curriculum in the Curriculum Design tool. 2. Deploy the curriculum version to the QA environment for testing. 3. Deploy the curriculum version to the Live environment. A deployment will trigger many updates to all models within the adaptive learning system.

Request Body

Name	Type	Description
guid	string	Internal persistent ID of the curriculum object
name	string	Internal name of the Curriculum
version.id	integer	Integer version of the curriculum
version.savedOn	string	Datetime when the last edit was made to this curriculum version
version.description	string	Any description of this version
version.xml	string	The XML definition of this curriculum version.

200 Valid curriculum version successfully deployed.