CampusAPI Course Services API documentation version 1.1.0
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseType%40campusapi.org

• number: (string)

  query string to match number.

  Example:

  T101

• sponsorId: (string)

  Id string to match sponsor.

  Example:

  resource.Resource%3A23423%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this course

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Course",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course. 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. 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 course 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 course is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course is operational. This course is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "title": {
      "description": "The formal title of this course.",
      "type": "string"
    },
    "number": {
      "description": "The course number which is a label generally used to index the course in a catalog, such as T101 or 16.",
      "type": "string"
    },
    "sponsorIds": {
      "description": "The sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "creditIds": {
      "description": "The credits in which this course can be offered.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "prerequisitesInfo": {
      "description": "An informational string for the course prerequisites.",
      "type": "string"
    },
    "prerequisiteIds": {
      "description": "The requisites for the course prerequisites.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "levelIds": {
      "description": "The grade levels of this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "gradingOptionIds": {
      "description": "The various grading options available to register in this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "learningObjectiveIds": {
      "description": "The overall learning objectives for this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Course",
  "description": "The description of this Course",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "title": "This is the Title",
  "number": "101",
  "sponsorIds": [ "resource.Resource:8941@base.url", "..." ],
  "creditIds": [ "grading.Grade:4354@base.url", "..." ],
  "prerequisitesInfo": "This is the PrerequisitesInfo",
  "prerequisiteIds": [ "course.requisite.Requisite:1753@base.url", "..." ],
  "levelIds": [ "grading.Grade:3348@base.url", "..." ],
  "gradingOptionIds": [ "grading.GradeSystem:4288@base.url", "..." ],
  "learningObjectiveIds": [ "learning.Objective:1095@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchTitle": {
      "description": "List of Title strings to match. Boolean OR performed among multiple titles.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "titles": {
            "description": "titles to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTitle": {
      "description": "Match titles with any value. true to match Courses with any title, false to match ProgramOfferings with no title",
      "type": "boolean"
    },
    "matchNumber": {
      "description": "List of Number strings to match. Boolean OR performed among multiple numbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "numbers": {
            "description": "numbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyNumber": {
      "description": "Match numbers with any value. true to match Courses with any number, false to match ProgramOfferings with no number",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsors. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsors with any value. true to match Courses with any sponsors, false to match Courses with no sponsors",
      "type": "boolean"
    },
    "matchCreditIds": {
      "description": "List of Grade Ids for this query to match credits.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "creditQueries": {
      "description": "grading.GradeQueries to match the Credits. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyCredit": {
      "description": "Match credits with any value. true to match Courses with any credits, false to match Courses with no credits",
      "type": "boolean"
    },
    "matchPrerequisitesInfo": {
      "description": "List of PrerequisitesInfo strings to match. Boolean OR performed among multiple prerequisitesInfos.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "prerequisitesInfos": {
            "description": "prerequisitesInfos to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPrerequisitesInfo": {
      "description": "Match prerequisitesInfos with any value. true to match Courses with any prerequisites info, false to match ProgramOfferings with no prerequisites info",
      "type": "boolean"
    },
    "matchPrerequisiteIds": {
      "description": "List of Requisite Ids for this query to match prerequisites.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "prerequisiteId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "prerequisiteQueries": {
      "description": "requisite.RequisiteQueries to match the Prerequisites. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "requisite-query"
      }
    },
    "matchAnyPrerequisite": {
      "description": "Match prerequisites with any value. true to match Courses with any prerequisites, false to match Courses with no prerequisites",
      "type": "boolean"
    },
    "matchLevelIds": {
      "description": "List of Grade Ids for this query to match levels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "levelQueries": {
      "description": "grading.GradeQueries to match the Levels. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyLevel": {
      "description": "Match levels with any value. true to match Courses with any levels, false to match Courses with no levels",
      "type": "boolean"
    },
    "matchGradingOptionIds": {
      "description": "List of GradeSystem Ids for this query to match gradingOptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradingOptionId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradingOptionQueries": {
      "description": "grading.GradeSystemQueries to match the Grading Options. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyGradingOption": {
      "description": "Match grading options with any value. true to match Courses with any grading options, false to match Courses with no grading options",
      "type": "boolean"
    },
    "matchLearningObjectiveIds": {
      "description": "List of Objective Ids for this query to match learningObjective.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "learningObjectiveId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "learningObjectiveQueries": {
      "description": "learning.ObjectiveQueries to match the Learning Objective. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "objective-query"
      }
    },
    "matchAnyLearningObjective": {
      "description": "Match learning objective with any value. true to match Courses with any learning objective, false to match Courses with no learning objective",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this course

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "CourseBatch",
    "type": "array",
    "Items": {
        "type": "course"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Course",
    "description": "The description of this Course",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "title": "This is the Title",
    "number": "101",
    "sponsorIds": [ "resource.Resource:8719@base.url", "..." ],
    "creditIds": [ "grading.Grade:8316@base.url", "..." ],
    "prerequisitesInfo": "This is the PrerequisitesInfo",
    "prerequisiteIds": [ "course.requisite.Requisite:2750@base.url", "..." ],
    "levelIds": [ "grading.Grade:477@base.url", "..." ],
    "gradingOptionIds": [ "grading.GradeSystem:2431@base.url", "..." ],
    "learningObjectiveIds": [ "learning.Objective:4099@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular course type to create

  Example:

  type.Type%3AexampleCourseType%40dxtera.org

• recordType: (array of )

  specify support for one or more course record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this course

  Example:

  course.CourseCatalog%3A8374%40base.url

URI Parameters

• courseId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• courseId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course. 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. 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 course 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 course is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course is operational. This course is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "title": {
      "description": "The formal title of this course.",
      "type": "string"
    },
    "number": {
      "description": "The course number which is a label generally used to index the course in a catalog, such as T101 or 16.",
      "type": "string"
    },
    "sponsorIds": {
      "description": "The sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "creditIds": {
      "description": "The credits in which this course can be offered.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "prerequisitesInfo": {
      "description": "An informational string for the course prerequisites.",
      "type": "string"
    },
    "prerequisiteIds": {
      "description": "The requisites for the course prerequisites.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "levelIds": {
      "description": "The grade levels of this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "gradingOptionIds": {
      "description": "The various grading options available to register in this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "learningObjectiveIds": {
      "description": "The overall learning objectives for this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Course",
  "description": "The description of this Course",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "title": "This is the Title",
  "number": "101",
  "sponsorIds": [ "resource.Resource:358@base.url", "..." ],
  "creditIds": [ "grading.Grade:9673@base.url", "..." ],
  "prerequisitesInfo": "This is the PrerequisitesInfo",
  "prerequisiteIds": [ "course.requisite.Requisite:6032@base.url", "..." ],
  "levelIds": [ "grading.Grade:7974@base.url", "..." ],
  "gradingOptionIds": [ "grading.GradeSystem:4649@base.url", "..." ],
  "learningObjectiveIds": [ "learning.Objective:3604@base.url", "..." ]
}

URI Parameters

• courseId: required(string)

URI Parameters

• courseId: required(string)

URI Parameters

• courseId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleActivityUnitType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleActivityUnitType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleActivityUnitType%40campusapi.org

• courseId: (string)

  the id string to match a course.

  Example:

  course.Course%3A432%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this activityUnit

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityUnit",
  "type": "object",
  "required": ["courseId"],
  "properties": {
    "id": {
      "description": "The unique id of this activity unit. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity unit. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity unit for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity unit.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity unit. 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 activity unit. 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 activity unit 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 activity unit is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this activity unit is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this activity unit is operational. This activity unit is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "courseId": {
      "description": "The course associated with this activity unit.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "totalTargetEffort": {
      "description": "The total time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "contact": {
      "description": "Tests if this is a contact activity.",
      "type": "boolean"
    },
    "totalTargetContactTime": {
      "description": "The total contact time for this activity.",
      "type": "string",
      "format": "duration"
    },
    "totalTargetIndividualEffort": {
      "description": "The total indivudal time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "recurringWeekly": {
      "description": "Tests if this activity is recurring.",
      "type": "boolean"
    },
    "weeklyEffort": {
      "description": "The time required for this recurring effort on a weekly basis.",
      "type": "string",
      "format": "duration"
    },
    "weeklyContactTime": {
      "description": "The weekly contact time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "weeklyIndividualEffort": {
      "description": "The weekly individual time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "learningObjectiveIds": {
      "description": "The overall learning objectives for this activity unit.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this ActivityUnit",
  "description": "The description of this ActivityUnit",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "courseId": "course.Course:8357@base.url",
  "totalTargetEffort": "P3DT3H",
  "contact": true,
  "totalTargetContactTime": "P3DT3H",
  "totalTargetIndividualEffort": "P3DT3H",
  "recurringWeekly": true,
  "weeklyEffort": "PT4H",
  "weeklyContactTime": "PT4H",
  "weeklyIndividualEffort": "PT4H",
  "learningObjectiveIds": [ "learning.Objective:6615@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityUnitQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match activity unit that have a related course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "CourseQueries to match the course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-query"
      }
    },
    "matchTotalTargetEffort": {
      "description": "Matches totalTargetEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTotalTargetEffort": {
      "description": "Match totalTargetEfforts with any value. true to match ActivityUnits with any total target effort, false to match ProgramOfferings with no total target effort",
      "type": "boolean"
    },
    "matchContact": {
      "description": "Match boolean value for contact.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchTotalTargetContactTime": {
      "description": "Matches totalTargetContactTimes in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTotalTargetContactTime": {
      "description": "Match totalTargetContactTimes with any value. true to match ActivityUnits with any total target contact time, false to match ProgramOfferings with no total target contact time",
      "type": "boolean"
    },
    "matchTotalTargetIndividualEffort": {
      "description": "Matches totalTargetIndividualEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTotalTargetIndividualEffort": {
      "description": "Match totalTargetIndividualEfforts with any value. true to match ActivityUnits with any total target individual effort, false to match ProgramOfferings with no total target individual effort",
      "type": "boolean"
    },
    "matchRecurringWeekly": {
      "description": "Match boolean value for recurringWeekly.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchWeeklyEffort": {
      "description": "Matches weeklyEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyEffort": {
      "description": "Match weeklyEfforts with any value. true to match ActivityUnits with any weekly effort, false to match ProgramOfferings with no weekly effort",
      "type": "boolean"
    },
    "matchWeeklyContactTime": {
      "description": "Matches weeklyContactTimes in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyContactTime": {
      "description": "Match weeklyContactTimes with any value. true to match ActivityUnits with any weekly contact time, false to match ProgramOfferings with no weekly contact time",
      "type": "boolean"
    },
    "matchWeeklyIndividualEffort": {
      "description": "Matches weeklyIndividualEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyIndividualEffort": {
      "description": "Match weeklyIndividualEfforts with any value. true to match ActivityUnits with any weekly individual effort, false to match ProgramOfferings with no weekly individual effort",
      "type": "boolean"
    },
    "matchLearningObjectiveIds": {
      "description": "List of Objective Ids for this query to match learningObjective.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "learningObjectiveId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "learningObjectiveQueries": {
      "description": "learning.ObjectiveQueries to match the Learning Objective. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "objective-query"
      }
    },
    "matchAnyLearningObjective": {
      "description": "Match learning objective with any value. true to match ActivityUnits with any learning objective, false to match ActivityUnits with no learning objective",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this activityUnit

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "ActivityUnitBatch",
    "type": "array",
    "Items": {
        "type": "activity-unit"
    }
}

Example:

[
  {
    "displayName": "Display Name of this ActivityUnit",
    "description": "The description of this ActivityUnit",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "totalTargetEffort": "P3DT3H",
    "contact": true,
    "totalTargetContactTime": "P3DT3H",
    "totalTargetIndividualEffort": "P3DT3H",
    "recurringWeekly": true,
    "weeklyEffort": "PT4H",
    "weeklyContactTime": "PT4H",
    "weeklyIndividualEffort": "PT4H",
    "learningObjectiveIds": [ "learning.Objective:136@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A432%40base.url

• genusType: (string)

  specify a particular activityUnit type to create

  Example:

  type.Type%3AexampleActivityUnitType%40dxtera.org

• recordType: (array of )

  specify support for one or more activityUnit record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this activityUnit

  Example:

  course.CourseCatalog%3A8374%40base.url

URI Parameters

• activityUnitId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• activityUnitId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityUnitItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this activity unit. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity unit. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity unit for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity unit.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity unit. 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 activity unit. 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 activity unit 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 activity unit is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this activity unit is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this activity unit is operational. This activity unit is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "courseId": {
      "description": "The course associated with this activity unit.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "totalTargetEffort": {
      "description": "The total time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "contact": {
      "description": "Tests if this is a contact activity.",
      "type": "boolean"
    },
    "totalTargetContactTime": {
      "description": "The total contact time for this activity.",
      "type": "string",
      "format": "duration"
    },
    "totalTargetIndividualEffort": {
      "description": "The total indivudal time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "recurringWeekly": {
      "description": "Tests if this activity is recurring.",
      "type": "boolean"
    },
    "weeklyEffort": {
      "description": "The time required for this recurring effort on a weekly basis.",
      "type": "string",
      "format": "duration"
    },
    "weeklyContactTime": {
      "description": "The weekly contact time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "weeklyIndividualEffort": {
      "description": "The weekly individual time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "learningObjectiveIds": {
      "description": "The overall learning objectives for this activity unit.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this ActivityUnit",
  "description": "The description of this ActivityUnit",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "totalTargetEffort": "P3DT3H",
  "contact": true,
  "totalTargetContactTime": "P3DT3H",
  "totalTargetIndividualEffort": "P3DT3H",
  "recurringWeekly": true,
  "weeklyEffort": "PT4H",
  "weeklyContactTime": "PT4H",
  "weeklyIndividualEffort": "PT4H",
  "learningObjectiveIds": [ "learning.Objective:5765@base.url", "..." ]
}

URI Parameters

• activityUnitId: required(string)

URI Parameters

• activityUnitId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "instructors", "sponsors", "credits", "gradingOptions", "event", "course", "term", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseOfferingType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseOfferingType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseOfferingType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• courseId: (string)

  the id string to match a course.

  Example:

  course.Course%3A504%40base.url

• termId: (string)

  the id string to match a term.

  Example:

  course.Term%3A336%40base.url

• number: (string)

  query string to match number.

  Example:

  T101

• sponsorId: (string)

  Id string to match sponsor.

  Example:

  resource.Resource%3A23423%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this courseOffering

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseOffering",
  "type": "object",
  "required": ["courseId", "termId"],
  "properties": {
    "id": {
      "description": "The unique id of this course offering. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course offering. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course offering for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course offering.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course offering. 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 offering. 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 offering.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course offering.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this course offering ended.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The course associated with this course offering.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The term associated with this course offering.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "title": {
      "description": "The formal title of this course.",
      "type": "string"
    },
    "number": {
      "description": "The course number which is a label generally used to index the course offering in a catalog, such as T101 or 16.",
      "type": "string"
    },
    "instructorIds": {
      "description": "The instructors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "sponsorIds": {
      "description": "The sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "creditIds": {
      "description": "The credits in which this course can be registered.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "gradingOptionIds": {
      "description": "The various grading options available to register in this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "requiresRegistration": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "minimumSeats": {
      "description": "The minimum number of students this offering can have.",
      "type": "integer",
      "minimum": 1
    },
    "maximumSeats": {
      "description": "The maximum number of students this offering can have.",
      "type": "integer",
      "minimum": 1
    },
    "url": {
      "description": "An external resource, such as a class web site, associated with this offering.",
      "type": "string"
    },
    "scheduleInfo": {
      "description": "An informational string for the course offering schedule.",
      "type": "string"
    },
    "eventId": {
      "description": "The calendaring event with the schedule details.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseOffering",
  "description": "The description of this CourseOffering",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:6036@base.url",
  "courseId": "course.Course:1476@base.url",
  "termId": "course.Term:79@base.url",
  "title": "This is the Title",
  "number": "101",
  "instructorIds": [ "resource.Resource:6896@base.url", "..." ],
  "sponsorIds": [ "resource.Resource:6589@base.url", "..." ],
  "creditIds": [ "grading.Grade:4613@base.url", "..." ],
  "gradingOptionIds": [ "grading.GradeSystem:301@base.url", "..." ],
  "requiresRegistration": true,
  "minimumSeats": 1,
  "maximumSeats": 42,
  "url": "http://dxtera.org",
  "scheduleInfo": "This is the ScheduleInfo",
  "eventId": "calendaring.Event:1483@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "instructors", "sponsors", "credits", "gradingOptions", "event", "course", "term", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseOfferingQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match CourseOfferings with any end reason, false to match CourseOfferings with no end reason",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match course offering that have a related course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "CourseQueries to match the course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-query"
      }
    },
    "matchTermIds": {
      "description": "List of term Ids for this query to match course offering that have a related term.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "termQueries": {
      "description": "TermQueries to match the term. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "term-query"
      }
    },
    "matchTitle": {
      "description": "List of Title strings to match. Boolean OR performed among multiple titles.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "titles": {
            "description": "titles to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTitle": {
      "description": "Match titles with any value. true to match CourseOfferings with any title, false to match ProgramOfferings with no title",
      "type": "boolean"
    },
    "matchNumber": {
      "description": "List of Number strings to match. Boolean OR performed among multiple numbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "numbers": {
            "description": "numbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyNumber": {
      "description": "Match numbers with any value. true to match CourseOfferings with any number, false to match ProgramOfferings with no number",
      "type": "boolean"
    },
    "matchInstructorIds": {
      "description": "List of Resource Ids for this query to match instructors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instructorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "instructorQueries": {
      "description": "resource.ResourceQueries to match the Instructors. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyInstructor": {
      "description": "Match instructors with any value. true to match CourseOfferings with any instructors, false to match CourseOfferings with no instructors",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsors. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsors with any value. true to match CourseOfferings with any sponsors, false to match CourseOfferings with no sponsors",
      "type": "boolean"
    },
    "matchCreditIds": {
      "description": "List of Grade Ids for this query to match credits.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "creditQueries": {
      "description": "grading.GradeQueries to match the Credits. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyCredit": {
      "description": "Match credits with any value. true to match CourseOfferings with any credits, false to match CourseOfferings with no credits",
      "type": "boolean"
    },
    "matchGradingOptionIds": {
      "description": "List of GradeSystem Ids for this query to match gradingOptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradingOptionId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradingOptionQueries": {
      "description": "grading.GradeSystemQueries to match the Grading Options. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyGradingOption": {
      "description": "Match grading options with any value. true to match CourseOfferings with any grading options, false to match CourseOfferings with no grading options",
      "type": "boolean"
    },
    "matchRequiresRegistration": {
      "description": "Match boolean value for requiresRegistration.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchMinimumSeats": {
      "description": "Match CourseOfferings with minimumSeats between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumSeats": {
      "description": "Match minimumSeats with any value. true to match CourseOfferings with any minimum seats, false to match ProgramOfferings with no minimum seats",
      "type": "boolean"
    },
    "matchMaximumSeats": {
      "description": "Match CourseOfferings with maximumSeats between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMaximumSeats": {
      "description": "Match maximumSeats with any value. true to match CourseOfferings with any maximum seats, false to match ProgramOfferings with no maximum seats",
      "type": "boolean"
    },
    "matchURL": {
      "description": "List of URL strings to match. Boolean OR performed among multiple urls.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "urls": {
            "description": "urls to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyURL": {
      "description": "Match urls with any value. true to match CourseOfferings with any url, false to match ProgramOfferings with no url",
      "type": "boolean"
    },
    "matchScheduleInfo": {
      "description": "List of ScheduleInfo strings to match. Boolean OR performed among multiple scheduleInfos.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scheduleInfos": {
            "description": "scheduleInfos to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyScheduleInfo": {
      "description": "Match scheduleInfos with any value. true to match CourseOfferings with any schedule info, false to match ProgramOfferings with no schedule info",
      "type": "boolean"
    },
    "matchEventIds": {
      "description": "List of Event Ids for this query to match event.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "eventQueries": {
      "description": "calendaring.EventQueries to match the Event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchAnyEvent": {
      "description": "Match event with any value. true to match CourseOfferings with any event, false to match CourseOfferings with no event",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this courseOffering

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "CourseOfferingBatch",
    "type": "array",
    "Items": {
        "type": "course-offering"
    }
}

Example:

[
  {
    "displayName": "Display Name of this CourseOffering",
    "description": "The description of this CourseOffering",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:9521@base.url",
    "title": "This is the Title",
    "number": "101",
    "instructorIds": [ "resource.Resource:5043@base.url", "..." ],
    "sponsorIds": [ "resource.Resource:7415@base.url", "..." ],
    "creditIds": [ "grading.Grade:4947@base.url", "..." ],
    "gradingOptionIds": [ "grading.GradeSystem:2146@base.url", "..." ],
    "requiresRegistration": true,
    "minimumSeats": 1,
    "maximumSeats": 42,
    "url": "http://dxtera.org",
    "scheduleInfo": "This is the ScheduleInfo",
    "eventId": "calendaring.Event:8296@base.url"
  },
  {
    "...": "..."
  }
]

Query Parameters

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A504%40base.url

• termId: required(string)

  the term of this metadatum.

  Example:

  course.Term%3A336%40base.url

• genusType: (string)

  specify a particular courseOffering type to create

  Example:

  type.Type%3AexampleCourseOfferingType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseOffering record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this courseOffering

  Example:

  course.CourseCatalog%3A8374%40base.url

URI Parameters

• courseOfferingId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "instructors", "sponsors", "credits", "gradingOptions", "event", "course", "term", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• courseOfferingId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseOfferingItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course offering. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course offering. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course offering for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course offering.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course offering. 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 offering. 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 offering.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course offering.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this course offering ended.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The course associated with this course offering.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The term associated with this course offering.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "title": {
      "description": "The formal title of this course.",
      "type": "string"
    },
    "number": {
      "description": "The course number which is a label generally used to index the course offering in a catalog, such as T101 or 16.",
      "type": "string"
    },
    "instructorIds": {
      "description": "The instructors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "sponsorIds": {
      "description": "The sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "creditIds": {
      "description": "The credits in which this course can be registered.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "gradingOptionIds": {
      "description": "The various grading options available to register in this course.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "requiresRegistration": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "minimumSeats": {
      "description": "The minimum number of students this offering can have.",
      "type": "integer",
      "minimum": 1
    },
    "maximumSeats": {
      "description": "The maximum number of students this offering can have.",
      "type": "integer",
      "minimum": 1
    },
    "url": {
      "description": "An external resource, such as a class web site, associated with this offering.",
      "type": "string"
    },
    "scheduleInfo": {
      "description": "An informational string for the course offering schedule.",
      "type": "string"
    },
    "eventId": {
      "description": "The calendaring event with the schedule details.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseOffering",
  "description": "The description of this CourseOffering",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7474@base.url",
  "title": "This is the Title",
  "number": "101",
  "instructorIds": [ "resource.Resource:1909@base.url", "..." ],
  "sponsorIds": [ "resource.Resource:7926@base.url", "..." ],
  "creditIds": [ "grading.Grade:5809@base.url", "..." ],
  "gradingOptionIds": [ "grading.GradeSystem:2371@base.url", "..." ],
  "requiresRegistration": true,
  "minimumSeats": 1,
  "maximumSeats": 42,
  "url": "http://dxtera.org",
  "scheduleInfo": "This is the ScheduleInfo",
  "eventId": "calendaring.Event:6803@base.url"
}

URI Parameters

• courseOfferingId: required(string)

URI Parameters

• courseOfferingId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleActivityType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleActivityType%40campusapi.org

• fromDate: (string)

  Get all activities from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all activities up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• activityUnitId: (string)

  the id string to match a activity-unit.

  Example:

  course.ActivityUnit%3A624%40base.url

• courseOfferingId: (string)

  the id string to match a course-offering.

  Example:

  course.CourseOffering%3A720%40base.url

• termId: (string)

  the id string to match a term.

  Example:

  course.Term%3A192%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this activity

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Activity",
  "type": "object",
  "required": ["activityUnitId", "courseOfferingId", "termId"],
  "properties": {
    "id": {
      "description": "The unique id of this activity. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity. 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 activity. 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 activity.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this activity ended.",
      "type": "string",
      "format": "osid-id"
    },
    "activityUnitId": {
      "description": "The activity unit associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseOfferingId": {
      "description": "The course offering associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The term associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "instructorIds": {
      "description": "The instructors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "minimumSeats": {
      "description": "The minimum number of students this activity can have.",
      "type": "integer",
      "minimum": 1
    },
    "maximumSeats": {
      "description": "The maximum number of students this activity can accommodate.",
      "type": "integer",
      "minimum": 1
    },
    "contact": {
      "description": "Tests if this is a contact activity.",
      "type": "boolean"
    },
    "totalTargetContactTime": {
      "description": "The total contact time for this activity.",
      "type": "string",
      "format": "duration"
    },
    "totalTargetIndividualEffort": {
      "description": "The total individual time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "recurringWeekly": {
      "description": "Tests if this activity is recurring.",
      "type": "boolean"
    },
    "weeklyEffort": {
      "description": "The time required for this recurring effort on a weekly basis.",
      "type": "string",
      "format": "duration"
    },
    "weeklyContactTime": {
      "description": "The weekly contact time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "weeklyIndividualEffort": {
      "description": "The weekly individual time for ths activity.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Activity",
  "description": "The description of this Activity",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:2552@base.url",
  "activityUnitId": "course.ActivityUnit:1622@base.url",
  "courseOfferingId": "course.CourseOffering:6540@base.url",
  "termId": "course.Term:3071@base.url",
  "instructorIds": [ "resource.Resource:7861@base.url", "..." ],
  "minimumSeats": 1,
  "maximumSeats": 42,
  "totalTargetEffort": "P3DT3H",
  "contact": true,
  "totalTargetContactTime": "P3DT3H",
  "totalTargetIndividualEffort": "P3DT3H",
  "recurringWeekly": true,
  "weeklyEffort": "PT4H",
  "weeklyContactTime": "PT4H",
  "weeklyIndividualEffort": "PT4H"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Activities with any end reason, false to match Activities with no end reason",
      "type": "boolean"
    },
    "matchActivityUnitIds": {
      "description": "List of activityUnit Ids for this query to match activity that have a related activityUnit.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "activityUnitQueries": {
      "description": "ActivityUnitQueries to match the activityUnit. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "activity-unit-query"
      }
    },
    "matchCourseOfferingIds": {
      "description": "List of courseOffering Ids for this query to match activity that have a related courseOffering.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseOfferingQueries": {
      "description": "CourseOfferingQueries to match the courseOffering. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-offering-query"
      }
    },
    "matchTermIds": {
      "description": "List of term Ids for this query to match activity that have a related term.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "termQueries": {
      "description": "TermQueries to match the term. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "term-query"
      }
    },
    "matchInstructorIds": {
      "description": "List of Resource Ids for this query to match instructors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "instructorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "instructorQueries": {
      "description": "resource.ResourceQueries to match the Instructors. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyInstructor": {
      "description": "Match instructors with any value. true to match Activities with any instructors, false to match Activities with no instructors",
      "type": "boolean"
    },
    "matchMinimumSeats": {
      "description": "Match Activities with minimumSeats between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumSeats": {
      "description": "Match minimumSeats with any value. true to match Activities with any minimum seats, false to match ProgramOfferings with no minimum seats",
      "type": "boolean"
    },
    "matchMaximumSeats": {
      "description": "Match Activities with maximumSeats between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMaximumSeats": {
      "description": "Match maximumSeats with any value. true to match Activities with any maximum seats, false to match ProgramOfferings with no maximum seats",
      "type": "boolean"
    },
    "matchContact": {
      "description": "Match boolean value for contact.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchTotalTargetContactTime": {
      "description": "Matches totalTargetContactTimes in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTotalTargetContactTime": {
      "description": "Match totalTargetContactTimes with any value. true to match Activities with any total target contact time, false to match ProgramOfferings with no total target contact time",
      "type": "boolean"
    },
    "matchTotalTargetIndividualEffort": {
      "description": "Matches totalTargetIndividualEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTotalTargetIndividualEffort": {
      "description": "Match totalTargetIndividualEfforts with any value. true to match Activities with any total target individual effort, false to match ProgramOfferings with no total target individual effort",
      "type": "boolean"
    },
    "matchRecurringWeekly": {
      "description": "Match boolean value for recurringWeekly.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchWeeklyEffort": {
      "description": "Matches weeklyEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyEffort": {
      "description": "Match weeklyEfforts with any value. true to match Activities with any weekly effort, false to match ProgramOfferings with no weekly effort",
      "type": "boolean"
    },
    "matchWeeklyContactTime": {
      "description": "Matches weeklyContactTimes in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyContactTime": {
      "description": "Match weeklyContactTimes with any value. true to match Activities with any weekly contact time, false to match ProgramOfferings with no weekly contact time",
      "type": "boolean"
    },
    "matchWeeklyIndividualEffort": {
      "description": "Matches weeklyIndividualEfforts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyIndividualEffort": {
      "description": "Match weeklyIndividualEfforts with any value. true to match Activities with any weekly individual effort, false to match ProgramOfferings with no weekly individual effort",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this activity

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "ActivityBatch",
    "type": "array",
    "Items": {
        "type": "activity"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Activity",
    "description": "The description of this Activity",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:6966@base.url",
    "instructorIds": [ "resource.Resource:1498@base.url", "..." ],
    "minimumSeats": 1,
    "maximumSeats": 42,
    "totalTargetEffort": "P3DT3H",
    "contact": true,
    "totalTargetContactTime": "P3DT3H",
    "totalTargetIndividualEffort": "P3DT3H",
    "recurringWeekly": true,
    "weeklyEffort": "PT4H",
    "weeklyContactTime": "PT4H",
    "weeklyIndividualEffort": "PT4H"
  },
  {
    "...": "..."
  }
]

Query Parameters

• activityUnitId: required(string)

  the activity-unit of this metadatum.

  Example:

  course.ActivityUnit%3A624%40base.url

• courseOfferingId: required(string)

  the course-offering of this metadatum.

  Example:

  course.CourseOffering%3A720%40base.url

• termId: required(string)

  the term of this metadatum.

  Example:

  course.Term%3A192%40base.url

• genusType: (string)

  specify a particular activity type to create

  Example:

  type.Type%3AexampleActivityType%40dxtera.org

• recordType: (array of )

  specify support for one or more activity record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this activity

  Example:

  course.CourseCatalog%3A8374%40base.url

URI Parameters

• activityId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• activityId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ActivityItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this activity. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this activity. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this activity for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this activity.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this activity. 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 activity. 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 activity.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this activity.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this activity ended.",
      "type": "string",
      "format": "osid-id"
    },
    "activityUnitId": {
      "description": "The activity unit associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseOfferingId": {
      "description": "The course offering associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "termId": {
      "description": "The term associated with this activity.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "instructorIds": {
      "description": "The instructors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "minimumSeats": {
      "description": "The minimum number of students this activity can have.",
      "type": "integer",
      "minimum": 1
    },
    "maximumSeats": {
      "description": "The maximum number of students this activity can accommodate.",
      "type": "integer",
      "minimum": 1
    },
    "contact": {
      "description": "Tests if this is a contact activity.",
      "type": "boolean"
    },
    "totalTargetContactTime": {
      "description": "The total contact time for this activity.",
      "type": "string",
      "format": "duration"
    },
    "totalTargetIndividualEffort": {
      "description": "The total individual time required for this activity.",
      "type": "string",
      "format": "duration"
    },
    "recurringWeekly": {
      "description": "Tests if this activity is recurring.",
      "type": "boolean"
    },
    "weeklyEffort": {
      "description": "The time required for this recurring effort on a weekly basis.",
      "type": "string",
      "format": "duration"
    },
    "weeklyContactTime": {
      "description": "The weekly contact time for ths activity.",
      "type": "string",
      "format": "duration"
    },
    "weeklyIndividualEffort": {
      "description": "The weekly individual time for ths activity.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Activity",
  "description": "The description of this Activity",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:3577@base.url",
  "instructorIds": [ "resource.Resource:8758@base.url", "..." ],
  "minimumSeats": 1,
  "maximumSeats": 42,
  "totalTargetEffort": "P3DT3H",
  "contact": true,
  "totalTargetContactTime": "P3DT3H",
  "totalTargetIndividualEffort": "P3DT3H",
  "recurringWeekly": true,
  "weeklyEffort": "PT4H",
  "weeklyContactTime": "PT4H",
  "weeklyIndividualEffort": "PT4H"
}

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)

URI Parameters

• activityId: required(string)
• scheduleId: required(string)

URI Parameters

• activityId: required(string)
• scheduleId: required(string)

URI Parameters

• activityId: required(string)

Query Parameters

• time: required(string)

  A time.

• locationId: required(string)

  A location Id.

URI Parameters

• activityId: required(string)

Query Parameters

• from: required(string)

  Start date inclusive.

• to: required(string)

  End date inclusive.

URI Parameters

• activityId: required(string)

Query Parameters

• from: required(string)

  Start date inclusive.

• to: required(string)

  End date inclusive.

URI Parameters

• activityId: required(string)

Query Parameters

• from: required(string)

  Start date inclusive.

• to: required(string)

  End date inclusive.

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleTermType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleTermType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleTermType%40campusapi.org

• classesDate: (string)

  query string to match date-time within classes date range.

  Example:

  2020-10-03

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this term

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Term",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this term. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this term. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this term for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this term.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this term. 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 term. 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
    },
    "displayLabel": {
      "description": "A display label for this term which may be less formal than the display name.",
      "type": "string"
    },
    "openDate": {
      "description": "The open date when published offerings are finalized.",
      "type": "string",
      "format": "date-time"
    },
    "registrationStart": {
      "description": "The start of the registration period.",
      "type": "string",
      "format": "date-time"
    },
    "registrationEnd": {
      "description": "The end of the registration period.",
      "type": "string",
      "format": "date-time"
    },
    "classesStart": {
      "description": "The start of classes.",
      "type": "string",
      "format": "date-time"
    },
    "classesEnd": {
      "description": "The end of classes.",
      "type": "string",
      "format": "date-time"
    },
    "addDate": {
      "description": "The add/drop date.",
      "type": "string",
      "format": "date-time"
    },
    "dropDate": {
      "description": "The add/drop date.",
      "type": "string",
      "format": "date-time"
    },
    "finalExamStart": {
      "description": "The start of the final exam period.",
      "type": "string",
      "format": "date-time"
    },
    "finalExamEnd": {
      "description": "The end of the final exam period.",
      "type": "string",
      "format": "date-time"
    },
    "closeDate": {
      "description": "The close date when results of course offerings are finalized.",
      "type": "string",
      "format": "date-time"
    },
    "gradingStart": {
      "description": "The start of the grading period.",
      "type": "string",
      "format": "date-time"
    },
    "gradingEnd": {
      "description": "The end of the grading period.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Term",
  "description": "The description of this Term",
  "displayLabel": "This is the DisplayLabel",
  "openDate": "2020-10-03T08:00:00.000Z",
  "registrationStart": "2020-10-03T08:00:00.000Z",
  "registrationEnd": "2020-12-18T17:00:00.000Z",
  "classesStart": "2020-10-03T08:00:00.000Z",
  "classesEnd": "2020-12-18T17:00:00.000Z",
  "addDate": "2020-10-03T08:00:00.000Z",
  "dropDate": "2020-12-18T17:00:00.000Z",
  "finalExamStart": "2020-10-03T08:00:00.000Z",
  "finalExamEnd": "2020-12-18T17:00:00.000Z",
  "closeDate": "2020-12-18T17:00:00.000Z"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TermQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchDisplayLabel": {
      "description": "List of DisplayLabel strings to match. Boolean OR performed among multiple displayLabels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayLabels": {
            "description": "displayLabels to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDisplayLabel": {
      "description": "Match displayLabels with any value. true to match Terms with any display label, false to match ProgramOfferings with no display label",
      "type": "boolean"
    },
    "matchOpenDate": {
      "description": "Matches openDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyOpenDate": {
      "description": "Match openDates with any value. true to match Terms with any open date, false to match ProgramOfferings with no open date",
      "type": "boolean"
    },
    "matchRegistrationStart": {
      "description": "Matches registrationStarts between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRegistrationStart": {
      "description": "Match registrationStarts with any value. true to match Terms with any registration start, false to match ProgramOfferings with no registration start",
      "type": "boolean"
    },
    "matchRegistrationEnd": {
      "description": "Matches registrationEnds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRegistrationEnd": {
      "description": "Match registrationEnds with any value. true to match Terms with any registration end, false to match ProgramOfferings with no registration end",
      "type": "boolean"
    },
    "matchClassesStart": {
      "description": "Matches classesStarts between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyClassesStart": {
      "description": "Match classesStarts with any value. true to match Terms with any classes start, false to match ProgramOfferings with no classes start",
      "type": "boolean"
    },
    "matchClassesEnd": {
      "description": "Matches classesEnds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyClassesEnd": {
      "description": "Match classesEnds with any value. true to match Terms with any classes end, false to match ProgramOfferings with no classes end",
      "type": "boolean"
    },
    "matchAddDate": {
      "description": "Matches addDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyAddDate": {
      "description": "Match addDates with any value. true to match Terms with any add date, false to match ProgramOfferings with no add date",
      "type": "boolean"
    },
    "matchDropDate": {
      "description": "Matches dropDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDropDate": {
      "description": "Match dropDates with any value. true to match Terms with any drop date, false to match ProgramOfferings with no drop date",
      "type": "boolean"
    },
    "matchFinalExamStart": {
      "description": "Matches finalExamStarts between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFinalExamStart": {
      "description": "Match finalExamStarts with any value. true to match Terms with any final exam start, false to match ProgramOfferings with no final exam start",
      "type": "boolean"
    },
    "matchFinalExamEnd": {
      "description": "Matches finalExamEnds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFinalExamEnd": {
      "description": "Match finalExamEnds with any value. true to match Terms with any final exam end, false to match ProgramOfferings with no final exam end",
      "type": "boolean"
    },
    "matchCloseDate": {
      "description": "Matches closeDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCloseDate": {
      "description": "Match closeDates with any value. true to match Terms with any close date, false to match ProgramOfferings with no close date",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this term

  Example:

  course.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "TermBatch",
    "type": "array",
    "Items": {
        "type": "term"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Term",
    "description": "The description of this Term",
    "displayLabel": "This is the DisplayLabel",
    "openDate": "2020-10-03T08:00:00.000Z",
    "registrationStart": "2020-10-03T08:00:00.000Z",
    "registrationEnd": "2020-12-18T17:00:00.000Z",
    "classesStart": "2020-10-03T08:00:00.000Z",
    "classesEnd": "2020-12-18T17:00:00.000Z",
    "addDate": "2020-10-03T08:00:00.000Z",
    "dropDate": "2020-12-18T17:00:00.000Z",
    "finalExamStart": "2020-10-03T08:00:00.000Z",
    "finalExamEnd": "2020-12-18T17:00:00.000Z",
    "closeDate": "2020-12-18T17:00:00.000Z"
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular term type to create

  Example:

  type.Type%3AexampleTermType%40dxtera.org

• recordType: (array of )

  specify support for one or more term record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this term

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

URI Parameters

• termId: required(string)

URI Parameters

• termId: required(string)

URI Parameters

• termId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• termId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TermItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this term. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this term. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this term for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this term.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this term. 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 term. 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
    },
    "displayLabel": {
      "description": "A display label for this term which may be less formal than the display name.",
      "type": "string"
    },
    "openDate": {
      "description": "The open date when published offerings are finalized.",
      "type": "string",
      "format": "date-time"
    },
    "registrationStart": {
      "description": "The start of the registration period.",
      "type": "string",
      "format": "date-time"
    },
    "registrationEnd": {
      "description": "The end of the registration period.",
      "type": "string",
      "format": "date-time"
    },
    "classesStart": {
      "description": "The start of classes.",
      "type": "string",
      "format": "date-time"
    },
    "classesEnd": {
      "description": "The end of classes.",
      "type": "string",
      "format": "date-time"
    },
    "addDate": {
      "description": "The add/drop date.",
      "type": "string",
      "format": "date-time"
    },
    "dropDate": {
      "description": "The add/drop date.",
      "type": "string",
      "format": "date-time"
    },
    "finalExamStart": {
      "description": "The start of the final exam period.",
      "type": "string",
      "format": "date-time"
    },
    "finalExamEnd": {
      "description": "The end of the final exam period.",
      "type": "string",
      "format": "date-time"
    },
    "closeDate": {
      "description": "The close date when results of course offerings are finalized.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Term",
  "description": "The description of this Term",
  "displayLabel": "This is the DisplayLabel",
  "openDate": "2020-10-03T08:00:00.000Z",
  "registrationStart": "2020-10-03T08:00:00.000Z",
  "registrationEnd": "2020-12-18T17:00:00.000Z",
  "classesStart": "2020-10-03T08:00:00.000Z",
  "classesEnd": "2020-12-18T17:00:00.000Z",
  "addDate": "2020-10-03T08:00:00.000Z",
  "dropDate": "2020-12-18T17:00:00.000Z",
  "finalExamStart": "2020-10-03T08:00:00.000Z",
  "finalExamEnd": "2020-12-18T17:00:00.000Z",
  "closeDate": "2020-12-18T17:00:00.000Z"
}

URI Parameters

• termId: required(string)

URI Parameters

• termId: required(string)

URI Parameters

• termId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

URI Parameters

• termId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

URI Parameters

• termId: required(string)
• childId: required(string)

URI Parameters

• termId: required(string)
• childId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseCatalogType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseCatalogType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

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

• courseId: (string)

  Get course-catalogs mapped to this course.

  Example:

  course.Course%3A468%40demo.dxtera.org

• activityUnitId: (string)

  Get course-catalogs mapped to this activity-unit.

  Example:

  course.ActivityUnit%3A1014%40demo.dxtera.org

• courseOfferingId: (string)

  Get course-catalogs mapped to this course-offering.

  Example:

  course.CourseOffering%3A1170%40demo.dxtera.org

• activityId: (string)

  Get course-catalogs mapped to this activity.

  Example:

  course.Activity%3A624%40demo.dxtera.org

• termId: (string)

  Get course-catalogs mapped to this term.

  Example:

  course.Term%3A312%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular courseCatalog type to create

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseCatalog record types

  Example:

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

Body

Media type: application/json

Type: json

Content:

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

Example:

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

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseCatalogQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "providerQueries to match the provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match CourseCatalog with any provider, false to match CourseCatalog with no provider",
      "type": "boolean"
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQueries to match the branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "asset-query"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match CourseCatalog with any branding, false to match CourseCatalog with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "CourseCatalog",
  "type": "object",
  "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" }

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

URI Parameters

• childId: required(string)

URI Parameters

• childId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

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

Example:

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• courseId: required(string)

URI Parameters

• courseCatalogId: required(string)
• courseId: required(string)

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchTitle": {
      "description": "List of Title strings to match. Boolean OR performed among multiple titles.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "titles": {
            "description": "titles to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTitle": {
      "description": "Match titles with any value. true to match Courses with any title, false to match ProgramOfferings with no title",
      "type": "boolean"
    },
    "matchNumber": {
      "description": "List of Number strings to match. Boolean OR performed among multiple numbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "numbers": {
            "description": "numbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyNumber": {
      "description": "Match numbers with any value. true to match Courses with any number, false to match ProgramOfferings with no number",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsors. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsors with any value. true to match Courses with any sponsors, false to match Courses with no sponsors",
      "type": "boolean"
    },
    "matchCreditIds": {
      "description": "List of Grade Ids for this query to match credits.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "creditQueries": {
      "description": "grading.GradeQueries to match the Credits. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyCredit": {
      "description": "Match credits with any value. true to match Courses with any credits, false to match Courses with no credits",
      "type": "boolean"
    },
    "matchPrerequisitesInfo": {
      "description": "List of PrerequisitesInfo strings to match. Boolean OR performed among multiple prerequisitesInfos.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "prerequisitesInfos": {
            "description": "prerequisitesInfos to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPrerequisitesInfo": {
      "description": "Match prerequisitesInfos with any value. true to match Courses with any prerequisites info, false to match ProgramOfferings with no prerequisites info",
      "type": "boolean"
    },
    "matchPrerequisiteIds": {
      "description": "List of Requisite Ids for this query to match prerequisites.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "prerequisiteId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "prerequisiteQueries": {
      "description": "requisite.RequisiteQueries to match the Prerequisites. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "requisite-query"
      }
    },
    "matchAnyPrerequisite": {
      "description": "Match prerequisites with any value. true to match Courses with any prerequisites, false to match Courses with no prerequisites",
      "type": "boolean"
    },
    "matchLevelIds": {
      "description": "List of Grade Ids for this query to match levels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "levelQueries": {
      "description": "grading.GradeQueries to match the Levels. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyLevel": {
      "description": "Match levels with any value. true to match Courses with any levels, false to match Courses with no levels",
      "type": "boolean"
    },
    "matchGradingOptionIds": {
      "description": "List of GradeSystem Ids for this query to match gradingOptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gradingOptionId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "gradingOptionQueries": {
      "description": "grading.GradeSystemQueries to match the Grading Options. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyGradingOption": {
      "description": "Match grading options with any value. true to match Courses with any grading options, false to match Courses with no grading options",
      "type": "boolean"
    },
    "matchLearningObjectiveIds": {
      "description": "List of Objective Ids for this query to match learningObjective.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "learningObjectiveId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "learningObjectiveQueries": {
      "description": "learning.ObjectiveQueries to match the Learning Objective. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "objective-query"
      }
    },
    "matchAnyLearningObjective": {
      "description": "Match learning objective with any value. true to match Courses with any learning objective, false to match Courses with no learning objective",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

URI Parameters

• courseCatalogId: required(string)