CampusAPI Chronicle Services API documentation version 1.0.5
Based on OSID version 3.0.0

URI Parameters

• studentId: required(string)

Query Parameters

• enrolled: (boolean)

  Get all enrolled academic-records for student.

  Example:

  true

• completed: (boolean)

  Get all completed academic-records for student.

  Example:

  true

• term: (string)

  Get all academic-records effective within this term for student.

  Example:

  course.Term:9070@demo.dxtera.org

URI Parameters

• studentId: required(string)

Query Parameters

• enrolled: (boolean)

  Get all enrolled program-entries for student.

  Example:

  true

• completed: (boolean)

  Get all completed program-entries for student.

  Example:

  true

• term: (string)

  Get all program-entries effective within this term for student.

  Example:

  course.Term:9070@demo.dxtera.org

URI Parameters

• studentId: required(string)

Query Parameters

• enrolled: (boolean)

  Get all enrolled course-entries for student.

  Example:

  true

• completed: (boolean)

  Get all completed course-entries for student.

  Example:

  true

• term: (string)

  Get all course-entries effective within this term for student.

  Example:

  course.Term:9070@demo.dxtera.org

URI Parameters

• studentId: required(string)

Query Parameters

• fromDate: (string)

  Get all effective credential-entries for student from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all effective credential-entries for student up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

URI Parameters

• studentId: required(string)

Query Parameters

• fromDate: (string)

  Get all effective assessment-entries for student from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all effective assessment-entries for student up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

URI Parameters

• studentId: required(string)

Query Parameters

• fromDate: (string)

  Get all effective award-entries for student from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all effective award-entries for student up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

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", "term", "creditScale", "gpaScale", "student", "program", 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%3AexampleProgramEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleProgramEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleProgramEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• studentId: (string)

  the id string to match a student.

  Example:

  resource.Resource%3A672%40base.url

• programId: (string)

  the id string to match a program.

  Example:

  program.Program%3A588%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• studentId: required(string)

  the student of this program-entry.

  Example:

  resource.Resource%3A672%40base.url

• programId: required(string)

  the program of this program-entry.

  Example:

  program.Program%3A588%40base.url

