CampusAPI Grading Services API documentation version 0.1.2
Based on OSID version 3.0.0

https://base.url/grading

Overview

The Grading service package defines functions for applying and managing grades or ratings.

This package includes the following entities:

Grades

Grades represent qualified performance levels defined within some grading system.

FieldDescriptionType
id(read‑only)The unique id of this grade, provided by system.string(osid‑id)
uri(read‑only)The uri of this grade, provided by system.string(uri)
displayNameThe name of this grade for display.string
descriptionThe description of this grade.string
genusTypeId
(read‑only)		Id of the immutable type of this grade. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this grade. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
gradeSystemId
(read‑only)		The grade system associated with this grade. References a grading.GradeSystem object.string(osid‑id)
inputScoreStartRangeThe low end of the input score range equivalent to this grade.number
inputScoreEndRangeThe high end of the input score range equivalent to this grade.number
outputScoreThe output score for this grade used for calculating cumultives or performing articulation.number

GradeSystems

GradeSystems provide the means to retrievs and manage GradeSystem definitions. A GradeSystem is a fixed set of Grades. GradeSystems may also take the form of a numerical score as well as a rating based on some system. GradeEntries belong to a single GradebookColumn.

FieldDescriptionType
id(read‑only)The unique id of this grade system, provided by system.string(osid‑id)
uri(read‑only)The uri of this grade system, provided by system.string(uri)
displayNameThe name of this grade system for display.string
descriptionThe description of this grade system.string
genusTypeId
(read‑only)		Id of the immutable type of this grade system. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this grade system. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
basedOnGradesTests if the grading system is based on grades.boolean
lowestNumericScoreThe lowest number in a numeric grading system.number
numericScoreIncrementThe incremental step.number
highestNumericScoreThe highest number in a numeric grading system.number

GradeEntries

A GradebookColumn is comprised of a series of GradeEntry elements. A GradebookColumn may represent "Assignment 3" while a GradeEntry may represent the assignment turned in by a particular student.

A Grade can be applied to a GradeEntry that relates the entry to a grader and a key Resource. In the case of a class gradebook, the key resource represents the student. If there are multiple graders for the same key resource, each grader gets their own GradebookColumn.

Gradebooks may also be used to capture ratings about other objects. In the case where people vote for their favorite assets, the key resource represents the Asset.

FieldDescriptionType
id(read‑only)The unique id of this grade entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this grade entry, provided by system.string(uri)
displayNameThe name of this grade entry for display.string
descriptionThe description of this grade entry.string
genusTypeId
(read‑only)		Id of the immutable type of this grade entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this grade entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
startDateThe starting date of this grade entry.string(date‑time)
endDateThe ending date of this grade entry.string(date‑time)
endReasonIdThe reason this grade entry ended. References a process.State object.string(osid‑id)
gradebookColumnId
(read‑only)		The gradebook column associated with this grade entry. References a grading.GradebookColumn object.string(osid‑id)
keyResourceId
(read‑only)		The key resource associated with this grade entry. References a resource.Resource object.string(osid‑id)
ignoredForCalculationsTests if this is entry should be ignored in any averaging, scaling or curve calculation.boolean
gradeIdThe grade in this entry if the grading system is based on grades. References a grading.Grade objectstring(osid‑id)
scoreThe score in this entry if the grading system is not based on grades.number

GradebookColumns

A Gradebook is represented by a series of GradebookColumns. A GradeBookColumn represents a something to be graded and is joined to a single GradeSystem. A GradebookColumn may be constrained to a single grader.

FieldDescriptionType
id(read‑only)The unique id of this gradebook column, provided by system.string(osid‑id)
uri(read‑only)The uri of this gradebook column, provided by system.string(uri)
displayNameThe name of this gradebook column for display.string
descriptionThe description of this gradebook column.string
genusTypeId
(read‑only)		Id of the immutable type of this gradebook column. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this gradebook column. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
gradeSystemIdThe GradeSystem in which this grade belongs. References a grading.GradeSystem objectstring(osid‑id)

Gradebooks

GradebookColumns are organized into Gradebooks. Gradebooks also provide for a federated hierarchy of GradebookColumns. Simple reordering of GradebookColumns can be performed by moving the GradebookColumn relative to another. The relative positioning may reference two GradebookColumns through the federation.

