CampusAPI Plan 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", "endReason", "modules", "syllabus", "courseOffering", 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%3AexamplePlanType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePlanType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePlanType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• syllabusId: (string)

  the id string to match a syllabus.

  Example:

  syllabus.Syllabus%3A256%40base.url

• courseOfferingId: (string)

  the id string to match a course-offering.

  Example:

  course.CourseOffering%3A360%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 plan.

  Example:

  syllabus.Syllabus%3A256%40base.url

• courseOfferingId: required(string)

  the course-offering of this plan.

  Example:

  course.CourseOffering%3A360%40base.url

• genusType: (string)

  specify a particular plan type to create

  Example:

  type.Type%3AexamplePlanType%40dxtera.org

• recordType: (array of )

  specify support for one or more plan record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this plan

  Example:

  plan.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Plan",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this plan, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this plan, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this plan for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this plan.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this plan. 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 plan. 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 plan.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this plan.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this plan ended.",
      "type": "string",
      "format": "osid-id"
    },
    "syllabusId": {
      "description": "The syllabus associated with this plan.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseOfferingId": {
      "description": "The course offering associated with this plan.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "moduleIds": {
      "description": "The modules to apply to this plan.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Plan",
  "description": "The description of this Plan",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:3366@base.url",
  "modules": [ "course.syllabus.Module:5409@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", "modules", "syllabus", "courseOffering", 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": "PlanQuery",
  "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 Plans with any end reason, false to match Plans with no end reason",
      "type": "boolean"
    },
    "matchSyllabusIds": {
      "description": "List of syllabus Ids for this query to match plan 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"
      }
    },
    "matchCourseOfferingIds": {
      "description": "List of courseOffering Ids for this query to match plan that have a related courseOffering.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseOfferingQueries": {
      "description": "CourseOfferingQueries to match the courseOffering. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchModuleIds": {
      "description": "List of Module Ids for this query to match modules.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "moduleId": {
            "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": "syllabus.ModuleQueries to match the Modules. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyModule": {
      "description": "Match modules with any value. true to match Plans with any modules, false to match Plans with no modules",
      "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

• syllabusId: required(string)

  the syllabus of this metadatum.

  Example:

  syllabus.Syllabus%3A256%40base.url

• courseOfferingId: required(string)

  the course-offering of this metadatum.

  Example:

  course.CourseOffering%3A360%40base.url

• genusType: (string)

  specify a particular plan type to create

  Example:

  type.Type%3AexamplePlanType%40dxtera.org

• recordType: (array of )

  specify support for one or more plan record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this plan

  Example:

  plan.CourseCatalog%3A8374%40base.url

URI Parameters

• planId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• planId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Plan",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this plan, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this plan, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this plan for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this plan.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this plan. 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 plan. 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 plan.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this plan.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this plan ended.",
      "type": "string",
      "format": "osid-id"
    },
    "syllabusId": {
      "description": "The syllabus associated with this plan.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "courseOfferingId": {
      "description": "The course offering associated with this plan.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "moduleIds": {
      "description": "The modules to apply to this plan.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Plan",
  "description": "The description of this Plan",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:3366@base.url",
  "modules": [ "course.syllabus.Module:5409@base.url", "..." ]
}

URI Parameters

• planId: required(string)

URI Parameters

• planId: 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", "activities", "actualStartingActivity", "actualEndingActivity", "plan", "docet", 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%3AexampleLessonType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleLessonType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleLessonType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• planId: (string)

  the id string to match a plan.

  Example:

  plan.Plan%3A96%40base.url

• docetId: (string)

  the id string to match a docet.

  Example:

  syllabus.Docet%3A240%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• planId: required(string)

  the plan of this lesson.

  Example:

  plan.Plan%3A96%40base.url

• docetId: required(string)

  the docet of this lesson.

  Example:

  syllabus.Docet%3A240%40base.url

• genusType: (string)

  specify a particular lesson type to create

  Example:

  type.Type%3AexampleLessonType%40dxtera.org

• recordType: (array of )

  specify support for one or more lesson record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this lesson

  Example:

  plan.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Lesson",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this lesson, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this lesson, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this lesson for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this lesson.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this lesson. 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 lesson. 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 lesson.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this lesson.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this lesson ended.",
      "type": "string",
      "format": "osid-id"
    },
    "planId": {
      "description": "The plan associated with this lesson.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "docetId": {
      "description": "The docet associated with this lesson.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "activityIds": {
      "description": "The activities to which this lesson applies.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "plannedStartTime": {
      "description": "The planned start time within the first activity as deteremined by the Lesson scheduling.",
      "type": "string",
      "format": "duration"
    },
    "begun": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "actualStartTime": {
      "description": "The actual start time.",
      "type": "string",
      "format": "duration"
    },
    "actualStartingActivityId": {
      "description": "The activity when this lesson actually began.",
      "type": "string",
      "format": "osid-id"
    },
    "complete": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "skipped": {
      "description": "Tests if this lesson has been marked as skipped.",
      "type": "boolean"
    },
    "actualEndTime": {
      "description": "The actual completion time.",
      "type": "string",
      "format": "duration"
    },
    "actualEndingActivityId": {
      "description": "The activity when this lesson was completed or skipped.",
      "type": "string",
      "format": "osid-id"
    },
    "actualTimeSpent": {
      "description": "The actual duration of this lesson if it has completed, in progress, or skipped.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Lesson",
  "description": "The description of this Lesson",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:6378@base.url",
  "activities": [ "course.Activity:8538@base.url", "..." ],
  "plannedStartTime": "P3DT3H",
  "begun": true,
  "actualStartTime": "P3DT3H",
  "actualStartingActivityId": "course.Activity:5313@base.url",
  "complete": true,
  "skipped": true,
  "actualEndTime": "P3DT3H",
  "actualEndingActivityId": "course.Activity:1596@base.url",
  "actualTimeSpent": "P3DT3H"
}

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", "activities", "actualStartingActivity", "actualEndingActivity", "plan", "docet", 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": "LessonQuery",
  "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 Lessons with any end reason, false to match Lessons with no end reason",
      "type": "boolean"
    },
    "matchPlanIds": {
      "description": "List of plan Ids for this query to match lesson that have a related plan.",
      "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"
          }
        }
      }
    },
    "planQueries": {
      "description": "PlanQueries to match the plan. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchDocetIds": {
      "description": "List of docet Ids for this query to match lesson that have a related docet.",
      "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"
          }
        }
      }
    },
    "docetQueries": {
      "description": "DocetQueries to match the docet. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchActivityIds": {
      "description": "List of Activity Ids for this query to match activities.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "activityId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "activityQueries": {
      "description": "course.ActivityQueries to match the Activities. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyActivity": {
      "description": "Match activities with any value. true to match Lessons with any activities, false to match Lessons with no activities",
      "type": "boolean"
    },
    "matchPlannedStartTime": {
      "description": "Matches plannedStartTimes 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"
          }
        }
      }
    },
    "matchAnyPlannedStartTime": {
      "description": "Match plannedStartTimes with any value. true to match Lessons with any planned start time, false to match ProgramOfferings with no planned start time",
      "type": "boolean"

    },
    "matchBegun": {
      "description": "Match boolean value for begun.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchActualStartTime": {
      "description": "Matches actualStartTimes 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"
          }
        }
      }
    },
    "matchAnyActualStartTime": {
      "description": "Match actualStartTimes with any value. true to match Lessons with any actual start time, false to match ProgramOfferings with no actual start time",
      "type": "boolean"

    },
    "matchActualStartingActivityIds": {
      "description": "List of Activity Ids for this query to match actualStartingActivity.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "actualStartingActivityId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "actualStartingActivityQueries": {
      "description": "course.ActivityQueries to match the Actual Starting Activity. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyActualStartingActivity": {
      "description": "Match actual starting activity with any value. true to match Lessons with any actual starting activity, false to match Lessons with no actual starting activity",
      "type": "boolean"
    },
    "matchComplete": {
      "description": "Match boolean value for complete.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchSkipped": {
      "description": "Match boolean value for skipped.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchActualEndTime": {
      "description": "Matches actualEndTimes 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"
          }
        }
      }
    },
    "matchAnyActualEndTime": {
      "description": "Match actualEndTimes with any value. true to match Lessons with any actual end time, false to match ProgramOfferings with no actual end time",
      "type": "boolean"

    },
    "matchActualEndingActivityIds": {
      "description": "List of Activity Ids for this query to match actualEndingActivity.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "actualEndingActivityId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "actualEndingActivityQueries": {
      "description": "course.ActivityQueries to match the Actual Ending Activity. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyActualEndingActivity": {
      "description": "Match actual ending activity with any value. true to match Lessons with any actual ending activity, false to match Lessons with no actual ending activity",
      "type": "boolean"
    },
    "matchActualTimeSpent": {
      "description": "Matches actualTimeSpents 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"
          }
        }
      }
    },
    "matchAnyActualTimeSpent": {
      "description": "Match actualTimeSpents with any value. true to match Lessons with any actual time spent, false to match ProgramOfferings with no actual time spent",
      "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

• planId: required(string)

  the plan of this metadatum.

  Example:

  plan.Plan%3A96%40base.url

• docetId: required(string)

  the docet of this metadatum.

  Example:

  syllabus.Docet%3A240%40base.url

• genusType: (string)

  specify a particular lesson type to create

  Example:

  type.Type%3AexampleLessonType%40dxtera.org

• recordType: (array of )

  specify support for one or more lesson record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this lesson

  Example:

  plan.CourseCatalog%3A8374%40base.url

URI Parameters

• lessonId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• lessonId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Lesson",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this lesson, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this lesson, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this lesson for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this lesson.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this lesson. 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 lesson. 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 lesson.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this lesson.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this lesson ended.",
      "type": "string",
      "format": "osid-id"
    },
    "planId": {
      "description": "The plan associated with this lesson.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "docetId": {
      "description": "The docet associated with this lesson.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "activityIds": {
      "description": "The activities to which this lesson applies.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "plannedStartTime": {
      "description": "The planned start time within the first activity as deteremined by the Lesson scheduling.",
      "type": "string",
      "format": "duration"
    },
    "begun": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "actualStartTime": {
      "description": "The actual start time.",
      "type": "string",
      "format": "duration"
    },
    "actualStartingActivityId": {
      "description": "The activity when this lesson actually began.",
      "type": "string",
      "format": "osid-id"
    },
    "complete": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "skipped": {
      "description": "Tests if this lesson has been marked as skipped.",
      "type": "boolean"
    },
    "actualEndTime": {
      "description": "The actual completion time.",
      "type": "string",
      "format": "duration"
    },
    "actualEndingActivityId": {
      "description": "The activity when this lesson was completed or skipped.",
      "type": "string",
      "format": "osid-id"
    },
    "actualTimeSpent": {
      "description": "The actual duration of this lesson if it has completed, in progress, or skipped.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Lesson",
  "description": "The description of this Lesson",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:6378@base.url",
  "activities": [ "course.Activity:8538@base.url", "..." ],
  "plannedStartTime": "P3DT3H",
  "begun": true,
  "actualStartTime": "P3DT3H",
  "actualStartingActivityId": "course.Activity:5313@base.url",
  "complete": true,
  "skipped": true,
  "actualEndTime": "P3DT3H",
  "actualEndingActivityId": "course.Activity:1596@base.url",
  "actualTimeSpent": "P3DT3H"
}

