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

https://base.url/chronicle

Overview

The Chronicle package provides services for examining the academic record. The entries in the academic record provide summary information for students in programs and courses as well as any credentials, awards, or standardized assessment scores the student may have received.

Chronicle provides services for creating and updating entries. The entries may be provided as read-only in response to data stored in other OSIDs or updates may be provided to override generated entries or manually insert new entries.

Quick access to these entries on a per student basis may be done in the AcademicRecord service.

This package includes the following entities:

ProgramEntries

A learner record entry for a Program. The fields in the ProgramEntry may be for the entire enrollment through the academic career or specific to a Term.

FieldDescriptionType
id(read‑only)The unique id of this program entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this program entry, provided by system.string(uri)
displayNameThe name of this program entry for display.string
descriptionThe description of this program entry.string
genusTypeId
(read‑only)		Id of the immutable type of this program entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this program entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
startDateThe starting date of this program entry.string(date‑time)
endDateThe ending date of this program entry.string(date‑time)
endReasonIdThe reason this program entry ended. References a process.State object.string(osid‑id)
studentId
(read‑only)		The student associated with this program entry. References a resource.Resource object.string(osid‑id)
programId
(read‑only)		The program associated with this program entry. References a program.Program object.string(osid‑id)
admissionDateThe date in which the student was admitted.string(date‑time)
completeTests if the program has been completed.boolean
termIdThe Term. References a course.Term objectstring(osid‑id)
creditScaleIdThe GradeSystem. References a grading.GradeSystem objectstring(osid‑id)
creditsEarnedThe number of credits earned in this program or earned within the included term.number
gpaScaleIdThe GradeSystem. References a grading.GradeSystem objectstring(osid‑id)
gpaThe cumulative GPA in this porgram or within the included term.number

CourseEntries

A learner record entry for a Course. The fields in the CourseEntry are specific to a Term.

FieldDescriptionType
id(read‑only)The unique id of this course entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this course entry, provided by system.string(uri)
displayNameThe name of this course entry for display.string
descriptionThe description of this course entry.string
genusTypeId
(read‑only)		Id of the immutable type of this course entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this course entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
startDateThe starting date of this course entry.string(date‑time)
endDateThe ending date of this course entry.string(date‑time)
endReasonIdThe reason this course entry ended. References a process.State object.string(osid‑id)
studentId
(read‑only)		The student associated with this course entry. References a resource.Resource object.string(osid‑id)
courseId
(read‑only)		The course associated with this course entry. References a course.Course object.string(osid‑id)
termIdThe Term. References a course.Term objectstring(osid‑id)
completeTests if the course has been completed.boolean
creditScaleIdThe GradeSystem. References a grading.GradeSystem objectstring(osid‑id)
creditsEarnedThe number of credits earned in this course.number
gradeIdThe Grade. References a grading.Grade objectstring(osid‑id)
scoreScaleIdThe GradeSystem. References a grading.GradeSystem objectstring(osid‑id)
scoreThe cumulative score.number

CredentialEntries

A learner record entry for a Credential. Might also be related to a "badge" awarded to a learner based on completion of an educational Program.

FieldDescriptionType
id(read‑only)The unique id of this credential entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this credential entry, provided by system.string(uri)
displayNameThe name of this credential entry for display.string
descriptionThe description of this credential entry.string
genusTypeId
(read‑only)		Id of the immutable type of this credential entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this credential entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
startDateThe starting date of this credential entry.string(date‑time)
endDateThe ending date of this credential entry.string(date‑time)
endReasonIdThe reason this credential entry ended. References a process.State object.string(osid‑id)
studentId
(read‑only)		The student associated with this credential entry. References a resource.Resource object.string(osid‑id)
credentialId
(read‑only)		The credential associated with this credential entry. References a program.Credential object.string(osid‑id)
dateAwardedThe award date.string(date‑time)
programIdThe Program. References a program.Program objectstring(osid‑id)

AssessmentEntries

A learner record entry for an Assessment. This is intended to record results of standardized tests and other major assessments associated with a learner's record.

FieldDescriptionType
id(read‑only)The unique id of this assessment entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this assessment entry, provided by system.string(uri)
displayNameThe name of this assessment entry for display.string
descriptionThe description of this assessment entry.string
genusTypeId
(read‑only)		Id of the immutable type of this assessment entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this assessment entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
active
(read‑only)		Whether this assessment entry is active. Active is true if operational is true and disabled is false, or enabled is true.boolean
enabledWhether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.boolean
disabledWhether this assessment entry is administravely disabled. Administratively disabling overrides any applied enabler.boolean
operational
(read‑only)		Whether this assessment entry is operational. This assessment entry is operational if any of the applied enablers are true.boolean
ruleIdAn explicit rule for this assessment entry. References a rules.Rule object.string(osid‑id)
studentId
(read‑only)		The student associated with this assessment entry. References a resource.Resource object.string(osid‑id)
assessmentId
(read‑only)		The assessment associated with this assessment entry. References an assessment.Assessment object.string(osid‑id)
dateCompletedThe completion date.string(date‑time)
programIdThe Program. References a program.Program objectstring(osid‑id)
courseIdThe Course. References a course.Course objectstring(osid‑id)
gradeIdThe Grade. References a grading.Grade objectstring(osid‑id)
scoreScaleIdThe GradeSystem. References a grading.GradeSystem objectstring(osid‑id)
scoreThe cumulative score.number

AwardEntries

An academic record entry for a Recognition. Might also be related to a "badge" issued upon a learner in less formal or independend learning activities.