• genusType: (string)

  specify a particular programEntry type to create

  Example:

  type.Type%3AexampleProgramEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more programEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this programEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProgramEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this program entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this program entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this program entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this program entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this program 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 program 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 program entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this program entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this program entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this program entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "programId": {
      "description": "The program associated with this program entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "admissionDate": {
      "description": "The date in which the student was admitted.",
      "type": "string",
      "format": "date-time"
    },
    "complete": {
      "description": "Tests if the program has been completed.",
      "type": "boolean"
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "format": "osid-id"
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "creditsEarned": {
      "description": "The number of credits earned in this program or earned within the included term.",
      "type": "number"
    },
    "gpaScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "gpa": {
      "description": "The cumulative GPA in this porgram or within the included term.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ProgramEntry",
  "description": "The description of this ProgramEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7401@base.url",
  "admissionDate": "2021-07-21T23:15:30.000Z",
  "complete": true,
  "termId": "course.Term:4226@base.url",
  "creditScaleId": "grading.GradeSystem:5409@base.url",
  "creditsEarned": 3.14,
  "gpaScaleId": "grading.GradeSystem:8132@base.url",
  "gpa": 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", "term", "creditScale", "gpaScale", "student", "program", 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": "ProgramEntryQuery",
  "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 ProgramEntries with any end reason, false to match ProgramEntries with no end reason",
      "type": "boolean"
    },
    "matchStudentIds": {
      "description": "List of student Ids for this query to match program entry that have a related student.",
      "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"
          }
        }
      }
    },
    "studentQueries": {
      "description": "StudentQueries to match the student. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchProgramIds": {
      "description": "List of program Ids for this query to match program entry that have a related program.",
      "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"
          }
        }
      }
    },
    "programQueries": {
      "description": "ProgramQueries to match the program. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAdmissionDate": {
      "description": "Matches admissionDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyAdmissionDate": {
      "description": "Match admissionDates with any value. true to match ProgramEntries with any admission date, false to match ProgramOfferings with no admission date",
      "type": "boolean"

    },
    "matchComplete": {
      "description": "Match boolean value for complete.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchTermIds": {
      "description": "List of Term Ids for this query to match term.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "termId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "termQueries": {
      "description": "course.TermQueries to match the Term. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyTerm": {
      "description": "Match term with any value. true to match ProgramEntries with any term, false to match ProgramEntries with no term",
      "type": "boolean"
    },
    "matchCreditScaleIds": {
      "description": "List of GradeSystem Ids for this query to match creditScale.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditScaleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "creditScaleQueries": {
      "description": "grading.GradeSystemQueries to match the Credit Scale. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCreditScale": {
      "description": "Match credit scale with any value. true to match ProgramEntries with any credit scale, false to match ProgramEntries with no credit scale",
      "type": "boolean"
    },
    "matchCreditsEarned": {
      "description": "Match CreditsEarned 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"
          }
        }
      }
    },
    "matchAnyCreditsEarned": {
      "description": "Match creditsEarneds with any value. true to match ProgramEntries with any credits earned, false to match ProgramOfferings with no credits earned",
      "type": "boolean"

    },
    "matchGpaScaleIds": {
      "description": "List of GradeSystem Ids for this query to match gpaScale.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gpaScaleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gpaScaleQueries": {
      "description": "grading.GradeSystemQueries to match the GPA Scale. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyGpaScale": {
      "description": "Match gpa scale with any value. true to match ProgramEntries with any gpa scale, false to match ProgramEntries with no gpa scale",
      "type": "boolean"
    },
    "matchGPA": {
      "description": "Match GPA 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"
          }
        }
      }
    },
    "matchAnyGPA": {
      "description": "Match gpas with any value. true to match ProgramEntries with any gpa, false to match ProgramOfferings with no gpa",
      "type": "boolean"

    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• studentId: required(string)

  the student of this metadatum.

  Example:

  resource.Resource%3A672%40base.url

• programId: required(string)

  the program of this metadatum.

  Example:

  program.Program%3A588%40base.url

• genusType: (string)

  specify a particular programEntry type to create

  Example:

  type.Type%3AexampleProgramEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more programEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this programEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

URI Parameters

• programEntryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• programEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProgramEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this program entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this program entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this program entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this program entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this program 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 program 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 program entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this program entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this program entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this program entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "programId": {
      "description": "The program associated with this program entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "admissionDate": {
      "description": "The date in which the student was admitted.",
      "type": "string",
      "format": "date-time"
    },
    "complete": {
      "description": "Tests if the program has been completed.",
      "type": "boolean"
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "format": "osid-id"
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "creditsEarned": {
      "description": "The number of credits earned in this program or earned within the included term.",
      "type": "number"
    },
    "gpaScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "gpa": {
      "description": "The cumulative GPA in this porgram or within the included term.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ProgramEntry",
  "description": "The description of this ProgramEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7401@base.url",
  "admissionDate": "2021-07-21T23:15:30.000Z",
  "complete": true,
  "termId": "course.Term:4226@base.url",
  "creditScaleId": "grading.GradeSystem:5409@base.url",
  "creditsEarned": 3.14,
  "gpaScaleId": "grading.GradeSystem:8132@base.url",
  "gpa": 3.14
}

URI Parameters

• programEntryId: required(string)

URI Parameters

• programEntryId: 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", "term", "creditScale", "grade", "scoreScale", "student", "course", 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%3AexampleCourseEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• studentId: (string)

  the id string to match a student.

  Example:

  resource.Resource%3A616%40base.url

• courseId: (string)

  the id string to match a course.

  Example:

  course.Course%3A396%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• studentId: required(string)

  the student of this course-entry.

  Example:

  resource.Resource%3A616%40base.url

• courseId: required(string)

  the course of this course-entry.

  Example:

  course.Course%3A396%40base.url

• genusType: (string)

  specify a particular courseEntry type to create

  Example:

  type.Type%3AexampleCourseEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this courseEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course 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 course 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 course entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this course entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this course entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseId": {
      "description": "The course associated with this course entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "format": "osid-id"
    },
    "complete": {
      "description": "Tests if the course has been completed.",
      "type": "boolean"
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "creditsEarned": {
      "description": "The number of credits earned in this course.",
      "type": "number"
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "format": "osid-id"
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseEntry",
  "description": "The description of this CourseEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:9253@base.url",
  "termId": "course.Term:6218@base.url",
  "complete": true,
  "creditScaleId": "grading.GradeSystem:4165@base.url",
  "creditsEarned": 3.14,
  "gradeId": "grading.Grade:2130@base.url",
  "scoreScaleId": "grading.GradeSystem:1303@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", "term", "creditScale", "grade", "scoreScale", "student", "course", 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": "CourseEntryQuery",
  "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 CourseEntries with any end reason, false to match CourseEntries with no end reason",
      "type": "boolean"
    },
    "matchStudentIds": {
      "description": "List of student Ids for this query to match course entry that have a related student.",
      "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"
          }
        }
      }
    },
    "studentQueries": {
      "description": "StudentQueries to match the student. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match course entry that have a related course.",
      "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"
          }
        }
      }
    },
    "courseQueries": {
      "description": "CourseQueries to match the course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchTermIds": {
      "description": "List of Term Ids for this query to match term.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "termId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "termQueries": {
      "description": "course.TermQueries to match the Term. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyTerm": {
      "description": "Match term with any value. true to match CourseEntries with any term, false to match CourseEntries with no term",
      "type": "boolean"
    },
    "matchComplete": {
      "description": "Match boolean value for complete.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchCreditScaleIds": {
      "description": "List of GradeSystem Ids for this query to match creditScale.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditScaleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "creditScaleQueries": {
      "description": "grading.GradeSystemQueries to match the Credit Scale. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCreditScale": {
      "description": "Match credit scale with any value. true to match CourseEntries with any credit scale, false to match CourseEntries with no credit scale",
      "type": "boolean"
    },
    "matchCreditsEarned": {
      "description": "Match CreditsEarned 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"
          }
        }
      }
    },
    "matchAnyCreditsEarned": {
      "description": "Match creditsEarneds with any value. true to match CourseEntries with any credits earned, false to match ProgramOfferings with no credits earned",
      "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 CourseEntries with any grade, false to match CourseEntries with no grade",
      "type": "boolean"
    },
    "matchScoreScaleIds": {
      "description": "List of GradeSystem Ids for this query to match scoreScale.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scoreScaleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "scoreScaleQueries": {
      "description": "grading.GradeSystemQueries to match the Score Scale. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyScoreScale": {
      "description": "Match score scale with any value. true to match CourseEntries with any score scale, false to match CourseEntries with no score scale",
      "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 CourseEntries with any score, false to match ProgramOfferings with no score",
      "type": "boolean"

    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• studentId: required(string)

  the student of this metadatum.

  Example:

  resource.Resource%3A616%40base.url

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A396%40base.url

• genusType: (string)

  specify a particular courseEntry type to create

  Example:

  type.Type%3AexampleCourseEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this courseEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

URI Parameters

• courseEntryId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "term", "creditScale", "grade", "scoreScale", "student", "course", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• courseEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course 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 course 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 course entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this course entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this course entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseId": {
      "description": "The course associated with this course entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "format": "osid-id"
    },
    "complete": {
      "description": "Tests if the course has been completed.",
      "type": "boolean"
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "creditsEarned": {
      "description": "The number of credits earned in this course.",
      "type": "number"
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "format": "osid-id"
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseEntry",
  "description": "The description of this CourseEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:9253@base.url",
  "termId": "course.Term:6218@base.url",
  "complete": true,
  "creditScaleId": "grading.GradeSystem:4165@base.url",
  "creditsEarned": 3.14,
  "gradeId": "grading.Grade:2130@base.url",
  "scoreScaleId": "grading.GradeSystem:1303@base.url",
  "score": 3.14
}

URI Parameters

• courseEntryId: required(string)

URI Parameters

• courseEntryId: 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", "program", "student", "credential", 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%3AexampleCredentialEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCredentialEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCredentialEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• studentId: (string)

  the id string to match a student.

  Example:

  resource.Resource%3A840%40base.url

• credentialId: (string)

  the id string to match a credential.

  Example:

  program.Credential%3A1050%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• studentId: required(string)

  the student of this credential-entry.

  Example:

  resource.Resource%3A840%40base.url

• credentialId: required(string)

  the credential of this credential-entry.

  Example:

  program.Credential%3A1050%40base.url

• genusType: (string)

  specify a particular credentialEntry type to create

  Example:

  type.Type%3AexampleCredentialEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more credentialEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this credentialEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CredentialEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this credential entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this credential entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this credential entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this credential entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this credential 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 credential 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 credential entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this credential entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this credential entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this credential entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "credentialId": {
      "description": "The credential associated with this credential entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CredentialEntry",
  "description": "The description of this CredentialEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:4576@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3145@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", "endReason", "program", "student", "credential", 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": "CredentialEntryQuery",
  "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 CredentialEntries with any end reason, false to match CredentialEntries with no end reason",
      "type": "boolean"
    },
    "matchStudentIds": {
      "description": "List of student Ids for this query to match credential entry that have a related student.",
      "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"
          }
        }
      }
    },
    "studentQueries": {
      "description": "StudentQueries to match the student. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCredentialIds": {
      "description": "List of credential Ids for this query to match credential entry that have a related credential.",
      "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"
          }
        }
      }
    },
    "credentialQueries": {
      "description": "CredentialQueries to match the credential. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchDateAwarded": {
      "description": "Matches dateAwardeds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDateAwarded": {
      "description": "Match dateAwardeds with any value. true to match CredentialEntries with any date awarded, false to match ProgramOfferings with no date awarded",
      "type": "boolean"

    },
    "matchProgramIds": {
      "description": "List of Program Ids for this query to match program.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "programId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "programQueries": {
      "description": "program.ProgramQueries to match the Program. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyProgram": {
      "description": "Match program with any value. true to match CredentialEntries with any program, false to match CredentialEntries with no program",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• studentId: required(string)

  the student of this metadatum.

  Example:

  resource.Resource%3A840%40base.url

• credentialId: required(string)

  the credential of this metadatum.

  Example:

  program.Credential%3A1050%40base.url

• genusType: (string)

  specify a particular credentialEntry type to create

  Example:

  type.Type%3AexampleCredentialEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more credentialEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this credentialEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

URI Parameters

• credentialEntryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• credentialEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CredentialEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this credential entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this credential entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this credential entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this credential entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this credential 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 credential 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 credential entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this credential entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this credential entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this credential entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "credentialId": {
      "description": "The credential associated with this credential entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CredentialEntry",
  "description": "The description of this CredentialEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:4576@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3145@base.url"
}

URI Parameters

• credentialEntryId: required(string)

URI Parameters

• credentialEntryId: 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", "program", "course", "grade", "scoreScale", "student", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAssessmentEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAssessmentEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAssessmentEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• studentId: (string)

  the id string to match a student.

  Example:

  resource.Resource%3A840%40base.url

• assessmentId: (string)

  the id string to match a assessment.

  Example:

  assessment.Assessment%3A1500%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• studentId: required(string)

  the student of this assessment-entry.

  Example:

  resource.Resource%3A840%40base.url

• assessmentId: required(string)

  the assessment of this assessment-entry.

  Example:

  assessment.Assessment%3A1500%40base.url

• genusType: (string)

  specify a particular assessmentEntry type to create

  Example:

  type.Type%3AexampleAssessmentEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more assessmentEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this assessmentEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this assessment entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this assessment entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this assessment entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this assessment entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this assessment 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 assessment 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
    },
    "active": {
      "description": "Whether this assessment entry is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this assessment entry is operational. This assessment entry is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this assessment entry.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this assessment entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "assessmentId": {
      "description": "The assessment associated with this assessment entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateCompleted": {
      "description": "The completion date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "format": "osid-id"
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "format": "osid-id"
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AssessmentEntry",
  "description": "The description of this AssessmentEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:8817@base.url",
  "dateCompleted": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3267@base.url",
  "courseId": "course.Course:8789@base.url",
  "gradeId": "grading.Grade:6949@base.url",
  "scoreScaleId": "grading.GradeSystem:1149@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", "program", "course", "grade", "scoreScale", "student", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentEntryQuery",
  "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"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "ruleQueries": {
      "description": "rules.RuleQuery for the cyclic event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchStudentIds": {
      "description": "List of student Ids for this query to match assessment entry that have a related student.",
      "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"
          }
        }
      }
    },
    "studentQueries": {
      "description": "StudentQueries to match the student. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAssessmentIds": {
      "description": "List of assessment Ids for this query to match assessment entry that have a related assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "AssessmentQueries to match the assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchDateCompleted": {
      "description": "Matches dateCompleteds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDateCompleted": {
      "description": "Match dateCompleteds with any value. true to match AssessmentEntries with any date completed, false to match ProgramOfferings with no date completed",
      "type": "boolean"

    },
    "matchProgramIds": {
      "description": "List of Program Ids for this query to match program.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "programId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "programQueries": {
      "description": "program.ProgramQueries to match the Program. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyProgram": {
      "description": "Match program with any value. true to match AssessmentEntries with any program, false to match AssessmentEntries with no program",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of Course Ids for this query to match course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "course.CourseQueries to match the Course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCourse": {
      "description": "Match course with any value. true to match AssessmentEntries with any course, false to match AssessmentEntries with no course",
      "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 AssessmentEntries with any grade, false to match AssessmentEntries with no grade",
      "type": "boolean"
    },
    "matchScoreScaleIds": {
      "description": "List of GradeSystem Ids for this query to match scoreScale.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scoreScaleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "scoreScaleQueries": {
      "description": "grading.GradeSystemQueries to match the Score Scale. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyScoreScale": {
      "description": "Match score scale with any value. true to match AssessmentEntries with any score scale, false to match AssessmentEntries with no score scale",
      "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 AssessmentEntries with any score, false to match ProgramOfferings with no score",
      "type": "boolean"

    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• studentId: required(string)

  the student of this metadatum.

  Example:

  resource.Resource%3A840%40base.url

• assessmentId: required(string)

  the assessment of this metadatum.

  Example:

  assessment.Assessment%3A1500%40base.url

• genusType: (string)

  specify a particular assessmentEntry type to create

  Example:

  type.Type%3AexampleAssessmentEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more assessmentEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this assessmentEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

URI Parameters

• assessmentEntryId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "program", "course", "grade", "scoreScale", "student", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• assessmentEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this assessment entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this assessment entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this assessment entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this assessment entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this assessment 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 assessment 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
    },
    "active": {
      "description": "Whether this assessment entry is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this assessment entry is operational. This assessment entry is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this assessment entry.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this assessment entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "assessmentId": {
      "description": "The assessment associated with this assessment entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateCompleted": {
      "description": "The completion date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "format": "osid-id"
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "format": "osid-id"
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "format": "osid-id"
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AssessmentEntry",
  "description": "The description of this AssessmentEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:8817@base.url",
  "dateCompleted": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3267@base.url",
  "courseId": "course.Course:8789@base.url",
  "gradeId": "grading.Grade:6949@base.url",
  "scoreScaleId": "grading.GradeSystem:1149@base.url",
  "score": 3.14
}

URI Parameters

• assessmentEntryId: required(string)

URI Parameters

• assessmentEntryId: 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", "program", "course", "assessment", "student", "award", 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%3AexampleAwardEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAwardEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAwardEntryType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• studentId: (string)

  the id string to match a student.

  Example:

  resource.Resource%3A560%40base.url

• awardId: (string)

  the id string to match a award.

  Example:

  recognition.Award%3A550%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• studentId: required(string)

  the student of this award-entry.

  Example:

  resource.Resource%3A560%40base.url

• awardId: required(string)

  the award of this award-entry.

  Example:

  recognition.Award%3A550%40base.url

• genusType: (string)

  specify a particular awardEntry type to create

  Example:

  type.Type%3AexampleAwardEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more awardEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this awardEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AwardEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this award entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this award entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this award entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this award entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this award 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 award 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 award entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this award entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this award entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this award entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "awardId": {
      "description": "The award associated with this award entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "format": "osid-id"
    },
    "assessmentId": {
      "description": "The Assessment.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AwardEntry",
  "description": "The description of this AwardEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:544@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:7264@base.url",
  "courseId": "course.Course:2101@base.url",
  "assessmentId": "assessment.Assessment:6475@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", "endReason", "program", "course", "assessment", "student", "award", 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": "AwardEntryQuery",
  "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 AwardEntries with any end reason, false to match AwardEntries with no end reason",
      "type": "boolean"
    },
    "matchStudentIds": {
      "description": "List of student Ids for this query to match award entry that have a related student.",
      "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"
          }
        }
      }
    },
    "studentQueries": {
      "description": "StudentQueries to match the student. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAwardIds": {
      "description": "List of award Ids for this query to match award entry that have a related award.",
      "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"
          }
        }
      }
    },
    "awardQueries": {
      "description": "AwardQueries to match the award. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchDateAwarded": {
      "description": "Matches dateAwardeds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDateAwarded": {
      "description": "Match dateAwardeds with any value. true to match AwardEntries with any date awarded, false to match ProgramOfferings with no date awarded",
      "type": "boolean"

    },
    "matchProgramIds": {
      "description": "List of Program Ids for this query to match program.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "programId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "programQueries": {
      "description": "program.ProgramQueries to match the Program. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyProgram": {
      "description": "Match program with any value. true to match AwardEntries with any program, false to match AwardEntries with no program",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of Course Ids for this query to match course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "course.CourseQueries to match the Course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyCourse": {
      "description": "Match course with any value. true to match AwardEntries with any course, false to match AwardEntries with no course",
      "type": "boolean"
    },
    "matchAssessmentIds": {
      "description": "List of Assessment Ids for this query to match assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assessmentId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "assessment.AssessmentQueries to match the Assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAssessment": {
      "description": "Match assessment with any value. true to match AwardEntries with any assessment, false to match AwardEntries with no assessment",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• studentId: required(string)

  the student of this metadatum.

  Example:

  resource.Resource%3A560%40base.url

• awardId: required(string)

  the award of this metadatum.

  Example:

  recognition.Award%3A550%40base.url

• genusType: (string)

  specify a particular awardEntry type to create

  Example:

  type.Type%3AexampleAwardEntryType%40dxtera.org

• recordType: (array of )

  specify support for one or more awardEntry record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this awardEntry

  Example:

  chronicle.CourseCatalog%3A8374%40base.url

URI Parameters

• awardEntryId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• awardEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AwardEntry",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this award entry, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this award entry, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this award entry for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this award entry.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this award 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 award 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 award entry.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this award entry.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this award entry ended.",
      "type": "string",
      "format": "osid-id"
    },
    "studentId": {
      "description": "The student associated with this award entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "awardId": {
      "description": "The award associated with this award entry.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time"
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "format": "osid-id"
    },
    "assessmentId": {
      "description": "The Assessment.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AwardEntry",
  "description": "The description of this AwardEntry",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:544@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:7264@base.url",
  "courseId": "course.Course:2101@base.url",
  "assessmentId": "assessment.Assessment:6475@base.url"
}

URI Parameters

• awardEntryId: required(string)

URI Parameters

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

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseCatalogType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseCatalogType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

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

• programEntryId: (string)

  Get course-catalogs mapped to this program-entry.

  Example:

  chronicle.ProgramEntry%3A1521%40demo.dxtera.org

• courseEntryId: (string)

  Get course-catalogs mapped to this course-entry.

  Example:

  chronicle.CourseEntry%3A1404%40demo.dxtera.org

• credentialEntryId: (string)

  Get course-catalogs mapped to this credential-entry.

  Example:

  chronicle.CredentialEntry%3A1872%40demo.dxtera.org

• assessmentEntryId: (string)

  Get course-catalogs mapped to this assessment-entry.

  Example:

  chronicle.AssessmentEntry%3A1872%40demo.dxtera.org

• awardEntryId: (string)

  Get course-catalogs mapped to this award-entry.

  Example:

  chronicle.AwardEntry%3A1287%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular courseCatalog type to create

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseCatalog record types

  Example:

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

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseCatalog",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course catalog, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course catalog, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course catalog for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course catalog.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this course catalog.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this course catalog. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this course catalog.",
      "type": "string"
    }
  }
}

Example:

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

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: , 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": "CourseCatalogQuery",
  "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 CourseCatalog with any provider, false to match CourseCatalog 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 CourseCatalog with any branding, false to match CourseCatalog 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"
          }
        }
      }
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. 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": "CourseCatalog",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this course catalog, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course catalog, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course catalog for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this course catalog",
      "linked": false
    },
    "description": {
      "description": "The description of this course catalog.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this course catalog",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this course catalog.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this course catalog",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this course catalog. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "CourseCatalog.CourseCatalog:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this course catalog",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this course catalog.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this course catalog",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "course.CourseCatalog:8936@base.url",
    "uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A8936%40base.url",
    "displayName": "Display Name of this CourseCatalog",
    "description": "The description of this CourseCatalog",
    "genusTypeId": "type.Type:defaultCourseCatalogType@base.url",
    "recordTypeIds": [ "type.Type:exampleCourseCatalogRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:CourseCatalog@base.url",
    "license": "The license that applies to this CourseCatalog"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseCatalog",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course catalog, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course catalog, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course catalog for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course catalog.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this course catalog.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this course catalog. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this course catalog.",
      "type": "string"
    }
  }
}

Example:

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)
• childId: required(string)

URI Parameters

• courseCatalogId: required(string)
• childId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: 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", "term", "creditScale", "gpaScale", "student", "program", 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%3AexampleProgramEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleProgramEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleProgramEntryType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• programEntryId: required(string)

URI Parameters

• courseCatalogId: required(string)
• programEntryId: required(string)

URI Parameters

• courseCatalogId: 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", "term", "creditScale", "grade", "scoreScale", "student", "course", 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%3AexampleCourseEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseEntryType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• courseEntryId: required(string)

URI Parameters

• courseCatalogId: required(string)
• courseEntryId: required(string)

URI Parameters

• courseCatalogId: 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", "program", "student", "credential", 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%3AexampleCredentialEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCredentialEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCredentialEntryType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• credentialEntryId: required(string)

URI Parameters

• courseCatalogId: required(string)
• credentialEntryId: required(string)

URI Parameters

• courseCatalogId: 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", "program", "course", "grade", "scoreScale", "student", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAssessmentEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAssessmentEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAssessmentEntryType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• assessmentEntryId: required(string)

URI Parameters

• courseCatalogId: required(string)
• assessmentEntryId: required(string)

URI Parameters

• courseCatalogId: 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", "program", "course", "assessment", "student", "award", 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%3AexampleAwardEntryType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAwardEntryType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAwardEntryType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• awardEntryId: required(string)

URI Parameters

• courseCatalogId: required(string)
• awardEntryId: required(string)