FieldDescriptionType
id(read‑only)The unique id of this gradebook, provided by system.string(osid‑id)
uri(read‑only)The uri of this gradebook, provided by system.string(uri)
displayNameThe name of this gradebook for display.string
descriptionThe description of this gradebook.string
genusTypeId
(read‑only)		Id of the immutable type of this gradebook. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this gradebook. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
providerIdThe provider of this gradebook. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this gradebook. References repository.Asset objects.string(osid‑id)[]
licenseThe licensing that applies to this gradebook.string

License

CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org

/grade-systems

Collection of grade-systems in a system, federation of systems, or in a default gradebook.

get post

get

Get all grade-systems in the system or default gradebook.

post

Create a new grade-system in the default gradebook.

Create a new grade-system in the default gradebook.

Query Parameters

  • genusType: (string)

    specify a particular gradeSystem type to create

    Example:

    type.Type%3AexampleGradeSystemType%40dxtera.org
  • recordType: (array of )

    specify support for one or more gradeSystem record types

    Example:

    [
  "type.Type%3AexampleGradeSystemRecordType%40campusapi.org",
  "..."
]
  • gradebookId: (string)

    specify in which gradebook to create this gradeSystem

    Example:

    grading.Gradebook%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradeSystem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this grade system, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade system, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade system for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this grade system.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade system. 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 grade system. 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
    },
    "basedOnGrades": {
      "description": "Tests if the grading system is based on grades.",
      "type": "boolean"
    },
    "lowestNumericScore": {
      "description": "The lowest number in a numeric grading system.",
      "type": "number"
    },
    "numericScoreIncrement": {
      "description": "The incremental step.",
      "type": "number"
    },
    "highestNumericScore": {
      "description": "The highest number in a numeric grading system.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradeSystem",
  "description": "The description of this GradeSystem",
  "basedOnGrades": true,
  "lowestNumericScore": 3.14,
  "numericScoreIncrement": 3.14,
  "highestNumericScore": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-system has been created",
  "grade-systemId": "grading.GradeSystem:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a gradeSystem form metadata.

get

Get form metadata for creating a new gradeSystem.

get put delete

Entity representing a grade-system

get

Get a grade-system given its id.

put

Update a given grade-system.

delete

Delete a given grade-system.

Get a grade-system given its id.

URI Parameters

  • gradeSystemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "grading.GradeSystem:939@base.url",
  "uri": "http://base.url/open/campusapi/grading/grade_system/grading.GradeSystem%3A939%40base.url",
  "displayName": "Display Name of this GradeSystem",
  "description": "The description of this GradeSystem",
  "genusTypeId": "type.Type:defaultGradeSystemType@base.url",
  "recordTypeIds": [ "type.Type:exampleGradeSystemRecordType@campusapi.org", "..."],
  "basedOnGrades": true,
  "lowestNumericScore": 3.14,
  "numericScoreIncrement": 3.14,
  "highestNumericScore": 3.14
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-system not found" }

Update a given grade-system.

URI Parameters

  • gradeSystemId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradeSystem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this grade system, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade system, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade system for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this grade system.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade system. 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 grade system. 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
    },
    "basedOnGrades": {
      "description": "Tests if the grading system is based on grades.",
      "type": "boolean"
    },
    "lowestNumericScore": {
      "description": "The lowest number in a numeric grading system.",
      "type": "number"
    },
    "numericScoreIncrement": {
      "description": "The incremental step.",
      "type": "number"
    },
    "highestNumericScore": {
      "description": "The highest number in a numeric grading system.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradeSystem",
  "description": "The description of this GradeSystem",
  "basedOnGrades": true,
  "lowestNumericScore": 3.14,
  "numericScoreIncrement": 3.14,
  "highestNumericScore": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-system has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-system not found" }

Delete a given grade-system.

URI Parameters

  • gradeSystemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-system has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-system not found" }

get

Entity representing a gradeSystem form metadata for update

get

Get form metadata for updating an existing gradeSystem.

Get form metadata for updating an existing gradeSystem.

URI Parameters

  • gradeSystemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "GradeSystem",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this grade system, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade system, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade system for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeSystem.GradeSystem:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this grade system",
      "linked": false
    },
    "description": {
      "description": "The description of this grade system.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeSystem.GradeSystem:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this grade system",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade system. 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 grade system. 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
    },
    "basedOnGrades": {
      "description": "Tests if the grading system is based on grades.",
      "type": "boolean",
      "elementId": "grading.GradeSystem:basedOnGrades@dxtera.org",
      "existingValue": false,
      "elementLabel": "Based On Grades",
      "instructions": "Enter true or false.",
      "linked": false
    },
    "lowestNumericScore": {
      "description": "The lowest number in a numeric grading system.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "grading.GradeSystem:lowestNumericScore@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Lowest Numeric Score",
      "instructions": "Enter the lowest numeric score of this grade system.",
      "linked": false
    },
    "numericScoreIncrement": {
      "description": "The incremental step.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "grading.GradeSystem:numericScoreIncrement@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Numeric Score Increment",
      "instructions": "Enter the numeric score increment of this grade system.",
      "linked": false
    },
    "highestNumericScore": {
      "description": "The highest number in a numeric grading system.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "grading.GradeSystem:highestNumericScore@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Highest Numeric Score",
      "instructions": "Enter the highest numeric score of this grade system.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradeSystem not found" }