FieldDescriptionType
id(read‑only)The unique id of this award entry, provided by system.string(osid‑id)
uri(read‑only)The uri of this award entry, provided by system.string(uri)
displayNameThe name of this award entry for display.string
descriptionThe description of this award entry.string
genusTypeId
(read‑only)		Id of the immutable type of this award entry. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this award entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
startDateThe starting date of this award entry.string(date‑time)
endDateThe ending date of this award entry.string(date‑time)
endReasonIdThe reason this award entry ended. References a process.State object.string(osid‑id)
studentId
(read‑only)		The student associated with this award entry. References a resource.Resource object.string(osid‑id)
awardId
(read‑only)		The award associated with this award entry. References a recognition.Award object.string(osid‑id)
dateAwardedThe award date.string(date‑time)
programIdThe Program. References a program.Program objectstring(osid‑id)
courseIdThe Course. References a course.Course objectstring(osid‑id)
assessmentIdThe Assessment. References an assessment.Assessment objectstring(osid‑id)

CourseCatalogs

Courses, ActivityUnits, CourseOfferings, Activities, and Terms can be organized into federateble catalogs. CourseCatalogs can be used to represent a set of CourseOfferings offered in a specific Term, year, or by subject area, sponsor, campus, etc.

FieldDescriptionType
id(read‑only)The unique id of this course catalog, provided by system.string(osid‑id)
uri(read‑only)The uri of this course catalog, provided by system.string(uri)
displayNameThe name of this course catalog for display.string
descriptionThe description of this course catalog.string
genusTypeId
(read‑only)		Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		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.string(osid‑id)[]
providerIdThe provider of this course catalog. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this course catalog. References repository.Asset objects.string(osid‑id)[]
licenseThe licensing that applies to this course catalog.string

License

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

/academic-records

Quick access to chronicle entries on a per-student basis may be done through academicRecords. These methods may be secured by an authorization implementation specifically designed for record validation.

get

Collection of academic-records in a system that are get-only through this endpoint.

get

Get academic-records in the system.

Get academic-records in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "programEntries": [
    {
      "id": "chronicle.ProgramEntry:1344@demo.dxtera.org",
      "uri": "http://demo.dxtera.org/open/campusapi/chronicle/program-entry/chronicle.ProgramEntry%3A31415%40demo.dxtera.org",
      "displayName": "Display Name of this ProgramEntry",
      "description": "The description of this ProgramEntry",
      "genusType": "type.Type:defaultProgramEntryType@dxtera.org",
      "startDate": "2020-10-03T06:30:00.000Z",
      "endDate": "2020-12-18T19:30:00.000Z",
      "endReasonId": "process.State:1344@demo.dxtera.org",
      "studentId": "resource.Resource:4955@demo.dxtera.org",
      "programId": "course.program.Program:4495@demo.dxtera.org",
      "admissionDate": "2021-07-21T23:15:30.000Z",
      "complete": true,
      "termId": "course.Term:8475@demo.dxtera.org",
      "creditScaleId": "grading.GradeSystem:7638@demo.dxtera.org",
      "creditsEarned": 3.14,
      "gpaScaleId": "grading.GradeSystem:2551@demo.dxtera.org",
      "gpa": 3.14
    },
    {
      "...": "..."
    }
  ],
  "courseEntries": [
    {
      "id": "chronicle.CourseEntry:2166@demo.dxtera.org",
      "uri": "http://demo.dxtera.org/open/campusapi/chronicle/course-entry/chronicle.CourseEntry%3A31415%40demo.dxtera.org",
      "displayName": "Display Name of this CourseEntry",
      "description": "The description of this CourseEntry",
      "genusType": "type.Type:defaultCourseEntryType@dxtera.org",
      "startDate": "2020-10-03T06:30:00.000Z",
      "endDate": "2020-12-18T19:30:00.000Z",
      "endReasonId": "process.State:2166@demo.dxtera.org",
      "studentId": "resource.Resource:4959@demo.dxtera.org",
      "courseId": "course.Course:2331@demo.dxtera.org",
      "termId": "course.Term:4222@demo.dxtera.org",
      "complete": true,
      "creditScaleId": "grading.GradeSystem:291@demo.dxtera.org",
      "creditsEarned": 3.14,
      "gradeId": "grading.Grade:2217@demo.dxtera.org",
      "scoreScaleId": "grading.GradeSystem:4379@demo.dxtera.org",
      "score": 3.14
    },
    {
      "...": "..."
    }
  ],
  "credentialEntries": [
    {
      "id": "chronicle.CredentialEntry:8825@demo.dxtera.org",
      "uri": "http://demo.dxtera.org/open/campusapi/chronicle/credential-entry/chronicle.CredentialEntry%3A31415%40demo.dxtera.org",
      "displayName": "Display Name of this CredentialEntry",
      "description": "The description of this CredentialEntry",
      "genusType": "type.Type:defaultCredentialEntryType@dxtera.org",
      "startDate": "2020-10-03T06:30:00.000Z",
      "endDate": "2020-12-18T19:30:00.000Z",
      "endReasonId": "process.State:8825@demo.dxtera.org",
      "studentId": "resource.Resource:5053@demo.dxtera.org",
      "credentialId": "course.program.Credential:5891@demo.dxtera.org",
      "dateAwarded": "2021-07-21T23:15:30.000Z",
      "programId": "course.program.Program:8462@demo.dxtera.org"
    },
    {
      "...": "..."
    }
  ],
  "assessmentEntries": [
    {
      "id": "chronicle.AssessmentEntry:5210@demo.dxtera.org",
      "uri": "http://demo.dxtera.org/open/campusapi/chronicle/assessment-entry/chronicle.AssessmentEntry%3A31415%40demo.dxtera.org",
      "displayName": "Display Name of this AssessmentEntry",
      "description": "The description of this AssessmentEntry",
      "genusType": "type.Type:defaultAssessmentEntryType@dxtera.org",
      "startDate": "2020-10-03T06:30:00.000Z",
      "endDate": "2020-12-18T19:30:00.000Z",
      "endReasonId": "process.State:5210@demo.dxtera.org",
      "studentId": "resource.Resource:7034@demo.dxtera.org",
      "assessmentId": "assessment.Assessment:9832@demo.dxtera.org",
      "dateCompleted": "2021-07-21T23:15:30.000Z",
      "programId": "course.program.Program:3933@demo.dxtera.org",
      "courseId": "course.Course:4897@demo.dxtera.org",
      "gradeId": "grading.Grade:296@demo.dxtera.org",
      "scoreScaleId": "grading.GradeSystem:435@demo.dxtera.org",
      "score": 3.14
    },
    {
      "...": "..."
    }
  ],
  "awardEntries": [
    {
      "id": "chronicle.AwardEntry:8092@demo.dxtera.org",
      "uri": "http://demo.dxtera.org/open/campusapi/chronicle/award-entry/chronicle.AwardEntry%3A31415%40demo.dxtera.org",
      "displayName": "Display Name of this AwardEntry",
      "description": "The description of this AwardEntry",
      "genusType": "type.Type:defaultAwardEntryType@dxtera.org",
      "startDate": "2020-10-03T06:30:00.000Z",
      "endDate": "2020-12-18T19:30:00.000Z",
      "endReasonId": "process.State:8092@demo.dxtera.org",
      "studentId": "resource.Resource:562@demo.dxtera.org",
      "awardId": "recognition.Award:8701@demo.dxtera.org",
      "dateAwarded": "2021-07-21T23:15:30.000Z",
      "programId": "course.program.Program:5187@demo.dxtera.org",
      "courseId": "course.Course:5614@demo.dxtera.org",
      "assessmentId": "assessment.Assessment:4261@demo.dxtera.org"
    },
    {
      "...": "..."
    }
  ]
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Collection of program-entries in a system that are get-only through this endpoint.

