CampusAPI Assessment Services API documentation version 0.1.5
Based on OSID version 3.0.0

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "learningObjectives", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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%40base.url

• answerId: (string)

  Id string to match answer.

  Example:

  assessment.Answer%3A22%40base.url

• learningObjectiveId: (string)

  Id string to match learningObjective.

  Example:

  learning.Objective%3A4454%40base.url

• bankId: (string)

  The id string to match a bank

  Example:

  assessment.Bank%3A8374%40base.url

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:2215@base.url", "..." ]
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "learningObjectives", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ItemQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchLearningObjectiveIds": {
      "description": "List of Objective Ids for this query to match learningObjectives.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "learningObjectiveId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "learningObjectiveQueries": {
      "description": "learning.ObjectiveQueries to match the Learning Objectives. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyLearningObjective": {
      "description": "Match learning objectives with any value. true to match Items with any learning objectives, false to match Items with no learning objectives",
      "type": "boolean"
    },
    "matchBankIds": {
      "description": "List of Bank Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankId": {
            "description": "Bank id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "bankQueries": {
      "description": "BankQueries to match Bank. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• itemId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "learningObjectives", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:2215@base.url", "..." ]
}

URI Parameters

• itemId: required(string)

URI Parameters

• itemId: required(string)

URI Parameters

• itemId: required(string)

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"
}

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",
    "..."
  ]

URI Parameters

• itemId: required(string)
• questionId: required(string)

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"
}

URI Parameters

• itemId: required(string)
• questionId: required(string)

URI Parameters

• itemId: required(string)
• questionId: required(string)

URI Parameters

• itemId: required(string)

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"
}

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",
    "..."
  ]

URI Parameters

• itemId: required(string)
• answerId: required(string)

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"
}

URI Parameters

• itemId: required(string)
• answerId: required(string)

URI Parameters

