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

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleSyllabusType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleSyllabusType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleSyllabusType%40campusapi.org

• courseId: (string)

  the id string to match a course.

  Example:

  course.Course%3A288%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseId: required(string)

  the course of this syllabus.

  Example:

  course.Course%3A288%40base.url

• genusType: (string)

  specify a particular syllabus type to create

  Example:

  type.Type%3AexampleSyllabusType%40dxtera.org

• recordType: (array of )

  specify support for one or more syllabus record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this syllabus

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Syllabus",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this syllabus, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this syllabus, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this syllabus for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this syllabus.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this syllabus. 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 syllabus. 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
    },
    "courseId": {
      "description": "The course associated with this syllabus.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Syllabus",
  "description": "The description of this Syllabus"
}

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", "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": "SyllabusQuery",
  "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"
          }
        }
      }
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match syllabus that have a related course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "CourseQueries to match the course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A288%40base.url

• genusType: (string)

  specify a particular syllabus type to create

  Example:

  type.Type%3AexampleSyllabusType%40dxtera.org

• recordType: (array of )

  specify support for one or more syllabus record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this syllabus

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

URI Parameters

• syllabusId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• syllabusId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Syllabus",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this syllabus, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this syllabus, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this syllabus for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this syllabus.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this syllabus. 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 syllabus. 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
    },
    "courseId": {
      "description": "The course associated with this syllabus.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Syllabus",
  "description": "The description of this Syllabus"
}

URI Parameters

• syllabusId: required(string)

URI Parameters

• syllabusId: 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", "syllabus", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleModuleType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleModuleType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleModuleType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

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

• syllabusId: (string)

  the id string to match a syllabus.

  Example:

  syllabus.Syllabus%3A384%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• syllabusId: required(string)

  the syllabus of this module.

  Example:

  syllabus.Syllabus%3A384%40base.url

• genusType: (string)

  specify a particular module type to create

  Example:

  type.Type%3AexampleModuleType%40dxtera.org

• recordType: (array of )

  specify support for one or more module record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this module

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Module",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this module, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this module, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this module for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this module.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this module. 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 module. 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 module.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this module. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this module.",
      "type": "string"
    },
    "active": {
      "description": "Whether this module 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 module is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this module is operational. This module is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "syllabusId": {
      "description": "The syllabus associated with this module.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Module",
  "description": "The description of this Module",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Module@base.url",
  "license": "The license that applies to this Module"
}

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", "syllabus", 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": "ModuleQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Module with any provider, false to match Module with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Module with any branding, false to match Module 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"
          }
        }
      }
    },
    "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"
    },
    "matchSyllabusIds": {
      "description": "List of syllabus Ids for this query to match module that have a related syllabus.",
      "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"
          }
        }
      }
    },
    "syllabusQueries": {
      "description": "SyllabusQueries to match the syllabus. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• syllabusId: required(string)

  the syllabus of this metadatum.

  Example:

  syllabus.Syllabus%3A384%40base.url

• genusType: (string)

  specify a particular module type to create

  Example:

  type.Type%3AexampleModuleType%40dxtera.org

• recordType: (array of )

  specify support for one or more module record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this module

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

URI Parameters

• moduleId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• moduleId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Module",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this module, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this module, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this module for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this module.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this module. 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 module. 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 module.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this module. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this module.",
      "type": "string"
    },
    "active": {
      "description": "Whether this module 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 module is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this module is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this module is operational. This module is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "syllabusId": {
      "description": "The syllabus associated with this module.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Module",
  "description": "The description of this Module",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Module@base.url",
  "license": "The license that applies to this Module"
}

URI Parameters

• moduleId: required(string)

URI Parameters

• moduleId: 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", "learningObjectives", "assets", "assessments", "module", "activityUnit", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleDocetType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleDocetType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleDocetType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• moduleId: (string)

  the id string to match a module.

  Example:

  syllabus.Module%3A240%40base.url

• activityUnitId: (string)

  the id string to match a activity-unit.

  Example:

  course.ActivityUnit%3A390%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• moduleId: required(string)

  the module of this docet.

  Example:

  syllabus.Module%3A240%40base.url

• activityUnitId: required(string)

  the activity-unit of this docet.

  Example:

  course.ActivityUnit%3A390%40base.url

• genusType: (string)

  specify a particular docet type to create

  Example:

  type.Type%3AexampleDocetType%40dxtera.org