get

Get program-entries in the system.

Get program-entries in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.ProgramEntry:3256@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/programEntry/chronicle.ProgramEntry%3A3256%40base.url",
    "displayName": "Display Name of this ProgramEntry",
    "description": "The description of this ProgramEntry",
    "genusTypeId": "type.Type:defaultProgramEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleProgramEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:3256@base.url",
    "studentId": "resource.Resource:4797@base.url",
    "programId": "course.program.Program:9129@base.url",
    "admissionDate": "2021-07-21T23:15:30.000Z",
    "complete": true,
    "termId": "course.Term:3276@base.url",
    "creditScaleId": "grading.GradeSystem:689@base.url",
    "creditsEarned": 3.14,
    "gpaScaleId": "grading.GradeSystem:9795@base.url",
    "gpa": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Collection of course-entries in a system that are get-only through this endpoint.

get

Get course-entries in the system.

Get course-entries in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.CourseEntry:9798@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/courseEntry/chronicle.CourseEntry%3A9798%40base.url",
    "displayName": "Display Name of this CourseEntry",
    "description": "The description of this CourseEntry",
    "genusTypeId": "type.Type:defaultCourseEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleCourseEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:9798@base.url",
    "studentId": "resource.Resource:5628@base.url",
    "courseId": "course.Course:9069@base.url",
    "termId": "course.Term:5322@base.url",
    "complete": true,
    "creditScaleId": "grading.GradeSystem:1678@base.url",
    "creditsEarned": 3.14,
    "gradeId": "grading.Grade:1484@base.url",
    "scoreScaleId": "grading.GradeSystem:6873@base.url",
    "score": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Collection of credential-entries in a system that are get-only through this endpoint.

get

Get credential-entries in the system.

Get credential-entries in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.CredentialEntry:2838@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/credentialEntry/chronicle.CredentialEntry%3A2838%40base.url",
    "displayName": "Display Name of this CredentialEntry",
    "description": "The description of this CredentialEntry",
    "genusTypeId": "type.Type:defaultCredentialEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleCredentialEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:2838@base.url",
    "studentId": "resource.Resource:5981@base.url",
    "credentialId": "course.program.Credential:8655@base.url",
    "dateAwarded": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:8913@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Collection of assessment-entries in a system that are get-only through this endpoint.

get

Get assessment-entries in the system.

Get assessment-entries in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.AssessmentEntry:7704@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/assessmentEntry/chronicle.AssessmentEntry%3A7704%40base.url",
    "displayName": "Display Name of this AssessmentEntry",
    "description": "The description of this AssessmentEntry",
    "genusTypeId": "type.Type:defaultAssessmentEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleAssessmentEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:7704@base.url",
    "studentId": "resource.Resource:7963@base.url",
    "assessmentId": "assessment.Assessment:5846@base.url",
    "dateCompleted": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:5143@base.url",
    "courseId": "course.Course:4871@base.url",
    "gradeId": "grading.Grade:4038@base.url",
    "scoreScaleId": "grading.GradeSystem:8827@base.url",
    "score": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Collection of award-entries in a system that are get-only through this endpoint.

get

Get award-entries in the system.

Get award-entries in the system.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.AwardEntry:3078@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/awardEntry/chronicle.AwardEntry%3A3078%40base.url",
    "displayName": "Display Name of this AwardEntry",
    "description": "The description of this AwardEntry",
    "genusTypeId": "type.Type:defaultAwardEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleAwardEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:3078@base.url",
    "studentId": "resource.Resource:5500@base.url",
    "awardId": "recognition.Award:9766@base.url",
    "dateAwarded": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:3020@base.url",
    "courseId": "course.Course:5064@base.url",
    "assessmentId": "assessment.Assessment:5863@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

/program-entries

Collection of program-entries in a system, federation of systems, or in a default courseCatalog.

get post

get

Get all program-entries in the system or default courseCatalog.

post

Create a new program-entry in the default courseCatalog.