• itemId: required(string)
• answerId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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:7939@base.url",
  "rubricId": "assessment.Assessment:8725@base.url"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchLevelIds": {
      "description": "List of Grade Ids for this query to match level.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "levelQueries": {
      "description": "grading.GradeQueries to match the Level. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyLevel": {
      "description": "Match level with any value. true to match Assessments with any level, false to match Assessments with no level",
      "type": "boolean"
    },
    "matchRubricIds": {
      "description": "List of Assessment Ids for this query to match rubric.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rubricId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "rubricQueries": {
      "description": "assessment.AssessmentQueries to match the Rubric. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyRubric": {
      "description": "Match rubric with any value. true to match Assessments with any rubric, false to match Assessments with no rubric",
      "type": "boolean"
    },
    "matchBankIds": {
      "description": "List of Bank Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankId": {
            "description": "Bank id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "bankQueries": {
      "description": "BankQueries to match Bank. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• assessmentId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:7939@base.url",
  "rubricId": "assessment.Assessment:8725@base.url"
}

URI Parameters

• assessmentId: required(string)

URI Parameters

• assessmentId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "scoreSystem", "gradeSystem", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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:6032@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:5552@base.url",
  "gradeSystemId": "grading.GradeSystem:5576@base.url"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "scoreSystem", "gradeSystem", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentOfferedQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAssessmentIds": {
      "description": "List of assessment Ids for this query to match assessment offered that have a related assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "AssessmentQueries to match the assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchLevelIds": {
      "description": "List of Grade Ids for this query to match level.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "levelQueries": {
      "description": "grading.GradeQueries to match the Level. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyLevel": {
      "description": "Match level with any value. true to match AssessmentsOffered with any level, false to match AssessmentsOffered with no level",
      "type": "boolean"
    },
    "matchItemsSequential": {
      "description": "Match boolean value for itemsSequential.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchItemsShuffled": {
      "description": "Match boolean value for itemsShuffled.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchStartTime": {
      "description": "Matches startTimes between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyStartTime": {
      "description": "Match startTimes with any value. true to match AssessmentsOffered with any start time, false to match ProgramOfferings with no start time",
      "type": "boolean"

    },
    "matchDeadline": {
      "description": "Matches deadlines between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDeadline": {
      "description": "Match deadlines with any value. true to match AssessmentsOffered with any deadline, false to match ProgramOfferings with no deadline",
      "type": "boolean"

    },
    "matchDuration": {
      "description": "Matches durations in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDuration": {
      "description": "Match durations with any value. true to match AssessmentsOffered with any duration, false to match ProgramOfferings with no duration",
      "type": "boolean"

    },
    "matchScoreSystemIds": {
      "description": "List of GradeSystem Ids for this query to match scoreSystem.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scoreSystemId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "scoreSystemQueries": {
      "description": "grading.GradeSystemQueries to match the Score System. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyScoreSystem": {
      "description": "Match score system with any value. true to match AssessmentsOffered with any score system, false to match AssessmentsOffered with no score system",
      "type": "boolean"
    },
    "matchGradeSystemIds": {
      "description": "List of GradeSystem Ids for this query to match gradeSystem.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradeSystemId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradeSystemQueries": {
      "description": "grading.GradeSystemQueries to match the Grade System. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyGradeSystem": {
      "description": "Match grade system with any value. true to match AssessmentsOffered with any grade system, false to match AssessmentsOffered with no grade system",
      "type": "boolean"
    },
    "matchBankIds": {
      "description": "List of Bank Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankId": {
            "description": "Bank id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "bankQueries": {
      "description": "BankQueries to match Bank. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• assessmentOfferedId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "scoreSystem", "gradeSystem", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:6032@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:5552@base.url",
  "gradeSystemId": "grading.GradeSystem:5576@base.url"
}

URI Parameters

• assessmentOfferedId: required(string)

URI Parameters

• assessmentOfferedId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "taker", "assessmentOffered", "takingAgent", "scoreSystem", "grade", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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%40base.url

• bankId: (string)

  The id string to match a bank

  Example:

  assessment.Bank%3A8374%40base.url

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:9273@base.url",
  "score": 3.14,
  "gradeId": "grading.Grade:1340@base.url",
  "feedback": "This is the Feedback",
  "rubricId": "assessment.AssessmentTaken:4371@base.url"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "taker", "assessmentOffered", "takingAgent", "scoreSystem", "grade", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentTakenQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchTakerIds": {
      "description": "List of taker Ids for this query to match assessment taken that have a related taker.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "takerQueries": {
      "description": "TakerQueries to match the taker. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchTakingAgentIds": {
      "description": "List of takingAgent Ids for this query to match assessment taken that have a related takingAgent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "takingAgentQueries": {
      "description": "TakingAgentQueries to match the takingAgent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchActualStartTimeIds": {
      "description": "List of actualStartTime Ids for this query to match assessment taken that have a related actualStartTime.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "actualStartTimeQueries": {
      "description": "ActualStartTimeQueries to match the actualStartTime. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAssessmentOfferedIds": {
      "description": "List of assessmentOffered Ids for this query to match assessment taken that have a related assessmentOffered.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentOfferedQueries": {
      "description": "AssessmentOfferedQueries to match the assessmentOffered. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchTakerIds": {
      "description": "List of Resource Ids for this query to match taker.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "takerId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "takerQueries": {
      "description": "resource.ResourceQueries to match the Taker. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyTaker": {
      "description": "Match taker with any value. true to match AssessmentsTaken with any taker, false to match AssessmentsTaken with no taker",
      "type": "boolean"
    },
    "matchBankIds": {
      "description": "List of Bank Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankId": {
            "description": "Bank id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "bankQueries": {
      "description": "BankQueries to match Bank. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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

URI Parameters

• assessmentTakenId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "taker", "assessmentOffered", "takingAgent", "scoreSystem", "grade", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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:9273@base.url",
  "score": 3.14,
  "gradeId": "grading.Grade:1340@base.url",
  "feedback": "This is the Feedback",
  "rubricId": "assessment.AssessmentTaken:4371@base.url"
}

URI Parameters

• assessmentTakenId: required(string)

URI Parameters

• assessmentTakenId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

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"
}

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BankQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Bank with any provider, false to match Bank with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Bank with any branding, false to match Bank with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchBankIds": {
      "description": "List of Bank Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankId": {
            "description": "Bank id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "bankQueries": {
      "description": "BankQueries to match Bank. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "assessment.Bank:239@base.url",
    "uri": "http://base.url/open/campusapi/assessment/bank/assessment.Bank%3A239%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" }

URI Parameters

• bankId: required(string)

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"
}

URI Parameters

• bankId: required(string)

URI Parameters

• bankId: required(string)

URI Parameters

• bankId: required(string)

URI Parameters

• bankId: required(string)
• childId: required(string)

URI Parameters

• bankId: required(string)
• childId: required(string)

URI Parameters

• bankId: required(string)

URI Parameters

• bankId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "learningObjectives", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• bankId: required(string)
• itemId: required(string)

URI Parameters

• bankId: required(string)
• itemId: required(string)

URI Parameters

• bankId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• bankId: required(string)
• assessmentId: required(string)

URI Parameters

• bankId: required(string)
• assessmentId: required(string)

URI Parameters

• bankId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "level", "scoreSystem", "gradeSystem", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• bankId: required(string)
• assessmentOfferedId: required(string)

URI Parameters

• bankId: required(string)
• assessmentOfferedId: required(string)

URI Parameters

• bankId: required(string)

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

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "taker", "assessmentOffered", "takingAgent", "scoreSystem", "grade", "rubric", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• bankId: required(string)
• assessmentTakenId: required(string)

URI Parameters

• bankId: required(string)
• assessmentTakenId: required(string)