/grade-entries

Collection of grade-entries in a system, federation of systems, or in a default gradebook.

get post

get

Get all grade-entries in the system or default gradebook.

post

Create a new grade-entry in the default gradebook.

Create a new grade-entry in the default gradebook.

Query Parameters

  • gradebookColumnId: required(string)

    the gradebook-column of this grade-entry.

    Example:

    grading.GradebookColumn%3A1120%40base.url
  • keyResourceId: required(string)

    the key-resource of this grade-entry.

    Example:

    resource.Resource%3A960%40base.url
  • genusType: (string)

    specify a particular gradeEntry type to create

    Example:

    type.Type%3AexampleGradeEntryType%40dxtera.org
  • recordType: (array of )

    specify support for one or more gradeEntry record types

    Example:

    [
  "type.Type%3AexampleGradeEntryRecordType%40campusapi.org",
  "..."
]
  • gradebookId: (string)

    specify in which gradebook to create this gradeEntry

    Example:

    grading.Gradebook%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradeEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this grade entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this grade entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade entry. 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 grade entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this grade entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this grade entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this grade entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "gradebookColumnId": {
      "description": "The gradebook column associated with this grade entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "keyResourceId": {
      "description": "The key resource associated with this grade entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "ignoredForCalculations": {
      "description": "Tests if this is entry should be ignored in any averaging, scaling or curve calculation.",
      "type": "boolean"
    },
    "gradeId": {
      "description": "The grade in this entry if the grading system is based on grades.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The score in this entry if the grading system is not based on grades.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradeEntry",
  "description": "The description of this GradeEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:255@base.url",
  "ignoredForCalculations": true,
  "gradeId": "grading.Grade:5415@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-entry has been created",
  "grade-entryId": "grading.GradeEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a gradeEntry form metadata.

get

Get form metadata for creating a new gradeEntry.

get put delete

Entity representing a grade-entry

get

Get a grade-entry given its id.

put

Update a given grade-entry.

delete

Delete a given grade-entry.

Get a grade-entry given its id.

URI Parameters

  • gradeEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "grading.GradeEntry:7623@base.url",
  "uri": "http://base.url/open/campusapi/grading/gradeEntry/grading.GradeEntry%3A7623%40base.url",
  "displayName": "Display Name of this GradeEntry",
  "description": "The description of this GradeEntry",
  "genusTypeId": "type.Type:defaultGradeEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleGradeEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7623@base.url",
  "gradebookColumnId": "grading.GradebookColumn:4454@base.url",
  "keyResourceId": "resource.Resource:7216@base.url",
  "ignoredForCalculations": true,
  "gradeId": "grading.Grade:22@base.url",
  "score": 3.14
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-entry not found" }

Update a given grade-entry.

URI Parameters

  • gradeEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradeEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this grade entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this grade entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade entry. 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 grade entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this grade entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this grade entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this grade entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "gradebookColumnId": {
      "description": "The gradebook column associated with this grade entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "keyResourceId": {
      "description": "The key resource associated with this grade entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "ignoredForCalculations": {
      "description": "Tests if this is entry should be ignored in any averaging, scaling or curve calculation.",
      "type": "boolean"
    },
    "gradeId": {
      "description": "The grade in this entry if the grading system is based on grades.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The score in this entry if the grading system is not based on grades.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradeEntry",
  "description": "The description of this GradeEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:255@base.url",
  "ignoredForCalculations": true,
  "gradeId": "grading.Grade:5415@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-entry has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-entry not found" }

Delete a given grade-entry.

URI Parameters

  • gradeEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The grade-entry has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "grade-entry not found" }

get

Entity representing a gradeEntry form metadata for update

get

Get form metadata for updating an existing gradeEntry.

Get form metadata for updating an existing gradeEntry.