Create a new program-entry in the default courseCatalog.

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:1346@base.url",
  "admissionDate": "2021-07-21T23:15:30.000Z",
  "complete": true,
  "termId": "course.Term:5238@base.url",
  "creditScaleId": "grading.GradeSystem:5757@base.url",
  "creditsEarned": 3.14,
  "gpaScaleId": "grading.GradeSystem:9925@base.url",
  "gpa": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The program-entry has been created",
  "program-entryId": "chronicle.ProgramEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a programEntry form metadata.

get

Get form metadata for creating a new programEntry.

get put delete

Entity representing a program-entry

get

Get a program-entry given its id.

put

Update a given program-entry.

delete

Delete a given program-entry.

Get a program-entry given its id.

URI Parameters

  • programEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "chronicle.ProgramEntry:3256@base.url",
  "uri": "http://base.url/open/campusapi/chronicle/programEntry/chronicle.ProgramEntry%3A3256%40base.url",
  "displayName": "Display Name of this ProgramEntry",
  "description": "The description of this ProgramEntry",
  "genusTypeId": "type.Type:defaultProgramEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleProgramEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:3256@base.url",
  "studentId": "resource.Resource:4797@base.url",
  "programId": "course.program.Program:9129@base.url",
  "admissionDate": "2021-07-21T23:15:30.000Z",
  "complete": true,
  "termId": "course.Term:3276@base.url",
  "creditScaleId": "grading.GradeSystem:689@base.url",
  "creditsEarned": 3.14,
  "gpaScaleId": "grading.GradeSystem:9795@base.url",
  "gpa": 3.14
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Update a given program-entry.

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:1346@base.url",
  "admissionDate": "2021-07-21T23:15:30.000Z",
  "complete": true,
  "termId": "course.Term:5238@base.url",
  "creditScaleId": "grading.GradeSystem:5757@base.url",
  "creditsEarned": 3.14,
  "gpaScaleId": "grading.GradeSystem:9925@base.url",
  "gpa": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Delete a given program-entry.

URI Parameters

  • programEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

Entity representing a programEntry form metadata for update

get

Get form metadata for updating an existing programEntry.

Get form metadata for updating an existing programEntry.

