CampusAPI Equivalency Services API documentation version 0.1.1

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", "courses", "assessments", "equivalentCourses", "minimumGrade", "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%3AexampleCourseEquivalencyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseEquivalencyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseEquivalencyType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

  Get all course-equivalencies 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

• assessmentId: (string)

  the id string to match a assessment.

  Example:

  assessment.Assessment%3A8733%40base.url

• equivalentCourseId: (string)

  the id string to match a equivalent-course.

  Example:

  course.Course%3A6723%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": "CourseEquivalency",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course equivalency, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course equivalency, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course equivalency for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course equivalency.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course equivalency. 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 equivalency. 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 equivalency 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 equivalency is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course equivalency is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course equivalency is operational. This course is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this course equivalency.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course equivalency.",
      "type": "string",
      "format": "date-time"
    },
    "courseIds": {
      "description": "One or more courses associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "assessmentIds": {
      "description": "One or more assessments associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "equivalentCourseIds": {
      "description": "One or more equivalent courses associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "minimumGradeId": {
      "description": "The minimum grade required for equivalency.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score required for equivalency.",
      "type": "number"
    },
    "coverage": {
      "description": "The coverage, or overlap, between the source Courses and EquivalentCourses as a percentage 0-100.",
      "type": "number"
    },
    "learningObjectiveIds": {
      "description": "The learning objectives mapped to this equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseEquivalency",
  "description": "The description of this CourseEquivalency",
  "genusTypeId": "type.Type:defaultCourseEquivalencyType@dxtera.org",
  "enabled": true,
  "disabled": false,
  "startDate": "2020-10-03T06:30:00.000Z",
  "courseIds": [ "course.Course:18732@base.url", "course.Course:78234@base.url"],
  "assessmentIds": [ "assessment.Assessment:56374@base.url", "assessment.Assessment:7362@base.url"],
  "equivalentCourseIds": [ "course.Course:87237@base.url", "course.Course:88723@base.url"],
  "endDate": "2020-12-18T19:30:00.000Z",
  "minimumGrade": "grading.Grade:3233@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:5612@base.url",
  "minimumScore": 3.14,
  "coverage": 100,
  "learningObjectiveIds": [ "learning.Objective:7365@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", "courses", "assessments", "equivalentCourses", "minimumGrade", "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": "CourseEquivalencyQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match course equivalencies 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"
      }
    },
    "matchAssessmentIds": {
      "description": "List of assessment Ids for this query to match course equivalencies that have a related assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "AssessementQueries to match the assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "assessment-query"
      }
    },
    "matchEquivalentCourseIds": {
      "description": "List of equivalent course Ids for this query to match course equivalencies that have a related equivalent 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"
          }
        }
      }
    },
    "equivalentCourseQueries": {
      "description": "EquivalentCourseQueries to match the equivalent course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-query"
      }
    },
    "matchMinimumGradeIds": {
      "description": "List of Grade Ids for this query to match minimumGrade.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumGradeId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchCoverage": {
      "description": "Match Coverage within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCoverage": {
      "description": "Match completions with any value. true to match Course Equivalencies with any completion, false to match ProgramOfferings with no completion",
      "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 courseEquivalency

  Example:

  equivalency.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this CourseEquivalency",
    "description": "The description of this CourseEquivalency",
    "genusTypeId": "type.Type:defaultCourseEquivalencyType@dxtera.org",
    "enabled": true,
    "disabled": false,
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "courseIds": [ "course.Course:18732@base.url", "course.Course:78234@base.url"],
    "assessmentIds": [ "assessment.Assessment:56374@base.url", "assessment.Assessment:7362@base.url"],
    "equivalentCourseIds": [ "course.Course:87237@base.url", "course.Course:88723@base.url"],
    "minimumGrade": "grading.Grade:3233@base.url",
    "minimumScoreSystemId": "grading.GradeSystem:5612@base.url",
    "minimumScore": 3.14,
    "coverage": 100,
    "learningObjectiveIds": [ "learning.Objective:7365@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A504%40base.url

• equivalentCourseId: required(string)

  the equivalent-course 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

• courseEquivalencyId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• courseEquivalencyId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseEquivalencyItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course equivalency, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course equivalency, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course equivalency for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course equivalency.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course equivalency. 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 equivalency. 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 equivalency 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 equivalency is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course equivalency is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course equivalency is operational. This course is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this course equivalency.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this course equivalency.",
      "type": "string",
      "format": "date-time"
    },
    "courseIds": {
      "description": "One or more courses associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "assessmentIds": {
      "description": "One or more assessments associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "equivalentCourseIds": {
      "description": "One or more equivalent courses associated with this course equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "minimumGradeId": {
      "description": "The minimum grade required for equivalency.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score required for equivalency.",
      "type": "number"
    },
    "coverage": {
      "description": "The coverage, or overlap, between the source Courses and EquivalentCourses as a percentage 0-100.",
      "type": "number"
    },
    "learningObjectiveIds": {
      "description": "The learning objectives mapped to this equivalency.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseEquivalency",
  "description": "The description of this CourseEquivalency",
  "genusTypeId": "type.Type:defaultCourseEquivalencyType@dxtera.org",
  "enabled": true,
  "disabled": false,
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "courseIds": [ "course.Course:18732@base.url", "course.Course:78234@base.url"],
  "assessmentIds": [ "assessment.Assessment:56374@base.url", "assessment.Assessment:7362@base.url"],
  "equivalentCourseIds": [ "course.Course:87237@base.url", "course.Course:88723@base.url"],
  "minimumGrade": "grading.Grade:3233@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:5612@base.url",
  "minimumScore": 3.14,
  "coverage": 100,
  "learningObjectiveIds": [ "learning.Objective:7365@base.url", "..." ]
}

URI Parameters

• courseEquivalencyId: required(string)

URI Parameters

• courseEquivalencyId: 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

• programId: (string)

  Get course-catalogs mapped to this program.

  Example:

  program.Program%3A637%40demo.dxtera.org

• programOfferingId: (string)

  Get course-catalogs mapped to this program-offering.

  Example:

  program.ProgramOffering%3A1456%40demo.dxtera.org

• credentialId: (string)

  Get course-catalogs mapped to this credential.

  Example:

  program.Credential%3A910%40demo.dxtera.org

• enrollmentId: (string)

  Get course-catalogs mapped to this enrollment.

  Example:

  program.Enrollment%3A910%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" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• 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", "completionRequirements", "credentials", 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%3AexampleProgramType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleProgramType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleProgramType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• courseEquivalencyId: required(string)

URI Parameters

• courseCatalogId: required(string)
• courseEquivalencyId: required(string)

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseEquivalencyQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match course equivalencies 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"
      }
    },
    "matchAssessmentIds": {
      "description": "List of assessment Ids for this query to match course equivalencies that have a related assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "AssessementQueries to match the assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "assessment-query"
      }
    },
    "matchEquivalentCourseIds": {
      "description": "List of equivalent course Ids for this query to match course equivalencies that have a related equivalent 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"
          }
        }
      }
    },
    "equivalentCourseQueries": {
      "description": "EquivalentCourseQueries to match the equivalent course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-query"
      }
    },
    "matchMinimumGradeIds": {
      "description": "List of Grade Ids for this query to match minimumGrade.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumGradeId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchCoverage": {
      "description": "Match Coverage within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCoverage": {
      "description": "Match completions with any value. true to match Course Equivalencies with any completion, false to match ProgramOfferings with no completion",
      "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)