URI Parameters

• lessonId: required(string)

URI Parameters

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

• planId: (string)

  Get course-catalogs mapped to this plan.

  Example:

  plan.Plan%3A208%40demo.dxtera.org

• lessonId: (string)

  Get course-catalogs mapped to this lesson.

  Example:

  plan.Lesson%3A312%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular courseCatalog type to create

  Example:

  type.Type%3AexampleCourseCatalogType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseCatalog record types

  Example:

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

Body

Media type: application/json

Type: json

Content:

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

Example:

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

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

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

  Example:

  all

Body

Media type: application/json

Type: json

Content:

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

Example:

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

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

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Body

Media type: application/json

Type: json

Content:

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

Example:

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

URI Parameters

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

URI Parameters

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

URI Parameters

• courseCatalogId: required(string)

URI Parameters

• courseCatalogId: required(string)

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "modules", "syllabus", "courseOffering", 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%3AexamplePlanType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePlanType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePlanType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• planId: required(string)

URI Parameters

• courseCatalogId: required(string)
• planId: 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", "activities", "actualStartingActivity", "actualEndingActivity", "plan", "docet", 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%3AexampleLessonType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleLessonType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleLessonType%40campusapi.org

URI Parameters

• courseCatalogId: required(string)
• lessonId: required(string)

URI Parameters

• courseCatalogId: required(string)
• lessonId: required(string)