URI Parameters

  • programEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "ProgramEntry",
  "type": "object",
  "required": ["displayName"],
  "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",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "ProgramEntry.ProgramEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this program entry",
      "linked": false
    },
    "description": {
      "description": "The description of this program entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "ProgramEntry.ProgramEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this program entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this program entry. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this 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",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "ProgramEntry.ProgramEntry:startDate@base.url",
      "existingValue": "2020-10-03T08:00:00.000Z",
      "elementLabel": "Start Date",
      "instructions": "Enter a starting date for this program entry",
      "linked": false
    },
    "endDate": {
      "description": "The ending date of this program entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "ProgramEntry.ProgramEntry:endDate@base.url",
      "existingValue": "2020-12-18T17:00:00.000Z",
      "elementLabel": "End Date",
      "instructions": "Enter an ending date for this program entry",
      "linked": false
    },
    "endReasonId": {
      "description": "The reason this program entry ended. A process/State object.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "ProgramEntry.ProgramEntry:endReason@base.url",
      "existingValue": "process.State:1860@base.url",
      "elementLabel": "End Reason",
      "instructions": "Select the reason this program entry ended",
      "linked": false
    },
    "admissionDate": {
      "description": "The date in which the student was admitted.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:admissionDate@dxtera.org",
      "existingValue": "",
      "elementLabel": "Admission Date",
      "instructions": "Enter the admission date of this program entry.",
      "linked": false
    },
    "complete": {
      "description": "Tests if the program has been completed.",
      "type": "boolean",
      "elementId": "course.chronicle.ProgramEntry:complete@dxtera.org",
      "existingValue": false,
      "elementLabel": "Complete",
      "instructions": "Enter true or false.",
      "linked": false
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:term@dxtera.org",
      "existingValue": null,
      "elementLabel": "Term",
      "instructions": "Enter the Id of the term for this program entry.",
      "linked": false
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:creditScale@dxtera.org",
      "existingValue": null,
      "elementLabel": "Credit Scale",
      "instructions": "Enter the Id of the credit scale for this program entry.",
      "linked": false
    },
    "creditsEarned": {
      "description": "The number of credits earned in this program or earned within the included term.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:creditsEarned@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Credits Earned",
      "instructions": "Enter the credits earned of this program entry.",
      "linked": false
    },
    "gpaScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:gpaScale@dxtera.org",
      "existingValue": null,
      "elementLabel": "GPA Scale",
      "instructions": "Enter the Id of the gpa scale for this program entry.",
      "linked": false
    },
    "gpa": {
      "description": "The cumulative GPA in this porgram or within the included term.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "course.chronicle.ProgramEntry:gpa@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "GPA",
      "instructions": "Enter the gpa of this program entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "programEntry not found" }

/course-entries

Collection of course-entries in a system, federation of systems, or in a default courseCatalog.

get post

get

Get all course-entries in the system or default courseCatalog.

post

Create a new course-entry in the default courseCatalog.

Create a new course-entry in the default courseCatalog.

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:1070@base.url",
  "termId": "course.Term:2617@base.url",
  "complete": true,
  "creditScaleId": "grading.GradeSystem:6322@base.url",
  "creditsEarned": 3.14,
  "gradeId": "grading.Grade:5264@base.url",
  "scoreScaleId": "grading.GradeSystem:785@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The course-entry has been created",
  "course-entryId": "chronicle.CourseEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a courseEntry form metadata.

get

Get form metadata for creating a new courseEntry.

get put delete

Entity representing a course-entry

get

Get a course-entry given its id.

put

Update a given course-entry.

delete

Delete a given course-entry.

Get a course-entry given its id.

URI Parameters

  • courseEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "chronicle.CourseEntry:9798@base.url",
  "uri": "http://base.url/open/campusapi/chronicle/courseEntry/chronicle.CourseEntry%3A9798%40base.url",
  "displayName": "Display Name of this CourseEntry",
  "description": "The description of this CourseEntry",
  "genusTypeId": "type.Type:defaultCourseEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleCourseEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:9798@base.url",
  "studentId": "resource.Resource:5628@base.url",
  "courseId": "course.Course:9069@base.url",
  "termId": "course.Term:5322@base.url",
  "complete": true,
  "creditScaleId": "grading.GradeSystem:1678@base.url",
  "creditsEarned": 3.14,
  "gradeId": "grading.Grade:1484@base.url",
  "scoreScaleId": "grading.GradeSystem:6873@base.url",
  "score": 3.14
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Update a given course-entry.

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:1070@base.url",
  "termId": "course.Term:2617@base.url",
  "complete": true,
  "creditScaleId": "grading.GradeSystem:6322@base.url",
  "creditsEarned": 3.14,
  "gradeId": "grading.Grade:5264@base.url",
  "scoreScaleId": "grading.GradeSystem:785@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Delete a given course-entry.

URI Parameters

  • courseEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

Entity representing a courseEntry form metadata for update

get

Get form metadata for updating an existing courseEntry.

Get form metadata for updating an existing courseEntry.

URI Parameters

  • courseEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "CourseEntry",
  "type": "object",
  "required": ["displayName"],
  "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",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseEntry.CourseEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this course entry",
      "linked": false
    },
    "description": {
      "description": "The description of this course entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseEntry.CourseEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this course entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course entry. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this 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",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseEntry.CourseEntry:startDate@base.url",
      "existingValue": "2020-10-03T08:00:00.000Z",
      "elementLabel": "Start Date",
      "instructions": "Enter a starting date for this course entry",
      "linked": false
    },
    "endDate": {
      "description": "The ending date of this course entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseEntry.CourseEntry:endDate@base.url",
      "existingValue": "2020-12-18T17:00:00.000Z",
      "elementLabel": "End Date",
      "instructions": "Enter an ending date for this course entry",
      "linked": false
    },
    "endReasonId": {
      "description": "The reason this course entry ended. A process/State object.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseEntry.CourseEntry:endReason@base.url",
      "existingValue": "process.State:1860@base.url",
      "elementLabel": "End Reason",
      "instructions": "Select the reason this course entry ended",
      "linked": false
    },
    "termId": {
      "description": "The Term.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:term@dxtera.org",
      "existingValue": null,
      "elementLabel": "Term",
      "instructions": "Enter the Id of the term for this course entry.",
      "linked": false
    },
    "complete": {
      "description": "Tests if the course has been completed.",
      "type": "boolean",
      "elementId": "course.chronicle.CourseEntry:complete@dxtera.org",
      "existingValue": false,
      "elementLabel": "Complete",
      "instructions": "Enter true or false.",
      "linked": false
    },
    "creditScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:creditScale@dxtera.org",
      "existingValue": null,
      "elementLabel": "Credit Scale",
      "instructions": "Enter the Id of the credit scale for this course entry.",
      "linked": false
    },
    "creditsEarned": {
      "description": "The number of credits earned in this course.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:creditsEarned@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Credits Earned",
      "instructions": "Enter the credits earned of this course entry.",
      "linked": false
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:grade@dxtera.org",
      "existingValue": null,
      "elementLabel": "Grade",
      "instructions": "Enter the Id of the grade for this course entry.",
      "linked": false
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:scoreScale@dxtera.org",
      "existingValue": null,
      "elementLabel": "Score Scale",
      "instructions": "Enter the Id of the score scale for this course entry.",
      "linked": false
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "course.chronicle.CourseEntry:score@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Score",
      "instructions": "Enter the score of this course entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "courseEntry not found" }

/credential-entries

Collection of credential-entries in a system, federation of systems, or in a default courseCatalog.

get post

get

Get all credential-entries in the system or default courseCatalog.

post

Create a new credential-entry in the default courseCatalog.

Create a new credential-entry in the default courseCatalog.

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:9448@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:7982@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The credential-entry has been created",
  "credential-entryId": "chronicle.CredentialEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a credentialEntry form metadata.

get

Get form metadata for creating a new credentialEntry.

get put delete

Entity representing a credential-entry

get

Get a credential-entry given its id.

put

Update a given credential-entry.

delete

Delete a given credential-entry.

Get a credential-entry given its id.

URI Parameters

  • credentialEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "chronicle.CredentialEntry:2838@base.url",
  "uri": "http://base.url/open/campusapi/chronicle/credentialEntry/chronicle.CredentialEntry%3A2838%40base.url",
  "displayName": "Display Name of this CredentialEntry",
  "description": "The description of this CredentialEntry",
  "genusTypeId": "type.Type:defaultCredentialEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleCredentialEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:2838@base.url",
  "studentId": "resource.Resource:5981@base.url",
  "credentialId": "course.program.Credential:8655@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:8913@base.url"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Update a given credential-entry.

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:9448@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:7982@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Delete a given credential-entry.

URI Parameters

  • credentialEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

Entity representing a credentialEntry form metadata for update

get

Get form metadata for updating an existing credentialEntry.

Get form metadata for updating an existing credentialEntry.

URI Parameters

  • credentialEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "CredentialEntry",
  "type": "object",
  "required": ["displayName"],
  "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",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CredentialEntry.CredentialEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this credential entry",
      "linked": false
    },
    "description": {
      "description": "The description of this credential entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CredentialEntry.CredentialEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this credential entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this credential entry. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this 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",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CredentialEntry.CredentialEntry:startDate@base.url",
      "existingValue": "2020-10-03T08:00:00.000Z",
      "elementLabel": "Start Date",
      "instructions": "Enter a starting date for this credential entry",
      "linked": false
    },
    "endDate": {
      "description": "The ending date of this credential entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CredentialEntry.CredentialEntry:endDate@base.url",
      "existingValue": "2020-12-18T17:00:00.000Z",
      "elementLabel": "End Date",
      "instructions": "Enter an ending date for this credential entry",
      "linked": false
    },
    "endReasonId": {
      "description": "The reason this credential entry ended. A process/State object.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CredentialEntry.CredentialEntry:endReason@base.url",
      "existingValue": "process.State:1860@base.url",
      "elementLabel": "End Reason",
      "instructions": "Select the reason this credential entry ended",
      "linked": false
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CredentialEntry:dateAwarded@dxtera.org",
      "existingValue": "",
      "elementLabel": "Date Awarded",
      "instructions": "Enter the date awarded of this credential entry.",
      "linked": false
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.CredentialEntry:program@dxtera.org",
      "existingValue": null,
      "elementLabel": "Program",
      "instructions": "Enter the Id of the program for this credential entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "credentialEntry not found" }

/assessment-entries

Collection of assessment-entries in a system, federation of systems, or in a default courseCatalog.

get post

get

Get all assessment-entries in the system or default courseCatalog.

post

Create a new assessment-entry in the default courseCatalog.

Create a new assessment-entry in the default courseCatalog.

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:1201@base.url",
  "dateCompleted": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3027@base.url",
  "courseId": "course.Course:8872@base.url",
  "gradeId": "grading.Grade:7469@base.url",
  "scoreScaleId": "grading.GradeSystem:9708@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The assessment-entry has been created",
  "assessment-entryId": "chronicle.AssessmentEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a assessmentEntry form metadata.

get

Get form metadata for creating a new assessmentEntry.

get put delete

Entity representing a assessment-entry

get

Get a assessment-entry given its id.

put

Update a given assessment-entry.

delete

Delete a given assessment-entry.

Get a assessment-entry given its id.

URI Parameters

  • assessmentEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "chronicle.AssessmentEntry:7704@base.url",
  "uri": "http://base.url/open/campusapi/chronicle/assessmentEntry/chronicle.AssessmentEntry%3A7704%40base.url",
  "displayName": "Display Name of this AssessmentEntry",
  "description": "The description of this AssessmentEntry",
  "genusTypeId": "type.Type:defaultAssessmentEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleAssessmentEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7704@base.url",
  "studentId": "resource.Resource:7963@base.url",
  "assessmentId": "assessment.Assessment:5846@base.url",
  "dateCompleted": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:5143@base.url",
  "courseId": "course.Course:4871@base.url",
  "gradeId": "grading.Grade:4038@base.url",
  "scoreScaleId": "grading.GradeSystem:8827@base.url",
  "score": 3.14
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Update a given assessment-entry.

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:1201@base.url",
  "dateCompleted": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3027@base.url",
  "courseId": "course.Course:8872@base.url",
  "gradeId": "grading.Grade:7469@base.url",
  "scoreScaleId": "grading.GradeSystem:9708@base.url",
  "score": 3.14
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Delete a given assessment-entry.

URI Parameters

  • assessmentEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

Entity representing a assessmentEntry form metadata for update

get

Get form metadata for updating an existing assessmentEntry.

Get form metadata for updating an existing assessmentEntry.

URI Parameters

  • assessmentEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "AssessmentEntry",
  "type": "object",
  "required": ["displayName"],
  "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",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AssessmentEntry.AssessmentEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this assessment entry",
      "linked": false
    },
    "description": {
      "description": "The description of this assessment entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AssessmentEntry.AssessmentEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this assessment entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this assessment entry. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this 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
    },
    "enabled": {
      "description": "Whether this assessment entry is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean",
      "read-only": false,
      "elementId": "AssessmentEntry.AssessmentEntry:enabled@base.url",
      "existingValue": false,
      "elementLabel": "Enabled",
      "instructions": "Enter whether this assessment entry is enabled",
      "linked": false
    },
    "disabled": {
      "description": "Whether this assessment entry is administravely disabled. Administratively disabling overrides any applied enabler.",
      "type": "boolean",
      "read-only": false,
      "elementId": "AssessmentEntry.AssessmentEntry:enabled@base.url",
      "existingValue": false,
      "elementLabel": "Enabled",
      "instructions": "Enter whether this assessment entry is enabled",
      "linked": false
    },
    "ruleId": {
      "description": "An explicit Rule for this assessment entry.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AssessmentEntry.AssessmentEntry:rule@base.url",
      "existingValue": "",
      "elementLabel": "Rule",
      "instructions": "Select a Rule to apply to this assessment entry",
      "linked": false
    },
    "dateCompleted": {
      "description": "The completion date.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:dateCompleted@dxtera.org",
      "existingValue": "",
      "elementLabel": "Date Completed",
      "instructions": "Enter the date completed of this assessment entry.",
      "linked": false
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:program@dxtera.org",
      "existingValue": null,
      "elementLabel": "Program",
      "instructions": "Enter the Id of the program for this assessment entry.",
      "linked": false
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:course@dxtera.org",
      "existingValue": null,
      "elementLabel": "Course",
      "instructions": "Enter the Id of the course for this assessment entry.",
      "linked": false
    },
    "gradeId": {
      "description": "The Grade.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:grade@dxtera.org",
      "existingValue": null,
      "elementLabel": "Grade",
      "instructions": "Enter the Id of the grade for this assessment entry.",
      "linked": false
    },
    "scoreScaleId": {
      "description": "The GradeSystem.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:scoreScale@dxtera.org",
      "existingValue": null,
      "elementLabel": "Score Scale",
      "instructions": "Enter the Id of the score scale for this assessment entry.",
      "linked": false
    },
    "score": {
      "description": "The cumulative score.",
      "type": "number",
      "minimum": null,
      "maximum": null,
      "units": "",
      "default": null,
      "enum": [],
      "elementId": "course.chronicle.AssessmentEntry:score@dxtera.org",
      "existingValue": 3.14,
      "elementLabel": "Score",
      "instructions": "Enter the score of this assessment entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "assessmentEntry not found" }

/award-entries

Collection of award-entries in a system, federation of systems, or in a default courseCatalog.

get post

get

Get all award-entries in the system or default courseCatalog.

post

Create a new award-entry in the default courseCatalog.

Create a new award-entry in the default courseCatalog.

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:4022@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:9366@base.url",
  "courseId": "course.Course:8954@base.url",
  "assessmentId": "assessment.Assessment:6697@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The award-entry has been created",
  "award-entryId": "chronicle.AwardEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a awardEntry form metadata.

get

Get form metadata for creating a new awardEntry.

get put delete

Entity representing a award-entry

get

Get a award-entry given its id.

put

Update a given award-entry.

delete

Delete a given award-entry.

Get a award-entry given its id.

URI Parameters

  • awardEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "chronicle.AwardEntry:3078@base.url",
  "uri": "http://base.url/open/campusapi/chronicle/awardEntry/chronicle.AwardEntry%3A3078%40base.url",
  "displayName": "Display Name of this AwardEntry",
  "description": "The description of this AwardEntry",
  "genusTypeId": "type.Type:defaultAwardEntryType@base.url",
  "recordTypeIds": [ "type.Type:exampleAwardEntryRecordType@campusapi.org", "..."],
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:3078@base.url",
  "studentId": "resource.Resource:5500@base.url",
  "awardId": "recognition.Award:9766@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:3020@base.url",
  "courseId": "course.Course:5064@base.url",
  "assessmentId": "assessment.Assessment:5863@base.url"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Update a given award-entry.

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:4022@base.url",
  "dateAwarded": "2021-07-21T23:15:30.000Z",
  "programId": "course.program.Program:9366@base.url",
  "courseId": "course.Course:8954@base.url",
  "assessmentId": "assessment.Assessment:6697@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Delete a given award-entry.

URI Parameters

  • awardEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

Entity representing a awardEntry form metadata for update

get

Get form metadata for updating an existing awardEntry.

Get form metadata for updating an existing awardEntry.

URI Parameters

  • awardEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "AwardEntry",
  "type": "object",
  "required": ["displayName"],
  "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",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AwardEntry.AwardEntry:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this award entry",
      "linked": false
    },
    "description": {
      "description": "The description of this award entry.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AwardEntry.AwardEntry:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this award entry",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this award entry. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this 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",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AwardEntry.AwardEntry:startDate@base.url",
      "existingValue": "2020-10-03T08:00:00.000Z",
      "elementLabel": "Start Date",
      "instructions": "Enter a starting date for this award entry",
      "linked": false
    },
    "endDate": {
      "description": "The ending date of this award entry.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AwardEntry.AwardEntry:endDate@base.url",
      "existingValue": "2020-12-18T17:00:00.000Z",
      "elementLabel": "End Date",
      "instructions": "Enter an ending date for this award entry",
      "linked": false
    },
    "endReasonId": {
      "description": "The reason this award entry ended. A process/State object.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "AwardEntry.AwardEntry:endReason@base.url",
      "existingValue": "process.State:1860@base.url",
      "elementLabel": "End Reason",
      "instructions": "Select the reason this award entry ended",
      "linked": false
    },
    "dateAwarded": {
      "description": "The award date.",
      "type": "string",
      "format": "date-time",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AwardEntry:dateAwarded@dxtera.org",
      "existingValue": "",
      "elementLabel": "Date Awarded",
      "instructions": "Enter the date awarded of this award entry.",
      "linked": false
    },
    "programId": {
      "description": "The Program.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AwardEntry:program@dxtera.org",
      "existingValue": null,
      "elementLabel": "Program",
      "instructions": "Enter the Id of the program for this award entry.",
      "linked": false
    },
    "courseId": {
      "description": "The Course.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AwardEntry:course@dxtera.org",
      "existingValue": null,
      "elementLabel": "Course",
      "instructions": "Enter the Id of the course for this award entry.",
      "linked": false
    },
    "assessmentId": {
      "description": "The Assessment.",
      "type": "string",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "course.chronicle.AwardEntry:assessment@dxtera.org",
      "existingValue": null,
      "elementLabel": "Assessment",
      "instructions": "Enter the Id of the assessment for this award entry.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "awardEntry not found" }

/course-catalogs

Collection of course-catalogs in a system or federation of systems.

get post

get

Get all course-catalogs.

post

Create a new course-catalog.

Create a new course-catalog.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The course-catalog has been created",
  "course-catalogId": "chronicle.CourseCatalog:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a courseCatalog form metadata.

get

Get form metadata for creating a new courseCatalog.

get

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

get

Get all root root-course-catalog

get put delete

Entity representing a course-catalog

get

Get a course-catalog given its id.

put

Update a given course-catalog.

delete

Delete a given course-catalog.

Get a course-catalog given its id.

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "course.CourseCatalog:2322@base.url",
  "uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%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" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "course-catalog not found" }