• recordType: (array of )

  specify support for one or more docet record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this docet

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Docet",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this docet, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this docet, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this docet for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this docet.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this docet. 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 docet. 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 docet.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this docet.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this docet ended.",
      "type": "string",
      "format": "osid-id"
    },
    "moduleId": {
      "description": "The module associated with this docet.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "activityUnitId": {
      "description": "The activity unit associated with this docet.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "learningObjectiveIds": {
      "description": "The learning objectives.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "inClass": {
      "description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
      "type": "boolean"
    },
    "duration": {
      "description": "The estimated duration.",
      "type": "string",
      "format": "duration"
    },
    "assetIds": {
      "description": "The assets distributed to the students.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "assessmentIds": {
      "description": "The assessments.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Docet",
  "description": "The description of this Docet",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:5247@base.url",
  "learningObjectives": [ "learning.Objective:7371@base.url", "..." ],
  "inClass": true,
  "duration": "P3DT3H",
  "assets": [ "repository.Asset:6411@base.url", "..." ],
  "assessments": [ "assessment.Assessment:5133@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", "learningObjectives", "assets", "assessments", "module", "activityUnit", 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": "DocetQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Docets with any end reason, false to match Docets with no end reason",
      "type": "boolean"
    },
    "matchModuleIds": {
      "description": "List of module Ids for this query to match docet that have a related module.",
      "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"
          }
        }
      }
    },
    "moduleQueries": {
      "description": "ModuleQueries to match the module. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchActivityUnitIds": {
      "description": "List of activityUnit Ids for this query to match docet 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": "object"
      }
    },
    "matchLearningObjectiveIds": {
      "description": "List of Objective Ids for this query to match learningObjectives.",
      "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 Objectives. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyLearningObjective": {
      "description": "Match learning objectives with any value. true to match Docets with any learning objectives, false to match Docets with no learning objectives",
      "type": "boolean"
    },
    "matchInClass": {
      "description": "Match boolean value for inClass.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchDuration": {
      "description": "Matches durations 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"
          }
        }
      }
    },
    "matchAnyDuration": {
      "description": "Match durations with any value. true to match Docets with any duration, false to match ProgramOfferings with no duration",
      "type": "boolean"

    },
    "matchAssetIds": {
      "description": "List of Asset Ids for this query to match assets.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assetId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assetQueries": {
      "description": "repository.AssetQueries to match the Assets. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAsset": {
      "description": "Match assets with any value. true to match Docets with any assets, false to match Docets with no assets",
      "type": "boolean"
    },
    "matchAssessmentIds": {
      "description": "List of Assessment Ids for this query to match assessments.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assessmentId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "assessment.AssessmentQueries to match the Assessments. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAssessment": {
      "description": "Match assessments with any value. true to match Docets with any assessments, false to match Docets with no assessments",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• moduleId: required(string)

  the module of this metadatum.

  Example:

  syllabus.Module%3A240%40base.url

• activityUnitId: required(string)

  the activity-unit of this metadatum.

  Example:

  course.ActivityUnit%3A390%40base.url

• genusType: (string)

  specify a particular docet type to create

  Example:

  type.Type%3AexampleDocetType%40dxtera.org

• recordType: (array of )

  specify support for one or more docet record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this docet

  Example:

  syllabus.CourseCatalog%3A8374%40base.url

URI Parameters

• docetId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• docetId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Docet",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this docet, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this docet, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this docet for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this docet.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this docet. 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 docet. 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 docet.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this docet.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this docet ended.",
      "type": "string",
      "format": "osid-id"
    },
    "moduleId": {
      "description": "The module associated with this docet.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "activityUnitId": {
      "description": "The activity unit associated with this docet.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "learningObjectiveIds": {
      "description": "The learning objectives.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "inClass": {
      "description": "Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity.",
      "type": "boolean"
    },
    "duration": {
      "description": "The estimated duration.",
      "type": "string",
      "format": "duration"
    },
    "assetIds": {
      "description": "The assets distributed to the students.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "assessmentIds": {
      "description": "The assessments.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Docet",
  "description": "The description of this Docet",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:5247@base.url",
  "learningObjectives": [ "learning.Objective:7371@base.url", "..." ],
  "inClass": true,
  "duration": "P3DT3H",
  "assets": [ "repository.Asset:6411@base.url", "..." ],
  "assessments": [ "assessment.Assessment:5133@base.url", "..." ]
}

URI Parameters

• docetId: required(string)

URI Parameters

• docetId: required(string)

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseCatalogType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseCatalogType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

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

• syllabusId: (string)

  Get course-catalogs mapped to this syllabus.

  Example:

  syllabus.Syllabus%3A832%40demo.dxtera.org

• moduleId: (string)

  Get course-catalogs mapped to this module.

  Example:

  syllabus.Module%3A624%40demo.dxtera.org

• docetId: (string)

  Get course-catalogs mapped to this docet.

  Example:

  syllabus.Docet%3A520%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular courseCatalog type to create

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseCatalog record types

  Example:

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

Body

Media type: application/json

Type: json

Content:

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

Example:

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

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "CourseCatalog",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this course catalog, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course catalog, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course catalog for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this course catalog",
      "linked": false
    },
    "description": {
      "description": "The description of this course catalog.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this course catalog",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course catalog. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this course catalog. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this course catalog.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this course catalog",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this course catalog. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "CourseCatalog.CourseCatalog:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this course catalog",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this course catalog.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "CourseCatalog.CourseCatalog:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this course catalog",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

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

Example:

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

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

URI Parameters

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleSyllabusType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleSyllabusType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleSyllabusType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• syllabusId: required(string)

URI Parameters

• courseCatalogId: required(string)
• syllabusId: 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", "syllabus", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleModuleType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleModuleType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleModuleType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• moduleId: required(string)

URI Parameters

• courseCatalogId: required(string)
• moduleId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleDocetType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleDocetType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleDocetType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• docetId: required(string)

URI Parameters

• courseCatalogId: required(string)
• docetId: required(string)