CampusAPI Grading 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", 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%3AexampleGradeSystemType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradeSystemType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradeSystemType%40campusapi.org

• gradeId: (string)

  Id string to match grade.

  Example:

  grading.Grade%3A7386%40base.url

• gradebookId: (string)

  The id string to match a gradebook

  Example:

  grading.Gradebook%3A8374%40base.url

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
}

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": "GradeSystemQuery",
  "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"
          }
        }
      }
    },
    "matchBasedOnGrades": {
      "description": "Match boolean value for basedOnGrades.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchLowestNumericScore": {
      "description": "Match LowestNumericScore within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyLowestNumericScore": {
      "description": "Match lowestNumericScores with any value. true to match GradeSystems with any lowest numeric score, false to match ProgramOfferings with no lowest numeric score",
      "type": "boolean"

    },
    "matchNumericScoreIncrement": {
      "description": "Match NumericScoreIncrement within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyNumericScoreIncrement": {
      "description": "Match numericScoreIncrements with any value. true to match GradeSystems with any numeric score increment, false to match ProgramOfferings with no numeric score increment",
      "type": "boolean"

    },
    "matchHighestNumericScore": {
      "description": "Match HighestNumericScore within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyHighestNumericScore": {
      "description": "Match highestNumericScores with any value. true to match GradeSystems with any highest numeric score, false to match ProgramOfferings with no highest numeric score",
      "type": "boolean"

    },
    "matchGradebookIds": {
      "description": "List of Gradebook Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradebookId": {
            "description": "Gradebook id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradebookQueries": {
      "description": "GradebookQueries to match Gradebook. 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 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

URI Parameters

• gradeSystemId: required(string)

Query Parameters

• 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

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
}

URI Parameters

• gradeSystemId: required(string)

URI Parameters

• gradeSystemId: 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", "endReason", "grade", "gradebookColumn", "keyResource", 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%3AexampleGradeEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradeEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradeEntryType%40campusapi.org

• fromDate: (string)

  Get all grade-entries from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all grade-entries up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• gradebookColumnId: (string)

  the id string to match a gradebook-column.

  Example:

  grading.GradebookColumn%3A1120%40base.url

• keyResourceId: (string)

  the id string to match a key-resource.

  Example:

  resource.Resource%3A960%40base.url

• graderId: (string)

  Id string to match grader.

  Example:

  resource.Resource%3A7836%40base.url

• gradebookId: (string)

  The id string to match a gradebook

  Example:

  grading.Gradebook%3A8374%40base.url

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:9686@base.url",
  "ignoredForCalculations": true,
  "gradeId": "grading.Grade:1675@base.url",
  "score": 3.14
}

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", "endReason", "grade", "gradebookColumn", "keyResource", 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": "GradeEntryQuery",
  "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"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's 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"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match GradeEntries with any end reason, false to match GradeEntries with no end reason",
      "type": "boolean"
    },
    "matchGradebookColumnIds": {
      "description": "List of gradebookColumn Ids for this query to match grade entry that have a related gradebookColumn.",
      "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"
          }
        }
      }
    },
    "gradebookColumnQueries": {
      "description": "GradebookColumnQueries to match the gradebookColumn. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchKeyResourceIds": {
      "description": "List of keyResource Ids for this query to match grade entry that have a related keyResource.",
      "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"
          }
        }
      }
    },
    "keyResourceQueries": {
      "description": "KeyResourceQueries to match the keyResource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchIgnoredForCalculations": {
      "description": "Match boolean value for ignoredForCalculations.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchGradeIds": {
      "description": "List of Grade Ids for this query to match grade.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradeId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradeQueries": {
      "description": "grading.GradeQueries to match the Grade. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyGrade": {
      "description": "Match grade with any value. true to match GradeEntries with any grade, false to match GradeEntries with no grade",
      "type": "boolean"
    },
    "matchScore": {
      "description": "Match Score within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyScore": {
      "description": "Match scores with any value. true to match GradeEntries with any score, false to match ProgramOfferings with no score",
      "type": "boolean"

    },
    "matchGradebookIds": {
      "description": "List of Gradebook Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradebookId": {
            "description": "Gradebook id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradebookQueries": {
      "description": "GradebookQueries to match Gradebook. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• gradebookColumnId: required(string)

  the gradebook-column of this metadatum.

  Example:

  grading.GradebookColumn%3A1120%40base.url

• keyResourceId: required(string)

  the key-resource of this metadatum.

  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

URI Parameters

• gradeEntryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:9686@base.url",
  "ignoredForCalculations": true,
  "gradeId": "grading.Grade:1675@base.url",
  "score": 3.14
}

URI Parameters

• gradeEntryId: required(string)

URI Parameters

• gradeEntryId: 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", "gradeSystem", 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%3AexampleGradebookColumnType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradebookColumnType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradebookColumnType%40campusapi.org

• gradebookId: (string)

  The id string to match a gradebook

  Example:

  grading.Gradebook%3A8374%40base.url

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:3633@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", "gradeSystem", 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": "GradebookColumnQuery",
  "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"
          }
        }
      }
    },
    "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 GradebookColumns with any grade system, false to match GradebookColumns with no grade system",
      "type": "boolean"
    },
    "matchGradebookIds": {
      "description": "List of Gradebook Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradebookId": {
            "description": "Gradebook id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradebookQueries": {
      "description": "GradebookQueries to match Gradebook. 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 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

URI Parameters

• gradebookColumnId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:3633@base.url"
}

URI Parameters

• gradebookColumnId: required(string)

URI Parameters

• gradebookColumnId: 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%3AexampleGradebookType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradebookType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradebookType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• gradeId: (string)

  Get gradebooks mapped to this grade.

  Example:

  grading.Grade%3A315%40demo.dxtera.org

• gradeSystemId: (string)

  Get gradebooks mapped to this grade-system.

  Example:

  grading.GradeSystem%3A756%40demo.dxtera.org

• gradeEntryId: (string)

  Get gradebooks mapped to this grade-entry.

  Example:

  grading.GradeEntry%3A693%40demo.dxtera.org

• gradebookColumnId: (string)

  Get gradebooks mapped to this gradebook-column.

  Example:

  grading.GradebookColumn%3A1008%40demo.dxtera.org

• gradebookColumnSummaryId: (string)

  Get gradebooks mapped to this gradebook-column-summary.

  Example:

  grading.GradebookColumnSummary%3A1512%40demo.dxtera.org

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

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": "GradebookQuery",
  "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 Gradebook with any provider, false to match Gradebook 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 Gradebook with any branding, false to match Gradebook 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"
          }
        }
      }
    },
    "matchGradebookIds": {
      "description": "List of Gradebook Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradebookId": {
            "description": "Gradebook id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradebookQueries": {
      "description": "GradebookQueries to match Gradebook. 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": "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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "grading.Gradebook:6819@base.url",
    "uri": "http://base.url/open/campusapi/grading/gradebook/grading.Gradebook%3A6819%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" }

URI Parameters

• gradebookId: required(string)

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

URI Parameters

• gradebookId: required(string)

URI Parameters

• gradebookId: required(string)

URI Parameters

• gradebookId: required(string)

URI Parameters

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

URI Parameters

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

URI Parameters

• gradebookId: required(string)

URI Parameters

• gradebookId: 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", 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%3AexampleGradeSystemType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradeSystemType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradeSystemType%40campusapi.org

URI Parameters

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

URI Parameters

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

URI Parameters

• gradebookId: 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", "endReason", "grade", "gradebookColumn", "keyResource", 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%3AexampleGradeEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradeEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradeEntryType%40campusapi.org

URI Parameters

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

URI Parameters

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

URI Parameters

• gradebookId: 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", "gradeSystem", 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%3AexampleGradebookColumnType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleGradebookColumnType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleGradebookColumnType%40campusapi.org

URI Parameters

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

URI Parameters

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