Update a given course-catalog.

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The course-catalog has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "course-catalog not found" }

Delete a given course-catalog.

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The course-catalog has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "course-catalog not found" }

get

Entity representing a courseCatalog form metadata for update

get

Get form metadata for updating an existing courseCatalog.

Get form metadata for updating an existing courseCatalog.

URI Parameters

  • courseCatalogId: required(string)

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 404

Body

Media type: application/json

Type: any

Example:

{"message": "courseCatalog not found" }

get

get

Get child courseCatalogs for the given courseCatalog in the hierarchy.

Get child courseCatalogs for the given courseCatalog in the hierarchy.

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "course.CourseCatalog:2322@base.url",
    "uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%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" }

put delete

put

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

delete

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

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

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "courseCatalog not found" }

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

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get parent courseCatalogs for the given courseCatalog in the hierarchy.

Get parent courseCatalogs for the given courseCatalog in the hierarchy.

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "course.CourseCatalog:2322@base.url",
    "uri": "http://base.url/open/campusapi/course/courseCatalog/course.CourseCatalog%3A2322%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" }

get

get

Get all program-entries in this courseCatalog

Get all program-entries in this courseCatalog

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.ProgramEntry:3256@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/programEntry/chronicle.ProgramEntry%3A3256%40base.url",
    "displayName": "Display Name of this ProgramEntry",
    "description": "The description of this ProgramEntry",
    "genusTypeId": "type.Type:defaultProgramEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleProgramEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:3256@base.url",
    "studentId": "resource.Resource:4797@base.url",
    "programId": "course.program.Program:9129@base.url",
    "admissionDate": "2021-07-21T23:15:30.000Z",
    "complete": true,
    "termId": "course.Term:3276@base.url",
    "creditScaleId": "grading.GradeSystem:689@base.url",
    "creditsEarned": 3.14,
    "gpaScaleId": "grading.GradeSystem:9795@base.url",
    "gpa": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given program-entry to this courseCatalog