URI Parameters

  • gradeEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "GradeEntry",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this grade entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this grade entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this grade entry for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeEntry.GradeEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this grade entry",
      "linked": false
    },
    "description": {
      "description": "The description of this grade entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeEntry.GradeEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this grade entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this grade entry. 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 grade entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this grade entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeEntry.GradeEntry:startDate@base.url",
      "existingValue": "2020-10-03T08:00:00.000Z",
      "elementLabel": "Start Date",
      "instructions": "Enter a starting date for this grade entry",
      "linked": false
    },
    "endDate": {
      "description": "The ending date of this grade entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeEntry.GradeEntry:endDate@base.url",
      "existingValue": "2020-12-18T17:00:00.000Z",
      "elementLabel": "End Date",
      "instructions": "Enter an ending date for this grade entry",
      "linked": false
    },
    "endReasonId": {
      "description": "The reason this grade entry ended. A process/State object.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradeEntry.GradeEntry:endReason@base.url",
      "existingValue": "process.State:1860@base.url",
      "elementLabel": "End Reason",
      "instructions": "Select the reason this grade entry ended",
      "linked": false
    },
    "ignoredForCalculations": {
      "description": "Tests if this is entry should be ignored in any averaging, scaling or curve calculation.",
      "type": "boolean",
      "elementId": "grading.GradeEntry:ignoredForCalculations@dxtera.org",
      "existingValue": false,
      "elementLabel": "Ignored For Calculations",
      "instructions": "Enter true or false.",
      "linked": false
    },
    "gradeId": {
      "description": "The grade in this entry if the grading system is based on grades.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "grading.GradeEntry:grade@dxtera.org",
      "existingValue": null,
      "elementLabel": "Grade",
      "instructions": "Enter the Id of the grade for this grade entry.",
      "linked": false
    },
    "score": {
      "description": "The score in this entry if the grading system is not based on grades.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "grading.GradeEntry:score@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Score",
      "instructions": "Enter the score of this grade entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradeEntry not found" }

/gradebook-columns

Collection of gradebook-columns in a system, federation of systems, or in a default gradebook.

get post

get

Get all gradebook-columns in the system or default gradebook.

post

Create a new gradebook-column in the default gradebook.

Create a new gradebook-column in the default gradebook.

Query Parameters

  • genusType: (string)

    specify a particular gradebookColumn type to create

    Example:

    type.Type%3AexampleGradebookColumnType%40dxtera.org
  • recordType: (array of )

    specify support for one or more gradebookColumn record types

    Example:

    [
  "type.Type%3AexampleGradebookColumnRecordType%40campusapi.org",
  "..."
]
  • gradebookId: (string)

    specify in which gradebook to create this gradebookColumn

    Example:

    grading.Gradebook%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradebookColumn",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this gradebook column, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook column, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook column for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this gradebook column.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook column. 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 gradebook column. 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
    },
    "gradeSystemId": {
      "description": "The GradeSystem in which this grade belongs.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradebookColumn",
  "description": "The description of this GradebookColumn",
  "gradeSystemId": "grading.GradeSystem:4597@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook-column has been created",
  "gradebook-columnId": "grading.GradebookColumn:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a gradebookColumn form metadata.

get

Get form metadata for creating a new gradebookColumn.

get put delete

Entity representing a gradebook-column

get

Get a gradebook-column given its id.

put

Update a given gradebook-column.

delete

Delete a given gradebook-column.

Get a gradebook-column given its id.

URI Parameters

  • gradebookColumnId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "grading.GradebookColumn:4379@base.url",
  "uri": "http://base.url/open/campusapi/grading/gradebook_column/grading.GradebookColumn%3A4379%40base.url",
  "displayName": "Display Name of this GradebookColumn",
  "description": "The description of this GradebookColumn",
  "genusTypeId": "type.Type:defaultGradebookColumnType@base.url",
  "recordTypeIds": [ "type.Type:exampleGradebookColumnRecordType@campusapi.org", "..."],
  "gradeSystemId": "grading.GradeSystem:4959@base.url"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook-column not found" }

Update a given gradebook-column.

URI Parameters

  • gradebookColumnId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GradebookColumn",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this gradebook column, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook column, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook column for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this gradebook column.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook column. 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 gradebook column. 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
    },
    "gradeSystemId": {
      "description": "The GradeSystem in which this grade belongs.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this GradebookColumn",
  "description": "The description of this GradebookColumn",
  "gradeSystemId": "grading.GradeSystem:4597@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook-column has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook-column not found" }

