CampusAPI Syllabus Services API documentation version 1.0.2
Based on OSID version 3.0.0
https://base.url/syllabus
Overview
The Course Syllabus package manages curriculum within a Course and relating the material to learning Objectives to create lesson plans. It may be defined very broadly or at a fine-grained level to facilitate the production of lesson Plans in the Course Plan service package.
This package includes the following entities:
Syllabi
A Syllabus is an entity representing the content of a Course. A Course may have multiple syllabi.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this syllabus, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this syllabus, provided by system. | string(uri) |
| displayName | The name of this syllabus for display. | string |
| description | The description of this syllabus. | string |
| genusTypeId (read‑only) | Id of the immutable type of this syllabus. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this syllabus. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| courseId (read‑only) | The course associated with this syllabus. References a course.Course object. | string(osid‑id) |
Modules
A Module is a major division of a Syllabus. Modules may be toggled for inclusion in an overall Syllabus. Modules are subdivided into Docets.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this module, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this module, provided by system. | string(uri) |
| displayName | The name of this module for display. | string |
| description | The description of this module. | string |
| genusTypeId (read‑only) | Id of the immutable type of this module. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this module. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this module. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this module. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this module. | string |
| active (read‑only) | Whether this module is active. Active is true if operational is true and disabled is false, or enabled is true. | boolean |
| enabled | Whether this module is administravely enabled. Administratively enabling overrides any applied enabler. | boolean |
| disabled | Whether this module is administravely disabled. Administratively disabling overrides any applied enabler. | boolean |
| operational (read‑only) | Whether this module is operational. This module is operational if any of the applied enablers are true. | boolean |
| syllabusId (read‑only) | The syllabus associated with this module. References a syllabus.Syllabus object. | string(osid‑id) |
Docets
A Docet is an relationship serving as a piece of content within a Module. A Docet relates to one or more learning Objectives. The learning Objectives visible through a Course may be built up using the Course Syllabus package.
Each Docet may include Assets for materials serving to instruct this portion of the Course or Assessments for quizzes and assignments.
A Docet may be a portion of an activity that is designated is in or out of class time and an estimated time duration. The Course Plan package can examine the in class Docets and their durations to understand the schedule of lesson plans through a CourseOffering in a Term.
Docets may apply to a subset of ActivityUnits with a Course.
Although Docets may be defined at very broad levels covering multiple learning Objectives and multiple ActivityUnits with long durations, when managed down to the level of a single Objective can serve to structure the lesson plan, homework assignments, and other exercises within a single instance of an Activity offering.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this docet, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this docet, provided by system. | string(uri) |
| displayName | The name of this docet for display. | string |
| description | The description of this docet. | string |
| genusTypeId (read‑only) | Id of the immutable type of this docet. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this docet. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this docet. | string(date‑time) |
| endDate | The ending date of this docet. | string(date‑time) |
| endReasonId | The reason this docet ended. References a process.State object. | string(osid‑id) |
| moduleId (read‑only) | The module associated with this docet. References a syllabus.Module object. | string(osid‑id) |
| activityUnitId (read‑only) | The activity unit associated with this docet. References a course.ActivityUnit object. | string(osid‑id) |
| learningObjectiveIds | The learning objectives. References an array of learning.Objective objects. | string(osid‑id)[] |
| inClass | Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity. | boolean |
| duration | The estimated duration. | string(duration) |
| assetIds | The assets distributed to the students. References an array of repository.Asset objects. | string(osid‑id)[] |
| assessmentIds | The assessments. References an array of assessment.Assessment objects. | string(osid‑id)[] |
CourseCatalogs
Courses, ActivityUnits, CourseOfferings, Activities, and Terms can be organized into federateble catalogs. CourseCatalogs can be used to represent a set of CourseOfferings offered in a specific Term, year, or by subject area, sponsor, campus, etc.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this course catalog, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this course catalog, provided by system. | string(uri) |
| displayName | The name of this course catalog for display. | string |
| description | The description of this course catalog. | string |
| genusTypeId (read‑only) | Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this course catalog. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this course catalog. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this course catalog. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/syllabi
Collection of syllabi in a system, federation of systems, or in a default courseCatalog.
get
Get all syllabi in the system or default courseCatalog.
post
Create a new syllabus in the default courseCatalog.
get /syllabi
Get all syllabi in the system or default courseCatalog.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleSyllabusType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleSyllabusType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleSyllabusType%40campusapi.org - courseId: (string)
the id string to match a course.
Example:
course.Course%3A288%40base.url - courseCatalogId: (string)
The id string to match a courseCatalog
Example:
course.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Syllabus:2909@base.url",
"uri": "http://base.url/open/campusapi/syllabus/syllabus/syllabus.Syllabus%3A2909%40base.url",
"displayName": "Display Name of this Syllabus",
"description": "The description of this Syllabus",
"genusTypeId": "type.Type:defaultSyllabusType@base.url",
"recordTypeIds": [ "type.Type:exampleSyllabusRecordType@campusapi.org", "..."],
"courseId": "course.Course:7922@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /syllabi
Create a new syllabus in the default courseCatalog.
Query Parameters
- courseId: required(string)
the course of this syllabus.
Example:
course.Course%3A288%40base.url - genusType: (string)
specify a particular syllabus type to create
Example:
type.Type%3AexampleSyllabusType%40dxtera.org - recordType: (array of )
specify support for one or more syllabus record types
Example:
[ "type.Type%3AexampleSyllabusRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this syllabus
Example:
syllabus.CourseCatalog%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Syllabus",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this syllabus, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this syllabus, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this syllabus for display.",
"type": "string"
},
"description": {
"description": "The description of this syllabus.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this syllabus. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this syllabus. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"courseId": {
"description": "The course associated with this syllabus.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Syllabus",
"description": "The description of this Syllabus"
}
Entity representing a syllabus form metadata.
get
Get form metadata for creating a new syllabus.
get /syllabi/metadata
Get form metadata for creating a new syllabus.
Query Parameters
- courseId: required(string)
the course of this metadatum.
Example:
course.Course%3A288%40base.url - genusType: (string)
specify a particular syllabus type to create
Example:
type.Type%3AexampleSyllabusType%40dxtera.org - recordType: (array of )
specify support for one or more syllabus record types
Example:
[ "type.Type%3AexampleSyllabusRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this syllabus
Example:
syllabus.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Syllabus",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this syllabus, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this syllabus, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this syllabus for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Syllabus.Syllabus:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this syllabus",
"linked": false
},
"description": {
"description": "The description of this syllabus.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Syllabus.Syllabus:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this syllabus",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this syllabus. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this syllabus. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a syllabus
get
Get a syllabus given its id.
put
Update a given syllabus.
delete
Delete a given syllabus.
get /syllabi/{syllabusId}
Get a syllabus given its id.
URI Parameters
- syllabusId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "syllabus.Syllabus:2909@base.url",
"uri": "http://base.url/open/campusapi/syllabus/syllabus/syllabus.Syllabus%3A2909%40base.url",
"displayName": "Display Name of this Syllabus",
"description": "The description of this Syllabus",
"genusTypeId": "type.Type:defaultSyllabusType@base.url",
"recordTypeIds": [ "type.Type:exampleSyllabusRecordType@campusapi.org", "..."],
"courseId": "course.Course:7922@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "syllabus not found" }
put /syllabi/{syllabusId}
Update a given syllabus.
URI Parameters
- syllabusId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Syllabus",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this syllabus, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this syllabus, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this syllabus for display.",
"type": "string"
},
"description": {
"description": "The description of this syllabus.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this syllabus. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this syllabus. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"courseId": {
"description": "The course associated with this syllabus.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Syllabus",
"description": "The description of this Syllabus"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The syllabus has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "syllabus not found" }
delete /syllabi/{syllabusId}
Delete a given syllabus.
URI Parameters
- syllabusId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The syllabus has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "syllabus not found" }
Entity representing a syllabus form metadata for update
get
Get form metadata for updating an existing syllabus.
get /syllabi/{syllabusId}/metadata
Get form metadata for updating an existing syllabus.
URI Parameters
- syllabusId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Syllabus",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this syllabus, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this syllabus, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this syllabus for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Syllabus.Syllabus:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this syllabus",
"linked": false
},
"description": {
"description": "The description of this syllabus.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Syllabus.Syllabus:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this syllabus",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this syllabus. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this syllabus. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "syllabus not found" }
/modules
Collection of modules in a system, federation of systems, or in a default courseCatalog.
get
Get all modules in the system or default courseCatalog.
post
Create a new module in the default courseCatalog.
get /modules
Get all modules in the system or default courseCatalog.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleModuleType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleModuleType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleModuleType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3690%40demo.dxtera.org - syllabusId: (string)
the id string to match a syllabus.
Example:
syllabus.Syllabus%3A384%40base.url - courseCatalogId: (string)
The id string to match a courseCatalog
Example:
course.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Module:9493@base.url",
"uri": "http://base.url/open/campusapi/syllabus/module/syllabus.Module%3A9493%40base.url",
"displayName": "Display Name of this Module",
"description": "The description of this Module",
"genusTypeId": "type.Type:defaultModuleType@base.url",
"recordTypeIds": [ "type.Type:exampleModuleRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Module@base.url",
"license": "The license that applies to this Module",
"syllabusId": "course.syllabus.Syllabus:1733@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /modules
Create a new module in the default courseCatalog.
Query Parameters
- syllabusId: required(string)
the syllabus of this module.
Example:
syllabus.Syllabus%3A384%40base.url - genusType: (string)
specify a particular module type to create
Example:
type.Type%3AexampleModuleType%40dxtera.org - recordType: (array of )
specify support for one or more module record types
Example:
[ "type.Type%3AexampleModuleRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this module
Example:
syllabus.CourseCatalog%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Module",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this module, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this module, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this module for display.",
"type": "string"
},
"description": {
"description": "The description of this module.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this module. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this module. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this module.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this module. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this module.",
"type": "string"
},
"active": {
"description": "Whether this module is active. Active is true if operational is true and disabled is false, or enabled is true.",
"type": "boolean",
"readOnly": true
},
"enabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this module is operational. This module is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"syllabusId": {
"description": "The syllabus associated with this module.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Module",
"description": "The description of this Module",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Module@base.url",
"license": "The license that applies to this Module"
}
Entity representing a module form metadata.
get
Get form metadata for creating a new module.
get /modules/metadata
Get form metadata for creating a new module.
Query Parameters
- syllabusId: required(string)
the syllabus of this metadatum.
Example:
syllabus.Syllabus%3A384%40base.url - genusType: (string)
specify a particular module type to create
Example:
type.Type%3AexampleModuleType%40dxtera.org - recordType: (array of )
specify support for one or more module record types
Example:
[ "type.Type%3AexampleModuleRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this module
Example:
syllabus.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Module",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this module, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this module, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this module for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this module",
"linked": false
},
"description": {
"description": "The description of this module.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this module",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this module. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this module. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this module.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this module",
"linked": false
},
"brandingIds": {
"description": "The branding of this module. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Module.Module:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this module",
"linked": false
},
"license": {
"description": "The licensing that applies to this module.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this module",
"linked": false
},
"enabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Module.Module:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this module is enabled",
"linked": false
},
"disabled": {
"description": "Whether this module is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Module.Module:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this module is enabled",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a module
get
Get a module given its id.
put
Update a given module.
delete
Delete a given module.
get /modules/{moduleId}
Get a module given its id.
URI Parameters
- moduleId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "syllabus.Module:9493@base.url",
"uri": "http://base.url/open/campusapi/syllabus/module/syllabus.Module%3A9493%40base.url",
"displayName": "Display Name of this Module",
"description": "The description of this Module",
"genusTypeId": "type.Type:defaultModuleType@base.url",
"recordTypeIds": [ "type.Type:exampleModuleRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Module@base.url",
"license": "The license that applies to this Module",
"syllabusId": "course.syllabus.Syllabus:1733@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "module not found" }
put /modules/{moduleId}
Update a given module.
URI Parameters
- moduleId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Module",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this module, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this module, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this module for display.",
"type": "string"
},
"description": {
"description": "The description of this module.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this module. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this module. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this module.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this module. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this module.",
"type": "string"
},
"active": {
"description": "Whether this module is active. Active is true if operational is true and disabled is false, or enabled is true.",
"type": "boolean",
"readOnly": true
},
"enabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this module is operational. This module is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"syllabusId": {
"description": "The syllabus associated with this module.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Module",
"description": "The description of this Module",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Module@base.url",
"license": "The license that applies to this Module"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The module has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "module not found" }
delete /modules/{moduleId}
Delete a given module.
URI Parameters
- moduleId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The module has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "module not found" }
Entity representing a module form metadata for update
get
Get form metadata for updating an existing module.
get /modules/{moduleId}/metadata
Get form metadata for updating an existing module.
URI Parameters
- moduleId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Module",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this module, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this module, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this module for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this module",
"linked": false
},
"description": {
"description": "The description of this module.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this module",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this module. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this module. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this module.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this module",
"linked": false
},
"brandingIds": {
"description": "The branding of this module. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Module.Module:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this module",
"linked": false
},
"license": {
"description": "The licensing that applies to this module.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Module.Module:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this module",
"linked": false
},
"enabled": {
"description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Module.Module:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this module is enabled",
"linked": false
},
"disabled": {
"description": "Whether this module is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Module.Module:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this module is enabled",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "module not found" }
/docets
Collection of docets in a system, federation of systems, or in a default courseCatalog.
get
Get all docets in the system or default courseCatalog.
post
Create a new docet in the default courseCatalog.
get /docets
Get all docets in the system or default courseCatalog.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleDocetType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleDocetType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleDocetType%40campusapi.org - fromDate: (string)
Get all docets from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all docets up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - moduleId: (string)
the id string to match a module.
Example:
syllabus.Module%3A240%40base.url - activityUnitId: (string)
the id string to match a activity-unit.
Example:
course.ActivityUnit%3A390%40base.url - courseCatalogId: (string)
The id string to match a courseCatalog
Example:
course.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Docet:9194@base.url",
"uri": "http://base.url/open/campusapi/syllabus/docet/syllabus.Docet%3A9194%40base.url",
"displayName": "Display Name of this Docet",
"description": "The description of this Docet",
"genusTypeId": "type.Type:defaultDocetType@base.url",
"recordTypeIds": [ "type.Type:exampleDocetRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9194@base.url",
"moduleId": "course.syllabus.Module:9105@base.url",
"activityUnitId": "course.ActivityUnit:318@base.url",
"learningObjectives": [ "learning.Objective:2935@base.url", "..." ],
"inClass": true,
"duration": "P3DT3H",
"assets": [ "repository.Asset:8938@base.url", "..." ],
"assessments": [ "assessment.Assessment:1417@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /docets
Create a new docet in the default courseCatalog.
Query Parameters
- moduleId: required(string)
the module of this docet.
Example:
syllabus.Module%3A240%40base.url - activityUnitId: required(string)
the activity-unit of this docet.
Example:
course.ActivityUnit%3A390%40base.url - genusType: (string)
specify a particular docet type to create
Example:
type.Type%3AexampleDocetType%40dxtera.org - recordType: (array of )
specify support for one or more docet record types
Example:
[ "type.Type%3AexampleDocetRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this docet
Example:
syllabus.CourseCatalog%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Docet",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this docet, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this docet, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this docet for display.",
"type": "string"
},
"description": {
"description": "The description of this docet.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this docet. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this docet. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this docet.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this docet.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this docet ended.",
"type": "string",
"format": "osid-id"
},
"moduleId": {
"description": "The module associated with this docet.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"activityUnitId": {
"description": "The activity unit associated with this docet.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"learningObjectiveIds": {
"description": "The learning objectives.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"inClass": {
"description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
"type": "boolean"
},
"duration": {
"description": "The estimated duration.",
"type": "string",
"format": "duration"
},
"assetIds": {
"description": "The assets distributed to the students.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"assessmentIds": {
"description": "The assessments.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Docet",
"description": "The description of this Docet",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6896@base.url",
"learningObjectives": [ "learning.Objective:1782@base.url", "..." ],
"inClass": true,
"duration": "P3DT3H",
"assets": [ "repository.Asset:4327@base.url", "..." ],
"assessments": [ "assessment.Assessment:1579@base.url", "..." ]
}
Entity representing a docet form metadata.
get
Get form metadata for creating a new docet.
get /docets/metadata
Get form metadata for creating a new docet.
Query Parameters
- moduleId: required(string)
the module of this metadatum.
Example:
syllabus.Module%3A240%40base.url - activityUnitId: required(string)
the activity-unit of this metadatum.
Example:
course.ActivityUnit%3A390%40base.url - genusType: (string)
specify a particular docet type to create
Example:
type.Type%3AexampleDocetType%40dxtera.org - recordType: (array of )
specify support for one or more docet record types
Example:
[ "type.Type%3AexampleDocetRecordType%40campusapi.org", "..." ] - courseCatalogId: (string)
specify in which course-catalog to create this docet
Example:
syllabus.CourseCatalog%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Docet",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this docet, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this docet, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this docet for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this docet",
"linked": false
},
"description": {
"description": "The description of this docet.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this docet",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this docet. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this docet. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this docet.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this docet",
"linked": false
},
"endDate": {
"description": "The ending date of this docet.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this docet",
"linked": false
},
"endReasonId": {
"description": "The reason this docet ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this docet ended",
"linked": false
},
"learningObjectives": {
"description": "The learning objectives.",
"type": "array",
"elementId": "course.syllabus.Docet:learningObjectives@dxtera.org",
"existingValue": [],
"elementLabel": "Learning Objectives",
"instructions": "Enter Ids for learning objectives of this docet.",
"linked": false
},
"inClass": {
"description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
"type": "boolean",
"elementId": "course.syllabus.Docet:inClass@dxtera.org",
"existingValue": false,
"elementLabel": "In Class",
"instructions": "Enter true or false.",
"linked": false
},
"duration": {
"description": "The estimated duration.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "course.syllabus.Docet:duration@dxtera.org",
"existingValue": "",
"elementLabel": "Duration",
"instructions": "Enter the duration of this docet.",
"linked": false
},
"assets": {
"description": "The assets distributed to the students.",
"type": "array",
"elementId": "course.syllabus.Docet:assets@dxtera.org",
"existingValue": [],
"elementLabel": "Assets",
"instructions": "Enter Ids for assets of this docet.",
"linked": false
},
"assessments": {
"description": "The assessments.",
"type": "array",
"elementId": "course.syllabus.Docet:assessments@dxtera.org",
"existingValue": [],
"elementLabel": "Assessments",
"instructions": "Enter Ids for assessments of this docet.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a docet
get
Get a docet given its id.
put
Update a given docet.
delete
Delete a given docet.
get /docets/{docetId}
Get a docet given its id.
URI Parameters
- docetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "syllabus.Docet:9194@base.url",
"uri": "http://base.url/open/campusapi/syllabus/docet/syllabus.Docet%3A9194%40base.url",
"displayName": "Display Name of this Docet",
"description": "The description of this Docet",
"genusTypeId": "type.Type:defaultDocetType@base.url",
"recordTypeIds": [ "type.Type:exampleDocetRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9194@base.url",
"moduleId": "course.syllabus.Module:9105@base.url",
"activityUnitId": "course.ActivityUnit:318@base.url",
"learningObjectives": [ "learning.Objective:2935@base.url", "..." ],
"inClass": true,
"duration": "P3DT3H",
"assets": [ "repository.Asset:8938@base.url", "..." ],
"assessments": [ "assessment.Assessment:1417@base.url", "..." ]
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "docet not found" }
put /docets/{docetId}
Update a given docet.
URI Parameters
- docetId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Docet",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this docet, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this docet, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this docet for display.",
"type": "string"
},
"description": {
"description": "The description of this docet.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this docet. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this docet. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this docet.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this docet.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this docet ended.",
"type": "string",
"format": "osid-id"
},
"moduleId": {
"description": "The module associated with this docet.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"activityUnitId": {
"description": "The activity unit associated with this docet.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"learningObjectiveIds": {
"description": "The learning objectives.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"inClass": {
"description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
"type": "boolean"
},
"duration": {
"description": "The estimated duration.",
"type": "string",
"format": "duration"
},
"assetIds": {
"description": "The assets distributed to the students.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"assessmentIds": {
"description": "The assessments.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
}
}
}Example:
{
"displayName": "Display Name of this Docet",
"description": "The description of this Docet",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6896@base.url",
"learningObjectives": [ "learning.Objective:1782@base.url", "..." ],
"inClass": true,
"duration": "P3DT3H",
"assets": [ "repository.Asset:4327@base.url", "..." ],
"assessments": [ "assessment.Assessment:1579@base.url", "..." ]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The docet has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "docet not found" }
delete /docets/{docetId}
Delete a given docet.
URI Parameters
- docetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The docet has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "docet not found" }
Entity representing a docet form metadata for update
get
Get form metadata for updating an existing docet.
get /docets/{docetId}/metadata
Get form metadata for updating an existing docet.
URI Parameters
- docetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Docet",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this docet, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this docet, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this docet for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this docet",
"linked": false
},
"description": {
"description": "The description of this docet.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this docet",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this docet. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this docet. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this docet.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this docet",
"linked": false
},
"endDate": {
"description": "The ending date of this docet.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this docet",
"linked": false
},
"endReasonId": {
"description": "The reason this docet ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Docet.Docet:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this docet ended",
"linked": false
},
"learningObjectives": {
"description": "The learning objectives.",
"type": "array",
"elementId": "course.syllabus.Docet:learningObjectives@dxtera.org",
"existingValue": [],
"elementLabel": "Learning Objectives",
"instructions": "Enter Ids for learning objectives of this docet.",
"linked": false
},
"inClass": {
"description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
"type": "boolean",
"elementId": "course.syllabus.Docet:inClass@dxtera.org",
"existingValue": false,
"elementLabel": "In Class",
"instructions": "Enter true or false.",
"linked": false
},
"duration": {
"description": "The estimated duration.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "course.syllabus.Docet:duration@dxtera.org",
"existingValue": "",
"elementLabel": "Duration",
"instructions": "Enter the duration of this docet.",
"linked": false
},
"assets": {
"description": "The assets distributed to the students.",
"type": "array",
"elementId": "course.syllabus.Docet:assets@dxtera.org",
"existingValue": [],
"elementLabel": "Assets",
"instructions": "Enter Ids for assets of this docet.",
"linked": false
},
"assessments": {
"description": "The assessments.",
"type": "array",
"elementId": "course.syllabus.Docet:assessments@dxtera.org",
"existingValue": [],
"elementLabel": "Assessments",
"instructions": "Enter Ids for assessments of this docet.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "docet not found" }
/course-catalogs
Collection of course-catalogs in a system or federation of systems.
get
Get all course-catalogs.
post
Create a new course-catalog.
get /course-catalogs
Get all course-catalogs.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleCourseCatalogType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleCourseCatalogType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleCourseCatalogType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - syllabusId: (string)
Get course-catalogs mapped to this syllabus.
Example:
syllabus.Syllabus%3A832%40demo.dxtera.org - moduleId: (string)
Get course-catalogs mapped to this module.
Example:
syllabus.Module%3A624%40demo.dxtera.org - docetId: (string)
Get course-catalogs mapped to this docet.
Example:
syllabus.Docet%3A520%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "course.CourseCatalog:2322@base.url",
"uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%40base.url",
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
"recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /course-catalogs
Create a new course-catalog.
Query Parameters
- genusType: (string)
specify a particular courseCatalog type to create
Example:
type.Type%3AexampleCourseCatalogType%40dxtera.org - recordType: (array of )
specify support for one or more courseCatalog record types
Example:
[ "type.Type%3AexampleCourseCatalogRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CourseCatalog",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this course catalog, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this course catalog, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this course catalog for display.",
"type": "string"
},
"description": {
"description": "The description of this course catalog.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this course catalog.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this course catalog. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this course catalog.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
}
Entity representing a courseCatalog form metadata.
get
Get form metadata for creating a new courseCatalog.
get /course-catalogs/metadata
Get form metadata for creating a new courseCatalog.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "CourseCatalog",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this course catalog, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this course catalog, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this course catalog for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this course catalog",
"linked": false
},
"description": {
"description": "The description of this course catalog.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this course catalog",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this course catalog.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this course catalog",
"linked": false
},
"brandingIds": {
"description": "The branding of this course catalog. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "CourseCatalog.CourseCatalog:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this course catalog",
"linked": false
},
"license": {
"description": "The licensing that applies to this course catalog.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this course catalog",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root courseCatalogs in the courseCatalog hierarchy. A node with no parents is an orphan. While all courseCatalog Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-course-catalog
get /course-catalogs/root-course-catalog
Get all root root-course-catalog
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "course.CourseCatalog:2322@base.url",
"uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%40base.url",
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
"recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a course-catalog
get
Get a course-catalog given its id.
put
Update a given course-catalog.
delete
Delete a given course-catalog.
get /course-catalogs/{courseCatalogId}
Get a course-catalog given its id.
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "course.CourseCatalog:2322@base.url",
"uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%40base.url",
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
"recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "course-catalog not found" }
put /course-catalogs/{courseCatalogId}
Update a given course-catalog.
URI Parameters
- courseCatalogId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CourseCatalog",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this course catalog, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this course catalog, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this course catalog for display.",
"type": "string"
},
"description": {
"description": "The description of this course catalog.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this course catalog.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this course catalog. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this course catalog.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The course-catalog has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "course-catalog not found" }
delete /course-catalogs/{courseCatalogId}
Delete a given course-catalog.
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The course-catalog has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "course-catalog not found" }
Entity representing a courseCatalog form metadata for update
get
Get form metadata for updating an existing courseCatalog.
get /course-catalogs/{courseCatalogId}/metadata
Get form metadata for updating an existing courseCatalog.
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "CourseCatalog",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this course catalog, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this course catalog, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this course catalog for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this course catalog",
"linked": false
},
"description": {
"description": "The description of this course catalog.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this course catalog",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this course catalog.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this course catalog",
"linked": false
},
"brandingIds": {
"description": "The branding of this course catalog. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "CourseCatalog.CourseCatalog:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this course catalog",
"linked": false
},
"license": {
"description": "The licensing that applies to this course catalog.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "CourseCatalog.CourseCatalog:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this course catalog",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "courseCatalog not found" }
get
Get child courseCatalogs for the given courseCatalog in the hierarchy.
get /course-catalogs/{courseCatalogId}/children
Get child courseCatalogs for the given courseCatalog in the hierarchy.
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "course.CourseCatalog:2322@base.url",
"uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%40base.url",
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
"recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add courseCatalog as child of the given courseCatalog in the hierarchy.
delete
Remove the given courseCatalog as a child of the given courseCatalog in the hierarchy.
put /course-catalogs/{courseCatalogId}/children/{childId}
Add courseCatalog as child of the given courseCatalog in the hierarchy.
URI Parameters
- courseCatalogId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child courseCatalog has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "courseCatalog not found" }
delete /course-catalogs/{courseCatalogId}/children/{childId}
Remove the given courseCatalog as a child of the given courseCatalog in the hierarchy.
URI Parameters
- courseCatalogId: required(string)
- childId: required(string)
get
Get parent courseCatalogs for the given courseCatalog in the hierarchy.
get /course-catalogs/{courseCatalogId}/parents
Get parent courseCatalogs for the given courseCatalog in the hierarchy.
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "course.CourseCatalog:2322@base.url",
"uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%40base.url",
"displayName": "Display Name of this CourseCatalog",
"description": "The description of this CourseCatalog",
"genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
"recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:CourseCatalog@base.url",
"license": "The license that applies to this CourseCatalog"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all syllabi in this courseCatalog
get /course-catalogs/{courseCatalogId}/syllabi
Get all syllabi in this courseCatalog
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Syllabus:2909@base.url",
"uri": "http://base.url/open/campusapi/syllabus/syllabus/syllabus.Syllabus%3A2909%40base.url",
"displayName": "Display Name of this Syllabus",
"description": "The description of this Syllabus",
"genusTypeId": "type.Type:defaultSyllabusType@base.url",
"recordTypeIds": [ "type.Type:exampleSyllabusRecordType@campusapi.org", "..."],
"courseId": "course.Course:7922@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given syllabus to this courseCatalog
delete
Remove the given syllabus from the courseCatalog.
put /course-catalogs/{courseCatalogId}/syllabi/{syllabusId}
Add the given syllabus to this courseCatalog
URI Parameters
- courseCatalogId: required(string)
- syllabusId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "syllabus has been added to courseCatalog" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "syllabus not found" }
delete /course-catalogs/{courseCatalogId}/syllabi/{syllabusId}
Remove the given syllabus from the courseCatalog.
URI Parameters
- courseCatalogId: required(string)
- syllabusId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "syllabus has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "syllabus not found" }
get
Get all modules in this courseCatalog
get /course-catalogs/{courseCatalogId}/modules
Get all modules in this courseCatalog
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Module:9493@base.url",
"uri": "http://base.url/open/campusapi/syllabus/module/syllabus.Module%3A9493%40base.url",
"displayName": "Display Name of this Module",
"description": "The description of this Module",
"genusTypeId": "type.Type:defaultModuleType@base.url",
"recordTypeIds": [ "type.Type:exampleModuleRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Module@base.url",
"license": "The license that applies to this Module",
"syllabusId": "course.syllabus.Syllabus:1733@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given module to this courseCatalog
delete
Remove the given module from the courseCatalog.
put /course-catalogs/{courseCatalogId}/modules/{moduleId}
Add the given module to this courseCatalog
URI Parameters
- courseCatalogId: required(string)
- moduleId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "module has been added to courseCatalog" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "module not found" }
delete /course-catalogs/{courseCatalogId}/modules/{moduleId}
Remove the given module from the courseCatalog.
URI Parameters
- courseCatalogId: required(string)
- moduleId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "module has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "module not found" }
get
Get all docets in this courseCatalog
get /course-catalogs/{courseCatalogId}/docets
Get all docets in this courseCatalog
URI Parameters
- courseCatalogId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "syllabus.Docet:9194@base.url",
"uri": "http://base.url/open/campusapi/syllabus/docet/syllabus.Docet%3A9194%40base.url",
"displayName": "Display Name of this Docet",
"description": "The description of this Docet",
"genusTypeId": "type.Type:defaultDocetType@base.url",
"recordTypeIds": [ "type.Type:exampleDocetRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9194@base.url",
"moduleId": "course.syllabus.Module:9105@base.url",
"activityUnitId": "course.ActivityUnit:318@base.url",
"learningObjectives": [ "learning.Objective:2935@base.url", "..." ],
"inClass": true,
"duration": "P3DT3H",
"assets": [ "repository.Asset:8938@base.url", "..." ],
"assessments": [ "assessment.Assessment:1417@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given docet to this courseCatalog
delete
Remove the given docet from the courseCatalog.
put /course-catalogs/{courseCatalogId}/docets/{docetId}
Add the given docet to this courseCatalog
URI Parameters
- courseCatalogId: required(string)
- docetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "docet has been added to courseCatalog" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "docet not found" }
delete /course-catalogs/{courseCatalogId}/docets/{docetId}
Remove the given docet from the courseCatalog.
URI Parameters
- courseCatalogId: required(string)
- docetId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "docet has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "docet not found" }