delete

Remove the given program-entry from the courseCatalog.

Add the given program-entry to this courseCatalog

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "program-entry has been added to courseCatalog" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Remove the given program-entry from the courseCatalog.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

get

Get all course-entries in this courseCatalog

Get all course-entries in this courseCatalog

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.CourseEntry:9798@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/courseEntry/chronicle.CourseEntry%3A9798%40base.url",
    "displayName": "Display Name of this CourseEntry",
    "description": "The description of this CourseEntry",
    "genusTypeId": "type.Type:defaultCourseEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleCourseEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:9798@base.url",
    "studentId": "resource.Resource:5628@base.url",
    "courseId": "course.Course:9069@base.url",
    "termId": "course.Term:5322@base.url",
    "complete": true,
    "creditScaleId": "grading.GradeSystem:1678@base.url",
    "creditsEarned": 3.14,
    "gradeId": "grading.Grade:1484@base.url",
    "scoreScaleId": "grading.GradeSystem:6873@base.url",
    "score": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given course-entry to this courseCatalog

delete

Remove the given course-entry from the courseCatalog.

Add the given course-entry to this courseCatalog

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "course-entry has been added to courseCatalog" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Remove the given course-entry from the courseCatalog.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

get

Get all credential-entries in this courseCatalog

Get all credential-entries in this courseCatalog

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.CredentialEntry:2838@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/credentialEntry/chronicle.CredentialEntry%3A2838%40base.url",
    "displayName": "Display Name of this CredentialEntry",
    "description": "The description of this CredentialEntry",
    "genusTypeId": "type.Type:defaultCredentialEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleCredentialEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:2838@base.url",
    "studentId": "resource.Resource:5981@base.url",
    "credentialId": "course.program.Credential:8655@base.url",
    "dateAwarded": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:8913@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given credential-entry to this courseCatalog