Delete a given gradebook-column.

URI Parameters

  • gradebookColumnId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook-column has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook-column not found" }

get

Entity representing a gradebookColumn form metadata for update

get

Get form metadata for updating an existing gradebookColumn.

Get form metadata for updating an existing gradebookColumn.

URI Parameters

  • gradebookColumnId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "GradebookColumn",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this gradebook column, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook column, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook column for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradebookColumn.GradebookColumn:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this gradebook column",
      "linked": false
    },
    "description": {
      "description": "The description of this gradebook column.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "GradebookColumn.GradebookColumn:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this gradebook column",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook column. 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 gradebook column. 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
    },
    "gradeSystemId": {
      "description": "The GradeSystem in which this grade belongs.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "grading.GradebookColumn:gradeSystem@dxtera.org",
      "existingValue": null,
      "elementLabel": "Grade System",
      "instructions": "Enter the Id of the grade system for this gradebook column.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebookColumn not found" }

/gradebooks

Collection of gradebooks in a system or federation of systems.

get post

get

Get all gradebooks.

post

Create a new gradebook.

Create a new gradebook.

Query Parameters

  • genusType: (string)

    specify a particular gradebook type to create

    Example:

    type.Type%3AexampleGradebookType%40dxtera.org
  • recordType: (array of )

    specify support for one or more gradebook record types

    Example:

    [
  "type.Type%3AexampleGradebookRecordType%40campusapi.org",
  "..."
]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Gradebook",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this gradebook, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this gradebook.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook. 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 gradebook. 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 gradebook.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this gradebook. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this gradebook.",
      "type": "string"
    }



  }
}

Example:

{
  "displayName": "Display Name of this Gradebook",
  "description": "The description of this Gradebook",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Gradebook@base.url",
  "license": "The license that applies to this Gradebook"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook has been created",
  "gradebookId": "grading.Gradebook:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a gradebook form metadata.

get

Get form metadata for creating a new gradebook.

get

The root gradebooks in the gradebook hierarchy. A node with no parents is an orphan. While all gradebook Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

get

Get all root root-gradebook

get put delete

Entity representing a gradebook

get

Get a gradebook given its id.

put

Update a given gradebook.

delete

Delete a given gradebook.

Get a gradebook given its id.

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "grading.Gradebook:7215@base.url",
  "uri": "http://base.url/open/campusapi/grading/gradebook/grading.Gradebook%3A7215%40base.url",
  "displayName": "Display Name of this Gradebook",
  "description": "The description of this Gradebook",
  "genusTypeId": "type.Type:defaultGradebookType@base.url",
  "recordTypeIds": [ "type.Type:exampleGradebookRecordType@campusapi.org", "..."],
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Gradebook@base.url",
  "license": "The license that applies to this Gradebook"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook not found" }

Update a given gradebook.

URI Parameters

  • gradebookId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Gradebook",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this gradebook, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this gradebook.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook. 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 gradebook. 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 gradebook.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this gradebook. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this gradebook.",
      "type": "string"
    }



  }
}

Example:

{
  "displayName": "Display Name of this Gradebook",
  "description": "The description of this Gradebook",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Gradebook@base.url",
  "license": "The license that applies to this Gradebook"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook not found" }

Delete a given gradebook.

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The gradebook has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook not found" }

get

Entity representing a gradebook form metadata for update

get

Get form metadata for updating an existing gradebook.

Get form metadata for updating an existing gradebook.

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Gradebook",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this gradebook, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this gradebook, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this gradebook for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Gradebook.Gradebook:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this gradebook",
      "linked": false
    },
    "description": {
      "description": "The description of this gradebook.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Gradebook.Gradebook:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this gradebook",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this gradebook. 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 gradebook. 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 gradebook.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Gradebook.Gradebook:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this gradebook",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this gradebook. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Gradebook.Gradebook:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this gradebook",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this gradebook.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Gradebook.Gradebook:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this gradebook",
      "linked": false
    }



  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "gradebook not found" }

get

get

Get child gradebooks for the given gradebook in the hierarchy.

