CampusAPI Assessment Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/assessment
Overview
The Assessment package provides the means to create, access, and take assessments. An Assessment may represent a quiz, survey, or other evaluation that includes assessment Items. Assessment Items are extensible objects to capture various types of questions, such as a multiple choice or an asset submission.
The Assessment services define functionality to describe the flow of control and the relationships among the objects. Assessment Items are extensible objects to capture various types of questions, such as a multiple choice or an asset submission.
This package includes the following entities:
Questions
A Question represents the question portion of an assessment item.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this question, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this question, provided by system. | string(uri) |
| displayName | The name of this question for display. | string |
| description | The description of this question. | string |
| genusTypeId (read‑only) | Id of the immutable type of this question. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this question. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
Answers
An Answer represents the answer portion of an assessment item.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this answer, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this answer, provided by system. | string(uri) |
| displayName | The name of this answer for display. | string |
| description | The description of this answer. | string |
| genusTypeId (read‑only) | Id of the immutable type of this answer. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this answer. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
Items
An Item is an individual assessment item such as a question to be included in a test. Items always have a Question part and may also have one or more Answer parts
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this item, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this item, provided by system. | string(uri) |
| displayName | The name of this item for display. | string |
| description | The description of this item. | string |
| genusTypeId (read‑only) | Id of the immutable type of this item. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this item. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| learningObjectiveIds | Any Objectives corresponding to this item. References an array of learning.Objective objects. | string(osid‑id)[] |
| questionId | The Question. References an assessment.Question object. | string(osid‑id) |
| answerIds | The Answers. Questions may have more than one acceptable answer. References an array of assessment.Answers objects. | string(osid‑id)[] |
Assessments
An Assessment represents a sequence of assessment items. Basic assessment authoring functionality for simple Assessments (those without Sections or Parts and which do not support Sequencing rules) is supported. More complete and advanced Assessment authoring is covered in the Assessment Authoring service area.
An Assessment may have an accompanying rubric used for assessing performance. The rubric assessment is established canonically in this Assessment.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this assessment, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this assessment, provided by system. | string(uri) |
| displayName | The name of this assessment for display. | string |
| description | The description of this assessment. | string |
| genusTypeId (read‑only) | Id of the immutable type of this assessment. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this assessment. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| levelId | The Grade corresponding to the assessment difficulty. References a grading.Grade object | string(osid‑id) |
| rubricId | The rubric. References an assessment.Assessment object | string(osid‑id) |
AssessmentsOffered
An AssessmentOffered is an Assessment available for taking. Additional information can be included about when the assessment can be taken, its duration, whether assessment Items can be shuffled, whether they must be taken in sequence, etc.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this assessment offered, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this assessment offered, provided by system. | string(uri) |
| displayName | The name of this assessment offered for display. | string |
| description | The description of this assessment offered. | string |
| genusTypeId (read‑only) | Id of the immutable type of this assessment offered. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this assessment offered. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| assessmentId (read‑only) | The assessment associated with this assessment offered. References an assessment.Assessment object. | string(osid‑id) |
| levelId | The Grade corresponding to the assessment difficulty. References a grading.Grade object | string(osid‑id) |
| itemsSequential | Tests if the items or parts in this assessment are taken sequentially. | boolean |
| itemsShuffled | Tests if the items or parts appear in a random order. | boolean |
| startTime | The start time for this assessment. | string(date‑time) |
| deadline | The end time for this assessment. | string(date‑time) |
| duration | The duration for this assessment. | string(duration) |
| scoreSystemId | The grade system for the score. References a grading.GradeSystem object | string(osid‑id) |
| gradeSystemId | The grade system for the grade. References a grading.GradeSystem object | string(osid‑id) |
AssessmentsTaken
An AssessmentTaken is an AssessmentOffered that has been completed or in progress by a Taker (typically a student).
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this assessment taken, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this assessment taken, provided by system. | string(uri) |
| displayName | The name of this assessment taken for display. | string |
| description | The description of this assessment taken. | string |
| genusTypeId (read‑only) | Id of the immutable type of this assessment taken. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this assessment taken. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| takerId (read‑only) | The taker associated with this assessment taken. References a resource.Resource object. | string(osid‑id) |
| takingAgentId (read‑only) | The taking agent associated with this assessment taken. References an authentication.Agent object. | string(osid‑id) |
| actualStartTimeId (read‑only) | The actual start time associated with this assessment taken. References a calendaring.DateTime object. | string(osid‑id) |
| assessmentOfferedId (read‑only) | The assessment offered associated with this assessment taken. References an assessment.AssessmentOffered object. | string(osid‑id) |
| takerId | The Resource taking this assessment. References a resource.Resource object | string(osid‑id) |
Banks
Items, Assessments and all other "assessment" related entities can be organized into catalogs called Banks.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this bank, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this bank, provided by system. | string(uri) |
| displayName | The name of this bank for display. | string |
| description | The description of this bank. | string |
| genusTypeId (read‑only) | Id of the immutable type of this bank. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this bank. 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 bank. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this bank. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this bank. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/items
Collection of items in a system, federation of systems, or in a default bank.
get
Get all items in the system or default bank.
post
Create a new item in the default bank.
get /items
Get all items in the system or default bank.
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%3AexampleItemType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleItemType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleItemType%40campusapi.org - questionId: (string)
Id string to match question.
Example:
assessment.Question%3A7638%40demo.dxtera.org - answerId: (string)
Id string to match answer.
Example:
assessment.Answer%3A22%40demo.dxtera.org - learningObjectiveId: (string)
Id string to match learningObjective.
Example:
learning.Objective%3A4454%40demo.dxtera.org - bankId: (string)
The id string to match a bank
Example:
assessment.Bank%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Item:939@base.url",
"uri": "http://base.url/open/campusapi/assessment/item/assessment.Item%3A939%40base.url",
"displayName": "Display Name of this Item",
"description": "The description of this Item",
"genusTypeId": "type.Type:defaultItemType@base.url",
"recordTypeIds": [ "type.Type:exampleItemRecordType@campusapi.org", "..."],
"learningObjectiveIds": [ "learning.Objective:284@base.url", "..." ],
"questionId": "assessment.Question:7288@base.url",
"answerIds": [ "assessment.Answer:8724@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /items
Create a new item in the default bank.
Query Parameters
- genusType: (string)
specify a particular item type to create
Example:
type.Type%3AexampleItemType%40dxtera.org - recordType: (array of )
specify support for one or more item record types
Example:
[ "type.Type%3AexampleItemRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this item
Example:
assessment.Bank%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Item",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this item, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this item, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this item for display.",
"type": "string"
},
"description": {
"description": "The description of this item.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this item. 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 item. 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
},
"learningObjectiveIds": {
"description": "Any Objectives corresponding to this item.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"questionId": {
"description": "The question.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"answerIds": {
"description": "The answers.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Item",
"description": "The description of this Item",
"learningObjectiveIds": [ "learning.Objective:22@base.url", "..." ]
}
Entity representing a item form metadata.
get
Get form metadata for creating a new item.
get /items/metadata
Get form metadata for creating a new item.
Query Parameters
- genusType: (string)
specify a particular item type to create
Example:
type.Type%3AexampleItemType%40dxtera.org - recordType: (array of )
specify support for one or more item record types
Example:
[ "type.Type%3AexampleItemRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this item
Example:
assessment.Bank%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": "Item",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this item, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this item, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this item for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Item.Item:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this item",
"linked": false
},
"description": {
"description": "The description of this item.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Item.Item:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this item",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this item. 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 item. 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
},
"learningObjectiveIds": {
"description": "Any Objectives corresponding to this item.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"elementId": "assessment.Item:learningObjectives@dxtera.org",
"existingValue": [],
"elementLabel": "Learning Objectives",
"instructions": "Enter Ids for learning objectives of this item.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a item
get
Get a item given its id.
put
Update a given item.
delete
Delete a given item.
get /items/{itemId}
Get a item given its id.
URI Parameters
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.Item:939@base.url",
"uri": "http://base.url/open/campusapi/assessment/item/assessment.Item%3A939%40base.url",
"displayName": "Display Name of this Item",
"description": "The description of this Item",
"genusTypeId": "type.Type:defaultItemType@base.url",
"recordTypeIds": [ "type.Type:exampleItemRecordType@campusapi.org", "..."],
"learningObjectiveIds": [ "learning.Objective:284@base.url", "..." ],
"questionId": "assessment.Question:7288@base.url",
"answerIds": [ "assessment.Answer:8724@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": "item not found" }
put /items/{itemId}
Update a given item.
URI Parameters
- itemId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Item",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this item, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this item, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this item for display.",
"type": "string"
},
"description": {
"description": "The description of this item.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this item. 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 item. 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
},
"learningObjectiveIds": {
"description": "Any Objectives corresponding to this item.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"questionId": {
"description": "The question.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"answerIds": {
"description": "The answers.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Item",
"description": "The description of this Item",
"learningObjectiveIds": [ "learning.Objective:22@base.url", "..." ]
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The item 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": "item not found" }
delete /items/{itemId}
Delete a given item.
URI Parameters
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The item 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": "item not found" }
Entity representing a item form metadata for update
get
Get form metadata for updating an existing item.
get /items/{itemId}/metadata
Get form metadata for updating an existing item.
URI Parameters
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Item",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this item, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this item, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this item for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Item.Item:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this item",
"linked": false
},
"description": {
"description": "The description of this item.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Item.Item:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this item",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this item. 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 item. 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
},
"learningObjectiveIds": {
"description": "Any Objectives corresponding to this item.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"elementId": "assessment.Item:learningObjectives@dxtera.org",
"existingValue": [],
"elementLabel": "Learning Objectives",
"instructions": "Enter Ids for learning objectives of this item.",
"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": "item not found" }
Collection of questions in a system, federation of systems, or in a default bank.
get
Get all questions in the system or default bank.
post
Create a new question in the default bank.
get /items/{itemId}/questions
Get all questions in the system or default bank.
URI Parameters
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Question:1344@base.url",
"uri": "http://base.url/open/campusapi/assessment/question/assessment.Question%3A1344%40base.url",
"displayName": "Display Name of this Question",
"description": "The description of this Question",
"genusTypeId": "type.Type:defaultQuestionType@base.url",
"recordTypeIds": [ "type.Type:exampleQuestionRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /items/{itemId}/questions
Create a new question in the default bank.
URI Parameters
- itemId: required(string)
Query Parameters
- genusType: (string)
specify a particular question type to create
Example:
type.Type%3AexampleQuestionType%40dxtera.org - recordType: (array of )
specify support for one or more question record types
Example:
[ "type.Type%3AexampleQuestionRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Question",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this question, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this question, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this question for display.",
"type": "string"
},
"description": {
"description": "The description of this question.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this question. 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 question. 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
}
}
}Example:
{
"displayName": "Display Name of this Question",
"description": "The description of this Question"
}
Entity representing a question form metadata.
get
Get form metadata for creating a new question.
get /items/{itemId}/questions/metadata
Get form metadata for creating a new question.
URI Parameters
- itemId: required(string)
Query Parameters
- genusType: (string)
specify a particular question type to create
Example:
type.Type%3AexampleQuestionType%40dxtera.org - recordType: (array of )
specify support for one or more question record types
Example:
[ "type.Type%3AexampleQuestionRecordType%40campusapi.org", "..." ]
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Question",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this question, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this question, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this question for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Question.Question:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this question",
"linked": false
},
"description": {
"description": "The description of this question.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Question.Question:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this question",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this question. 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 question. 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 question
get
Get a question given its id.
put
Update a given question.
delete
Delete a given question.
get /items/{itemId}/questions/{questionId}
Get a question given its id.
URI Parameters
- itemId: required(string)
- questionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.Question:1344@base.url",
"uri": "http://base.url/open/campusapi/assessment/question/assessment.Question%3A1344%40base.url",
"displayName": "Display Name of this Question",
"description": "The description of this Question",
"genusTypeId": "type.Type:defaultQuestionType@base.url",
"recordTypeIds": [ "type.Type:exampleQuestionRecordType@campusapi.org", "..."]
}
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": "question not found" }
put /items/{itemId}/questions/{questionId}
Update a given question.
URI Parameters
- itemId: required(string)
- questionId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Question",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this question, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this question, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this question for display.",
"type": "string"
},
"description": {
"description": "The description of this question.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this question. 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 question. 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
}
}
}Example:
{
"displayName": "Display Name of this Question",
"description": "The description of this Question"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The question 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": "question not found" }
delete /items/{itemId}/questions/{questionId}
Delete a given question.
URI Parameters
- itemId: required(string)
- questionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The question 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": "question not found" }
Entity representing a question form metadata for update
get
Get form metadata for updating an existing question.
get /items/{itemId}/questions/{questionId}/metadata
Get form metadata for updating an existing question.
URI Parameters
- itemId: required(string)
- questionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Question",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this question, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this question, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this question for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Question.Question:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this question",
"linked": false
},
"description": {
"description": "The description of this question.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Question.Question:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this question",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this question. 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 question. 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": "question not found" }
Collection of answers in a system, federation of systems, or in a default bank.
get
Get all answers in the system or default bank.
post
Create a new answer in the default bank.
get /items/{itemId}/answers
Get all answers in the system or default bank.
URI Parameters
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Answer:4955@base.url",
"uri": "http://base.url/open/campusapi/assessment/answer/assessment.Answer%3A4955%40base.url",
"displayName": "Display Name of this Answer",
"description": "The description of this Answer",
"genusTypeId": "type.Type:defaultAnswerType@base.url",
"recordTypeIds": [ "type.Type:exampleAnswerRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /items/{itemId}/answers
Create a new answer in the default bank.
URI Parameters
- itemId: required(string)
Query Parameters
- genusType: (string)
specify a particular answer type to create
Example:
type.Type%3AexampleAnswerType%40dxtera.org - recordType: (array of )
specify support for one or more answer record types
Example:
[ "type.Type%3AexampleAnswerRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Answer",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this answer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this answer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this answer for display.",
"type": "string"
},
"description": {
"description": "The description of this answer.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this answer. 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 answer. 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
}
}
}Example:
{
"displayName": "Display Name of this Answer",
"description": "The description of this Answer"
}
Entity representing a answer form metadata.
get
Get form metadata for creating a new answer.
get /items/{itemId}/answers/metadata
Get form metadata for creating a new answer.
URI Parameters
- itemId: required(string)
Query Parameters
- genusType: (string)
specify a particular answer type to create
Example:
type.Type%3AexampleAnswerType%40dxtera.org - recordType: (array of )
specify support for one or more answer record types
Example:
[ "type.Type%3AexampleAnswerRecordType%40campusapi.org", "..." ]
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Answer",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this answer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this answer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this answer for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Answer.Answer:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this answer",
"linked": false
},
"description": {
"description": "The description of this answer.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Answer.Answer:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this answer",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this answer. 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 answer. 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 answer
get
Get a answer given its id.
put
Update a given answer.
delete
Delete a given answer.
get /items/{itemId}/answers/{answerId}
Get a answer given its id.
URI Parameters
- itemId: required(string)
- answerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.Answer:4955@base.url",
"uri": "http://base.url/open/campusapi/assessment/answer/assessment.Answer%3A4955%40base.url",
"displayName": "Display Name of this Answer",
"description": "The description of this Answer",
"genusTypeId": "type.Type:defaultAnswerType@base.url",
"recordTypeIds": [ "type.Type:exampleAnswerRecordType@campusapi.org", "..."]
}
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": "answer not found" }
put /items/{itemId}/answers/{answerId}
Update a given answer.
URI Parameters
- itemId: required(string)
- answerId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Answer",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this answer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this answer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this answer for display.",
"type": "string"
},
"description": {
"description": "The description of this answer.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this answer. 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 answer. 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
}
}
}Example:
{
"displayName": "Display Name of this Answer",
"description": "The description of this Answer"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The answer 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": "answer not found" }
delete /items/{itemId}/answers/{answerId}
Delete a given answer.
URI Parameters
- itemId: required(string)
- answerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The answer 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": "answer not found" }
Entity representing a answer form metadata for update
get
Get form metadata for updating an existing answer.
get /items/{itemId}/answers/{answerId}/metadata
Get form metadata for updating an existing answer.
URI Parameters
- itemId: required(string)
- answerId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Answer",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this answer, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this answer, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this answer for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Answer.Answer:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this answer",
"linked": false
},
"description": {
"description": "The description of this answer.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Answer.Answer:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this answer",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this answer. 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 answer. 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": "answer not found" }
/assessments
Collection of assessments in a system, federation of systems, or in a default bank.
get
Get all assessments in the system or default bank.
post
Create a new assessment in the default bank.
get /assessments
Get all assessments in the system or default bank.
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%3AexampleAssessmentType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAssessmentType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAssessmentType%40campusapi.org - bankId: (string)
The id string to match a bank
Example:
assessment.Bank%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Assessment:2288@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment/assessment.Assessment%3A2288%40base.url",
"displayName": "Display Name of this Assessment",
"description": "The description of this Assessment",
"genusTypeId": "type.Type:defaultAssessmentType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentRecordType@campusapi.org", "..."],
"levelId": "grading.Grade:9453@base.url",
"rubricId": "assessment.Assessment:9015@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /assessments
Create a new assessment in the default bank.
Query Parameters
- genusType: (string)
specify a particular assessment type to create
Example:
type.Type%3AexampleAssessmentType%40dxtera.org - recordType: (array of )
specify support for one or more assessment record types
Example:
[ "type.Type%3AexampleAssessmentRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessment
Example:
assessment.Bank%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Assessment",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment. 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 assessment. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"format": "osid-id"
},
"rubricId": {
"description": "The rubric.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Assessment",
"description": "The description of this Assessment",
"levelId": "grading.Grade:3813@base.url",
"rubricId": "assessment.Assessment:2166@base.url"
}
Entity representing a assessment form metadata.
get
Get form metadata for creating a new assessment.
get /assessments/metadata
Get form metadata for creating a new assessment.
Query Parameters
- genusType: (string)
specify a particular assessment type to create
Example:
type.Type%3AexampleAssessmentType%40dxtera.org - recordType: (array of )
specify support for one or more assessment record types
Example:
[ "type.Type%3AexampleAssessmentRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessment
Example:
assessment.Bank%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": "Assessment",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Assessment.Assessment:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment",
"linked": false
},
"description": {
"description": "The description of this assessment.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Assessment.Assessment:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment. 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 assessment. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.Assessment:level@dxtera.org",
"existingValue": null,
"elementLabel": "Level",
"instructions": "Enter the Id of the level for this assessment.",
"linked": false
},
"rubricId": {
"description": "The rubric.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.Assessment:rubric@dxtera.org",
"existingValue": null,
"elementLabel": "Rubric",
"instructions": "Enter the Id of the rubric for this assessment.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a assessment
get
Get a assessment given its id.
put
Update a given assessment.
delete
Delete a given assessment.
get /assessments/{assessmentId}
Get a assessment given its id.
URI Parameters
- assessmentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.Assessment:2288@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment/assessment.Assessment%3A2288%40base.url",
"displayName": "Display Name of this Assessment",
"description": "The description of this Assessment",
"genusTypeId": "type.Type:defaultAssessmentType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentRecordType@campusapi.org", "..."],
"levelId": "grading.Grade:9453@base.url",
"rubricId": "assessment.Assessment:9015@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": "assessment not found" }
put /assessments/{assessmentId}
Update a given assessment.
URI Parameters
- assessmentId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Assessment",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment. 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 assessment. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"format": "osid-id"
},
"rubricId": {
"description": "The rubric.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Assessment",
"description": "The description of this Assessment",
"levelId": "grading.Grade:3813@base.url",
"rubricId": "assessment.Assessment:2166@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessment 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": "assessment not found" }
delete /assessments/{assessmentId}
Delete a given assessment.
URI Parameters
- assessmentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessment 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": "assessment not found" }
Entity representing a assessment form metadata for update
get
Get form metadata for updating an existing assessment.
get /assessments/{assessmentId}/metadata
Get form metadata for updating an existing assessment.
URI Parameters
- assessmentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Assessment",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Assessment.Assessment:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment",
"linked": false
},
"description": {
"description": "The description of this assessment.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Assessment.Assessment:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment. 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 assessment. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.Assessment:level@dxtera.org",
"existingValue": null,
"elementLabel": "Level",
"instructions": "Enter the Id of the level for this assessment.",
"linked": false
},
"rubricId": {
"description": "The rubric.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.Assessment:rubric@dxtera.org",
"existingValue": null,
"elementLabel": "Rubric",
"instructions": "Enter the Id of the rubric for this assessment.",
"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": "assessment not found" }
/assessments-offered
Collection of assessments-offered in a system, federation of systems, or in a default bank.
get
Get all assessments-offered in the system or default bank.
post
Create a new assessments-offered in the default bank.
get /assessments-offered
Get all assessments-offered in the system or default bank.
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%3AexampleAssessmentOfferedType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAssessmentOfferedType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAssessmentOfferedType%40campusapi.org - assessmentId: (string)
the id string to match a assessment.
Example:
assessment.Assessment%3A1700%40base.url - fromDate: (string)
Get all assessments-offered from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all assessments-offered up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - bankId: (string)
The id string to match a bank
Example:
assessment.Bank%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.AssessmentOffered:4379@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_offered/assessment.AssessmentOffered%3A4379%40base.url",
"displayName": "Display Name of this AssessmentOffered",
"description": "The description of this AssessmentOffered",
"genusTypeId": "type.Type:defaultAssessmentOfferedType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentOfferedRecordType@campusapi.org", "..."],
"assessmentId": "assessment.Assessment:2188@base.url",
"levelId": "grading.Grade:4959@base.url",
"itemsSequential": true,
"itemsShuffled": true,
"startTime": "2020-10-03T08:00:00.000Z",
"deadline": "2021-07-21T23:15:30.123Z",
"duration": "P3DT3H",
"scoreSystemId": "grading.GradeSystem:2331@base.url",
"gradeSystemId": "grading.GradeSystem:2309@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /assessments-offered
Create a new assessments-offered in the default bank.
Query Parameters
- assessmentId: required(string)
the assessment of this assessments-offered.
Example:
assessment.Assessment%3A1700%40base.url - genusType: (string)
specify a particular assessmentOffered type to create
Example:
type.Type%3AexampleAssessmentOfferedType%40dxtera.org - recordType: (array of )
specify support for one or more assessmentOffered record types
Example:
[ "type.Type%3AexampleAssessmentOfferedRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessmentOffered
Example:
assessment.Bank%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AssessmentOffered",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment offered, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment offered, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment offered for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment offered.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment offered. 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 assessment offered. 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
},
"assessmentId": {
"description": "The assessment associated with this assessment offered.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"format": "osid-id"
},
"itemsSequential": {
"description": "Tests if the items or parts in this assessment are taken sequentially.",
"type": "boolean"
},
"itemsShuffled": {
"description": "Tests if the items or parts appear in a random order.",
"type": "boolean"
},
"startTime": {
"description": "The start time for this assessment.",
"type": "string",
"format": "date-time"
},
"deadline": {
"description": "The end time for this assessment.",
"type": "string",
"format": "date-time"
},
"duration": {
"description": "The duration for this assessment.",
"type": "string",
"format": "duration"
},
"scoreSystemId": {
"description": "The grade system for the score.",
"type": "string",
"format": "osid-id"
},
"gradeSystemId": {
"description": "The grade system for the grade.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this AssessmentOffered",
"description": "The description of this AssessmentOffered",
"levelId": "grading.Grade:1860@base.url",
"itemsSequential": true,
"itemsShuffled": true,
"startTime": "2020-10-03T08:00:00.000Z",
"deadline": "2021-07-21T23:15:30.123Z",
"duration": "P3DT3H",
"scoreSystemId": "grading.GradeSystem:9926@base.url",
"gradeSystemId": "grading.GradeSystem:8600@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-offered has been created",
"assessments-offeredId": "assessment.AssessmentsOffered:9876@demo.dxtera.org"}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a assessmentOffered form metadata.
get
Get form metadata for creating a new assessmentOffered.
get /assessments-offered/metadata
Get form metadata for creating a new assessmentOffered.
Query Parameters
- assessmentId: required(string)
the assessment of this metadatum.
Example:
assessment.Assessment%3A1700%40base.url - genusType: (string)
specify a particular assessmentOffered type to create
Example:
type.Type%3AexampleAssessmentOfferedType%40dxtera.org - recordType: (array of )
specify support for one or more assessmentOffered record types
Example:
[ "type.Type%3AexampleAssessmentOfferedRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessmentOffered
Example:
assessment.Bank%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": "AssessmentOffered",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment offered, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment offered, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment offered for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentOffered.AssessmentOffered:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment offered",
"linked": false
},
"description": {
"description": "The description of this assessment offered.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentOffered.AssessmentOffered:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment offered",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment offered. 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 assessment offered. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:level@dxtera.org",
"existingValue": null,
"elementLabel": "Level",
"instructions": "Enter the Id of the level for this assessment offered.",
"linked": false
},
"itemsSequential": {
"description": "Tests if the items or parts in this assessment are taken sequentially.",
"type": "boolean",
"elementId": "assessment.AssessmentOffered:itemsSequential@dxtera.org",
"existingValue": false,
"elementLabel": "Items Sequential",
"instructions": "Enter true or false.",
"linked": false
},
"itemsShuffled": {
"description": "Tests if the items or parts appear in a random order.",
"type": "boolean",
"elementId": "assessment.AssessmentOffered:itemsShuffled@dxtera.org",
"existingValue": false,
"elementLabel": "Items Shuffled",
"instructions": "Enter true or false.",
"linked": false
},
"startTime": {
"description": "The start time for this assessment.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:startTime@dxtera.org",
"existingValue": "",
"elementLabel": "Start Time",
"instructions": "Enter the start time of this assessment offered.",
"linked": false
},
"deadline": {
"description": "The end time for this assessment.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:deadline@dxtera.org",
"existingValue": "",
"elementLabel": "Deadline",
"instructions": "Enter the deadline of this assessment offered.",
"linked": false
},
"duration": {
"description": "The duration for this assessment.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:duration@dxtera.org",
"existingValue": "",
"elementLabel": "Duration",
"instructions": "Enter the duration of this assessment offered.",
"linked": false
},
"scoreSystemId": {
"description": "The grade system for the score.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:scoreSystem@dxtera.org",
"existingValue": null,
"elementLabel": "Score System",
"instructions": "Enter the Id of the score system for this assessment offered.",
"linked": false
},
"gradeSystemId": {
"description": "The grade system for the grade.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:gradeSystem@dxtera.org",
"existingValue": null,
"elementLabel": "Grade System",
"instructions": "Enter the Id of the grade system for this assessment offered.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a assessments-offered
get
Get a assessments-offered given its id.
put
Update a given assessments-offered.
delete
Delete a given assessments-offered.
get /assessments-offered/{assessmentOfferedId}
Get a assessments-offered given its id.
URI Parameters
- assessmentOfferedId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.AssessmentOffered:4379@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_offered/assessment.AssessmentOffered%3A4379%40base.url",
"displayName": "Display Name of this AssessmentOffered",
"description": "The description of this AssessmentOffered",
"genusTypeId": "type.Type:defaultAssessmentOfferedType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentOfferedRecordType@campusapi.org", "..."],
"assessmentId": "assessment.Assessment:2188@base.url",
"levelId": "grading.Grade:4959@base.url",
"itemsSequential": true,
"itemsShuffled": true,
"startTime": "2020-10-03T08:00:00.000Z",
"deadline": "2021-07-21T23:15:30.123Z",
"duration": "P3DT3H",
"scoreSystemId": "grading.GradeSystem:2331@base.url",
"gradeSystemId": "grading.GradeSystem:2309@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": "assessments-offered not found" }
put /assessments-offered/{assessmentOfferedId}
Update a given assessments-offered.
URI Parameters
- assessmentOfferedId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AssessmentOffered",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment offered, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment offered, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment offered for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment offered.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment offered. 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 assessment offered. 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
},
"assessmentId": {
"description": "The assessment associated with this assessment offered.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"format": "osid-id"
},
"itemsSequential": {
"description": "Tests if the items or parts in this assessment are taken sequentially.",
"type": "boolean"
},
"itemsShuffled": {
"description": "Tests if the items or parts appear in a random order.",
"type": "boolean"
},
"startTime": {
"description": "The start time for this assessment.",
"type": "string",
"format": "date-time"
},
"deadline": {
"description": "The end time for this assessment.",
"type": "string",
"format": "date-time"
},
"duration": {
"description": "The duration for this assessment.",
"type": "string",
"format": "duration"
},
"scoreSystemId": {
"description": "The grade system for the score.",
"type": "string",
"format": "osid-id"
},
"gradeSystemId": {
"description": "The grade system for the grade.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this AssessmentOffered",
"description": "The description of this AssessmentOffered",
"levelId": "grading.Grade:1860@base.url",
"itemsSequential": true,
"itemsShuffled": true,
"startTime": "2020-10-03T08:00:00.000Z",
"deadline": "2021-07-21T23:15:30.123Z",
"duration": "P3DT3H",
"scoreSystemId": "grading.GradeSystem:9926@base.url",
"gradeSystemId": "grading.GradeSystem:8600@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-offered 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": "assessments-offered not found" }
delete /assessments-offered/{assessmentOfferedId}
Delete a given assessments-offered.
URI Parameters
- assessmentOfferedId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-offered 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": "assessments-offered not found" }
Entity representing a assessmentOffered form metadata for update
get
Get form metadata for updating an existing assessmentOffered.
get /assessments-offered/{assessmentOfferedId}/metadata
Get form metadata for updating an existing assessmentOffered.
URI Parameters
- assessmentOfferedId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "AssessmentOffered",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment offered, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment offered, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment offered for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentOffered.AssessmentOffered:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment offered",
"linked": false
},
"description": {
"description": "The description of this assessment offered.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentOffered.AssessmentOffered:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment offered",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment offered. 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 assessment offered. 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
},
"levelId": {
"description": "The Grade corresponding to the assessment difficulty.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:level@dxtera.org",
"existingValue": null,
"elementLabel": "Level",
"instructions": "Enter the Id of the level for this assessment offered.",
"linked": false
},
"itemsSequential": {
"description": "Tests if the items or parts in this assessment are taken sequentially.",
"type": "boolean",
"elementId": "assessment.AssessmentOffered:itemsSequential@dxtera.org",
"existingValue": false,
"elementLabel": "Items Sequential",
"instructions": "Enter true or false.",
"linked": false
},
"itemsShuffled": {
"description": "Tests if the items or parts appear in a random order.",
"type": "boolean",
"elementId": "assessment.AssessmentOffered:itemsShuffled@dxtera.org",
"existingValue": false,
"elementLabel": "Items Shuffled",
"instructions": "Enter true or false.",
"linked": false
},
"startTime": {
"description": "The start time for this assessment.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:startTime@dxtera.org",
"existingValue": "",
"elementLabel": "Start Time",
"instructions": "Enter the start time of this assessment offered.",
"linked": false
},
"deadline": {
"description": "The end time for this assessment.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:deadline@dxtera.org",
"existingValue": "",
"elementLabel": "Deadline",
"instructions": "Enter the deadline of this assessment offered.",
"linked": false
},
"duration": {
"description": "The duration for this assessment.",
"type": "string",
"format": "duration",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:duration@dxtera.org",
"existingValue": "",
"elementLabel": "Duration",
"instructions": "Enter the duration of this assessment offered.",
"linked": false
},
"scoreSystemId": {
"description": "The grade system for the score.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:scoreSystem@dxtera.org",
"existingValue": null,
"elementLabel": "Score System",
"instructions": "Enter the Id of the score system for this assessment offered.",
"linked": false
},
"gradeSystemId": {
"description": "The grade system for the grade.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentOffered:gradeSystem@dxtera.org",
"existingValue": null,
"elementLabel": "Grade System",
"instructions": "Enter the Id of the grade system for this assessment offered.",
"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": "assessmentOffered not found" }
/assessments-taken
Collection of assessments-taken in a system, federation of systems, or in a default bank.
get
Get all assessments-taken in the system or default bank.
post
Create a new assessments-taken in the default bank.
get /assessments-taken
Get all assessments-taken in the system or default bank.
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%3AexampleAssessmentTakenType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAssessmentTakenType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAssessmentTakenType%40campusapi.org - takerId: (string)
the id string to match a taker.
Example:
resource.Resource%3A600%40base.url - takingAgentId: (string)
the id string to match a taking-agent.
Example:
authentication.Agent%3A2520%40base.url - actualStartTimeId: (string)
the id string to match a actual-start-time.
Example:
calendaring.DateTime%3A2805%40base.url - assessmentOfferedId: (string)
the id string to match a assessment-offered.
Example:
assessment.AssessmentOffered%3A2700%40base.url - assessmentId: (string)
Id string to match assessment.
Example:
assessment.Assessment%3A7836%40demo.dxtera.org - bankId: (string)
The id string to match a bank
Example:
assessment.Bank%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.AssessmentTaken:8301@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_taken/assessment.AssessmentTaken%3A8301%40base.url",
"displayName": "Display Name of this AssessmentTaken",
"description": "The description of this AssessmentTaken",
"genusTypeId": "type.Type:defaultAssessmentTakenType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentTakenRecordType@campusapi.org", "..."],
"takerId": "resource.Resource:6704@base.url",
"takingAgentId": "authentication.Agent:5876@base.url",
"actualStartTime": "2020-10-03T08:00:00.000Z",
"assessmentOfferedId": "assessment.AssessmentOffered:3034@base.url",
"completionTime": "2021-07-21T23:15:30.000Z",
"scoreSystemId": "grading.GradeSystem:8825@base.url",
"score": 3.14,
"gradeId": "grading.Grade:8462@base.url",
"feedback": "This is the Feedback",
"rubricId": "assessment.AssessmentTaken:5053@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /assessments-taken
Create a new assessments-taken in the default bank.
Query Parameters
- takerId: required(string)
the taker of this assessments-taken.
Example:
resource.Resource%3A600%40base.url - takingAgentId: required(string)
the taking-agent of this assessments-taken.
Example:
authentication.Agent%3A2520%40base.url - actualStartTimeId: required(string)
the actual-start-time of this assessments-taken.
Example:
calendaring.DateTime%3A2805%40base.url - assessmentOfferedId: required(string)
the assessment-offered of this assessments-taken.
Example:
assessment.AssessmentOffered%3A2700%40base.url - genusType: (string)
specify a particular assessmentTaken type to create
Example:
type.Type%3AexampleAssessmentTakenType%40dxtera.org - recordType: (array of )
specify support for one or more assessmentTaken record types
Example:
[ "type.Type%3AexampleAssessmentTakenRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessmentTaken
Example:
assessment.Bank%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AssessmentTaken",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment taken, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment taken, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment taken for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment taken.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment taken. 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 assessment taken. 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
},
"takerId": {
"description": "The taker associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"takingAgentId": {
"description": "The taking agent associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"actualStartTimeId": {
"description": "The actual start time associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"assessmentOfferedId": {
"description": "The assessment offered associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"takerId": {
"description": "The Resource taking this assessment.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this AssessmentTaken",
"description": "The description of this AssessmentTaken",
"completionTime": "2021-07-21T23:15:30.000Z",
"scoreSystemId": "grading.GradeSystem:5085@base.url",
"score": 3.14,
"gradeId": "grading.Grade:7785@base.url",
"feedback": "This is the Feedback",
"rubricId": "assessment.AssessmentTaken:5210@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-taken has been created",
"assessments-takenId": "assessment.AssessmentsTaken:9876@demo.dxtera.org"}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a assessmentTaken form metadata.
get
Get form metadata for creating a new assessmentTaken.
get /assessments-taken/metadata
Get form metadata for creating a new assessmentTaken.
Query Parameters
- takerId: required(string)
the taker of this metadatum.
Example:
resource.Resource%3A600%40base.url - takingAgentId: required(string)
the taking-agent of this metadatum.
Example:
authentication.Agent%3A2520%40base.url - actualStartTimeId: required(string)
the actual-start-time of this metadatum.
Example:
calendaring.DateTime%3A2805%40base.url - assessmentOfferedId: required(string)
the assessment-offered of this metadatum.
Example:
assessment.AssessmentOffered%3A2700%40base.url - genusType: (string)
specify a particular assessmentTaken type to create
Example:
type.Type%3AexampleAssessmentTakenType%40dxtera.org - recordType: (array of )
specify support for one or more assessmentTaken record types
Example:
[ "type.Type%3AexampleAssessmentTakenRecordType%40campusapi.org", "..." ] - bankId: (string)
specify in which bank to create this assessmentTaken
Example:
assessment.Bank%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": "AssessmentTaken",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment taken, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment taken, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment taken for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentTaken.AssessmentTaken:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment taken",
"linked": false
},
"description": {
"description": "The description of this assessment taken.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentTaken.AssessmentTaken:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment taken",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment taken. 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 assessment taken. 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
},
"takerId": {
"description": "The Resource taking this assessment.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentTaken:taker@dxtera.org",
"existingValue": null,
"elementLabel": "Taker",
"instructions": "Enter the Id of the taker for this assessment taken.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a assessments-taken
get
Get a assessments-taken given its id.
put
Update a given assessments-taken.
delete
Delete a given assessments-taken.
get /assessments-taken/{assessmentTakenId}
Get a assessments-taken given its id.
URI Parameters
- assessmentTakenId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.AssessmentTaken:8301@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_taken/assessment.AssessmentTaken%3A8301%40base.url",
"displayName": "Display Name of this AssessmentTaken",
"description": "The description of this AssessmentTaken",
"genusTypeId": "type.Type:defaultAssessmentTakenType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentTakenRecordType@campusapi.org", "..."],
"takerId": "resource.Resource:6704@base.url",
"takingAgentId": "authentication.Agent:5876@base.url",
"actualStartTime": "2020-10-03T08:00:00.000Z",
"assessmentOfferedId": "assessment.AssessmentOffered:3034@base.url",
"completionTime": "2021-07-21T23:15:30.000Z",
"scoreSystemId": "grading.GradeSystem:8825@base.url",
"score": 3.14,
"gradeId": "grading.Grade:8462@base.url",
"feedback": "This is the Feedback",
"rubricId": "assessment.AssessmentTaken:5053@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": "assessments-taken not found" }
put /assessments-taken/{assessmentTakenId}
Update a given assessments-taken.
URI Parameters
- assessmentTakenId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AssessmentTaken",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this assessment taken, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment taken, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment taken for display.",
"type": "string"
},
"description": {
"description": "The description of this assessment taken.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment taken. 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 assessment taken. 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
},
"takerId": {
"description": "The taker associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"takingAgentId": {
"description": "The taking agent associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"actualStartTimeId": {
"description": "The actual start time associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"assessmentOfferedId": {
"description": "The assessment offered associated with this assessment taken.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"takerId": {
"description": "The Resource taking this assessment.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this AssessmentTaken",
"description": "The description of this AssessmentTaken",
"completionTime": "2021-07-21T23:15:30.000Z",
"scoreSystemId": "grading.GradeSystem:5085@base.url",
"score": 3.14,
"gradeId": "grading.Grade:7785@base.url",
"feedback": "This is the Feedback",
"rubricId": "assessment.AssessmentTaken:5210@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-taken 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": "assessments-taken not found" }
delete /assessments-taken/{assessmentTakenId}
Delete a given assessments-taken.
URI Parameters
- assessmentTakenId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The assessments-taken 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": "assessments-taken not found" }
Entity representing a assessmentTaken form metadata for update
get
Get form metadata for updating an existing assessmentTaken.
get /assessments-taken/{assessmentTakenId}/metadata
Get form metadata for updating an existing assessmentTaken.
URI Parameters
- assessmentTakenId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "AssessmentTaken",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this assessment taken, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this assessment taken, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this assessment taken for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentTaken.AssessmentTaken:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this assessment taken",
"linked": false
},
"description": {
"description": "The description of this assessment taken.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "AssessmentTaken.AssessmentTaken:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this assessment taken",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this assessment taken. 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 assessment taken. 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
},
"takerId": {
"description": "The Resource taking this assessment.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "assessment.AssessmentTaken:taker@dxtera.org",
"existingValue": null,
"elementLabel": "Taker",
"instructions": "Enter the Id of the taker for this assessment taken.",
"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": "assessmentTaken not found" }
/banks
Collection of banks in a system or federation of systems.
get
Get all banks.
post
Create a new bank.
get /banks
Get all banks.
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%3AexampleBankType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBankType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleBankType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - questionId: (string)
Get banks mapped to this question.
Example:
assessment.Question%3A320%40demo.dxtera.org - answerId: (string)
Get banks mapped to this answer.
Example:
assessment.Answer%3A240%40demo.dxtera.org - itemId: (string)
Get banks mapped to this item.
Example:
assessment.Item%3A160%40demo.dxtera.org - assessmentId: (string)
Get banks mapped to this assessment.
Example:
assessment.Assessment%3A400%40demo.dxtera.org - assessmentOfferedId: (string)
Get banks mapped to this assessment-offered.
Example:
assessment.AssessmentOffered%3A720%40demo.dxtera.org - assessmentTakenId: (string)
Get banks mapped to this assessment-taken.
Example:
assessment.AssessmentTaken%3A640%40demo.dxtera.org - assessmentSectionId: (string)
Get banks mapped to this assessment-section.
Example:
assessment.AssessmentSection%3A720%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Bank:7706@base.url",
"uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A7706%40base.url",
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"genusTypeId": "type.Type:defaultBankType@base.url",
"recordTypeIds": [ "type.Type:exampleBankRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /banks
Create a new bank.
Query Parameters
- genusType: (string)
specify a particular bank type to create
Example:
type.Type%3AexampleBankType%40dxtera.org - recordType: (array of )
specify support for one or more bank record types
Example:
[ "type.Type%3AexampleBankRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Bank",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this bank, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bank, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bank for display.",
"type": "string"
},
"description": {
"description": "The description of this bank.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this bank. 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 bank. 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 bank.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this bank. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this bank.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
}
Entity representing a bank form metadata.
get
Get form metadata for creating a new bank.
get /banks/metadata
Get form metadata for creating a new bank.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Bank",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this bank, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bank, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bank for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this bank",
"linked": false
},
"description": {
"description": "The description of this bank.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this bank",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this bank. 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 bank. 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 bank.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this bank",
"linked": false
},
"brandingIds": {
"description": "The branding of this bank. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Bank.Bank:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this bank",
"linked": false
},
"license": {
"description": "The licensing that applies to this bank.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this bank",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root banks in the bank hierarchy. A node with no parents is an orphan. While all bank 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-bank
get /banks/root-bank
Get all root root-bank
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Bank:7706@base.url",
"uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A7706%40base.url",
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"genusTypeId": "type.Type:defaultBankType@base.url",
"recordTypeIds": [ "type.Type:exampleBankRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a bank
get
Get a bank given its id.
put
Update a given bank.
delete
Delete a given bank.
get /banks/{bankId}
Get a bank given its id.
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "assessment.Bank:7706@base.url",
"uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A7706%40base.url",
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"genusTypeId": "type.Type:defaultBankType@base.url",
"recordTypeIds": [ "type.Type:exampleBankRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
}
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": "bank not found" }
put /banks/{bankId}
Update a given bank.
URI Parameters
- bankId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Bank",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this bank, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bank, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bank for display.",
"type": "string"
},
"description": {
"description": "The description of this bank.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this bank. 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 bank. 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 bank.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this bank. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this bank.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The bank 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": "bank not found" }
delete /banks/{bankId}
Delete a given bank.
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The bank 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": "bank not found" }
Entity representing a bank form metadata for update
get
Get form metadata for updating an existing bank.
get /banks/{bankId}/metadata
Get form metadata for updating an existing bank.
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Bank",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this bank, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bank, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bank for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this bank",
"linked": false
},
"description": {
"description": "The description of this bank.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this bank",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this bank. 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 bank. 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 bank.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this bank",
"linked": false
},
"brandingIds": {
"description": "The branding of this bank. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Bank.Bank:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this bank",
"linked": false
},
"license": {
"description": "The licensing that applies to this bank.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bank.Bank:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this bank",
"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": "bank not found" }
get
Get child banks for the given bank in the hierarchy.
get /banks/{bankId}/children
Get child banks for the given bank in the hierarchy.
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Bank:7706@base.url",
"uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A7706%40base.url",
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"genusTypeId": "type.Type:defaultBankType@base.url",
"recordTypeIds": [ "type.Type:exampleBankRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add bank as child of the given bank in the hierarchy.
delete
Remove the given bank as a child of the given bank in the hierarchy.
put /banks/{bankId}/children/{childId}
Add bank as child of the given bank in the hierarchy.
URI Parameters
- bankId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child bank 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": "bank not found" }
delete /banks/{bankId}/children/{childId}
Remove the given bank as a child of the given bank in the hierarchy.
URI Parameters
- bankId: required(string)
- childId: required(string)
get
Get parent banks for the given bank in the hierarchy.
get /banks/{bankId}/parents
Get parent banks for the given bank in the hierarchy.
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Bank:7706@base.url",
"uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A7706%40base.url",
"displayName": "Display Name of this Bank",
"description": "The description of this Bank",
"genusTypeId": "type.Type:defaultBankType@base.url",
"recordTypeIds": [ "type.Type:exampleBankRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Bank@base.url",
"license": "The license that applies to this Bank"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all items in this bank
get /banks/{bankId}/items
Get all items in this bank
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Item:939@base.url",
"uri": "http://base.url/open/campusapi/assessment/item/assessment.Item%3A939%40base.url",
"displayName": "Display Name of this Item",
"description": "The description of this Item",
"genusTypeId": "type.Type:defaultItemType@base.url",
"recordTypeIds": [ "type.Type:exampleItemRecordType@campusapi.org", "..."],
"learningObjectiveIds": [ "learning.Objective:284@base.url", "..." ],
"questionId": "assessment.Question:7288@base.url",
"answerIds": [ "assessment.Answer:8724@base.url", "..." ]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given item to this bank
delete
Remove the given item from the bank.
put /banks/{bankId}/items/{itemId}
Add the given item to this bank
URI Parameters
- bankId: required(string)
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "item has been added to bank" }
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": "item not found" }
delete /banks/{bankId}/items/{itemId}
Remove the given item from the bank.
URI Parameters
- bankId: required(string)
- itemId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "item 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": "item not found" }
get
Get all assessments in this bank
get /banks/{bankId}/assessments
Get all assessments in this bank
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.Assessment:2288@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment/assessment.Assessment%3A2288%40base.url",
"displayName": "Display Name of this Assessment",
"description": "The description of this Assessment",
"genusTypeId": "type.Type:defaultAssessmentType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentRecordType@campusapi.org", "..."],
"levelId": "grading.Grade:9453@base.url",
"rubricId": "assessment.Assessment:9015@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given assessment to this bank
delete
Remove the given assessment from the bank.
put /banks/{bankId}/assessments/{assessmentId}
Add the given assessment to this bank
URI Parameters
- bankId: required(string)
- assessmentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessment has been added to bank" }
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": "assessment not found" }
delete /banks/{bankId}/assessments/{assessmentId}
Remove the given assessment from the bank.
URI Parameters
- bankId: required(string)
- assessmentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessment 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": "assessment not found" }
get
Get all assessments-offered in this bank
get /banks/{bankId}/assessments-offered
Get all assessments-offered in this bank
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.AssessmentOffered:4379@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_offered/assessment.AssessmentOffered%3A4379%40base.url",
"displayName": "Display Name of this AssessmentOffered",
"description": "The description of this AssessmentOffered",
"genusTypeId": "type.Type:defaultAssessmentOfferedType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentOfferedRecordType@campusapi.org", "..."],
"assessmentId": "assessment.Assessment:2188@base.url",
"levelId": "grading.Grade:4959@base.url",
"itemsSequential": true,
"itemsShuffled": true,
"startTime": "2020-10-03T08:00:00.000Z",
"deadline": "2021-07-21T23:15:30.123Z",
"duration": "P3DT3H",
"scoreSystemId": "grading.GradeSystem:2331@base.url",
"gradeSystemId": "grading.GradeSystem:2309@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given assessments-offered to this bank
delete
Remove the given assessments-offered from the bank.
put /banks/{bankId}/assessments-offered/{assessmentOfferedId}
Add the given assessments-offered to this bank
URI Parameters
- bankId: required(string)
- assessmentOfferedId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessments-offered has been added to bank" }
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": "assessments-offered not found" }
delete /banks/{bankId}/assessments-offered/{assessmentOfferedId}
Remove the given assessments-offered from the bank.
URI Parameters
- bankId: required(string)
- assessmentOfferedId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessments-offered 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": "assessments-offered not found" }
get
Get all assessments-taken in this bank
get /banks/{bankId}/assessments-taken
Get all assessments-taken in this bank
URI Parameters
- bankId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "assessment.AssessmentTaken:8301@base.url",
"uri": "http://base.url/open/campusapi/assessment/assessment_taken/assessment.AssessmentTaken%3A8301%40base.url",
"displayName": "Display Name of this AssessmentTaken",
"description": "The description of this AssessmentTaken",
"genusTypeId": "type.Type:defaultAssessmentTakenType@base.url",
"recordTypeIds": [ "type.Type:exampleAssessmentTakenRecordType@campusapi.org", "..."],
"takerId": "resource.Resource:6704@base.url",
"takingAgentId": "authentication.Agent:5876@base.url",
"actualStartTime": "2020-10-03T08:00:00.000Z",
"assessmentOfferedId": "assessment.AssessmentOffered:3034@base.url",
"completionTime": "2021-07-21T23:15:30.000Z",
"scoreSystemId": "grading.GradeSystem:8825@base.url",
"score": 3.14,
"gradeId": "grading.Grade:8462@base.url",
"feedback": "This is the Feedback",
"rubricId": "assessment.AssessmentTaken:5053@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given assessments-taken to this bank
delete
Remove the given assessments-taken from the bank.
put /banks/{bankId}/assessments-taken/{assessmentTakenId}
Add the given assessments-taken to this bank
URI Parameters
- bankId: required(string)
- assessmentTakenId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessments-taken has been added to bank" }
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": "assessments-taken not found" }
delete /banks/{bankId}/assessments-taken/{assessmentTakenId}
Remove the given assessments-taken from the bank.
URI Parameters
- bankId: required(string)
- assessmentTakenId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "assessments-taken 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": "assessments-taken not found" }