delete

Remove the given credential-entry from the courseCatalog.

Add the given credential-entry to this courseCatalog

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "credential-entry has been added to courseCatalog" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Remove the given credential-entry from the courseCatalog.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

get

Get all assessment-entries in this courseCatalog

Get all assessment-entries in this courseCatalog

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.AssessmentEntry:7704@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/assessmentEntry/chronicle.AssessmentEntry%3A7704%40base.url",
    "displayName": "Display Name of this AssessmentEntry",
    "description": "The description of this AssessmentEntry",
    "genusTypeId": "type.Type:defaultAssessmentEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleAssessmentEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:7704@base.url",
    "studentId": "resource.Resource:7963@base.url",
    "assessmentId": "assessment.Assessment:5846@base.url",
    "dateCompleted": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:5143@base.url",
    "courseId": "course.Course:4871@base.url",
    "gradeId": "grading.Grade:4038@base.url",
    "scoreScaleId": "grading.GradeSystem:8827@base.url",
    "score": 3.14
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given assessment-entry to this courseCatalog

delete

Remove the given assessment-entry from the courseCatalog.

Add the given assessment-entry to this courseCatalog

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "assessment-entry has been added to courseCatalog" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Remove the given assessment-entry from the courseCatalog.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

get

get

Get all award-entries in this courseCatalog

Get all award-entries in this courseCatalog

URI Parameters

  • courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "chronicle.AwardEntry:3078@base.url",
    "uri": "http://base.url/open/campusapi/chronicle/awardEntry/chronicle.AwardEntry%3A3078%40base.url",
    "displayName": "Display Name of this AwardEntry",
    "description": "The description of this AwardEntry",
    "genusTypeId": "type.Type:defaultAwardEntryType@base.url",
    "recordTypeIds": [ "type.Type:exampleAwardEntryRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:3078@base.url",
    "studentId": "resource.Resource:5500@base.url",
    "awardId": "recognition.Award:9766@base.url",
    "dateAwarded": "2021-07-21T23:15:30.000Z",
    "programId": "course.program.Program:3020@base.url",
    "courseId": "course.Course:5064@base.url",
    "assessmentId": "assessment.Assessment:5863@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given award-entry to this courseCatalog

delete

Remove the given award-entry from the courseCatalog.

Add the given award-entry to this courseCatalog

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "award-entry has been added to courseCatalog" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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

Remove the given award-entry from the courseCatalog.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

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