Get child gradebooks for the given gradebook in the hierarchy.

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.Gradebook:7215@base.url",
    "uri": "http://base.url/open/campusapi/grading/gradebook/grading.Gradebook%3A7215%40base.url",
    "displayName": "Display Name of this Gradebook",
    "description": "The description of this Gradebook",
    "genusTypeId": "type.Type:defaultGradebookType@base.url",
    "recordTypeIds": [ "type.Type:exampleGradebookRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Gradebook@base.url",
    "license": "The license that applies to this Gradebook"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add gradebook as child of the given gradebook in the hierarchy.

delete

Remove the given gradebook as a child of the given gradebook in the hierarchy.

Add gradebook as child of the given gradebook in the hierarchy.

URI Parameters

  • gradebookId: required(string)
  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child gradebook has been added to the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "gradebook not found" }

Remove the given gradebook as a child of the given gradebook in the hierarchy.

URI Parameters

  • gradebookId: required(string)
  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child gradebook has been removed from the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get parent gradebooks for the given gradebook in the hierarchy.

Get parent gradebooks for the given gradebook in the hierarchy.

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.Gradebook:7215@base.url",
    "uri": "http://base.url/open/campusapi/grading/gradebook/grading.Gradebook%3A7215%40base.url",
    "displayName": "Display Name of this Gradebook",
    "description": "The description of this Gradebook",
    "genusTypeId": "type.Type:defaultGradebookType@base.url",
    "recordTypeIds": [ "type.Type:exampleGradebookRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Gradebook@base.url",
    "license": "The license that applies to this Gradebook"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get all grade-systems in this gradebook

Get all grade-systems in this gradebook

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.GradeSystem:939@base.url",
    "uri": "http://base.url/open/campusapi/grading/grade_system/grading.GradeSystem%3A939%40base.url",
    "displayName": "Display Name of this GradeSystem",
    "description": "The description of this GradeSystem",
    "genusTypeId": "type.Type:defaultGradeSystemType@base.url",
    "recordTypeIds": [ "type.Type:exampleGradeSystemRecordType@campusapi.org", "..."],
    "basedOnGrades": true,
    "lowestNumericScore": 3.14,
    "numericScoreIncrement": 3.14,
    "highestNumericScore": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given grade-system to this gradebook

delete

Remove the given grade-system from the gradebook.

Add the given grade-system to this gradebook

URI Parameters

  • gradebookId: required(string)
  • gradeSystemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-system has been added to gradebook" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-system not found" }

Remove the given grade-system from the gradebook.

URI Parameters

  • gradebookId: required(string)
  • gradeSystemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-system has been removed" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-system not found" }

get

get

Get all grade-entries in this gradebook

Get all grade-entries in this gradebook

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.GradeEntry:7623@base.url",
    "uri": "http://base.url/open/campusapi/grading/gradeEntry/grading.GradeEntry%3A7623%40base.url",
    "displayName": "Display Name of this GradeEntry",
    "description": "The description of this GradeEntry",
    "genusTypeId": "type.Type:defaultGradeEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleGradeEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:7623@base.url",
    "gradebookColumnId": "grading.GradebookColumn:4454@base.url",
    "keyResourceId": "resource.Resource:7216@base.url",
    "ignoredForCalculations": true,
    "gradeId": "grading.Grade:22@base.url",
    "score": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given grade-entry to this gradebook

delete

Remove the given grade-entry from the gradebook.

Add the given grade-entry to this gradebook

URI Parameters

  • gradebookId: required(string)
  • gradeEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-entry has been added to gradebook" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-entry not found" }

Remove the given grade-entry from the gradebook.

URI Parameters

  • gradebookId: required(string)
  • gradeEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-entry has been removed" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "grade-entry not found" }

get

get

Get all gradebook-columns in this gradebook

Get all gradebook-columns in this gradebook

URI Parameters

  • gradebookId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.GradebookColumn:4379@base.url",
    "uri": "http://base.url/open/campusapi/grading/gradebook_column/grading.GradebookColumn%3A4379%40base.url",
    "displayName": "Display Name of this GradebookColumn",
    "description": "The description of this GradebookColumn",
    "genusTypeId": "type.Type:defaultGradebookColumnType@base.url",
    "recordTypeIds": [ "type.Type:exampleGradebookColumnRecordType@campusapi.org", "..."],
    "gradeSystemId": "grading.GradeSystem:4959@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given gradebook-column to this gradebook

delete

Remove the given gradebook-column from the gradebook.

Add the given gradebook-column to this gradebook

URI Parameters

  • gradebookId: required(string)
  • gradebookColumnId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "gradebook-column has been added to gradebook" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "gradebook-column not found" }

Remove the given gradebook-column from the gradebook.

URI Parameters

  • gradebookId: required(string)
  • gradebookColumnId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "gradebook-column has been removed" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "gradebook-column not found" }