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

Query Parameters

• offset: (integer - default: 0)

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

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "requisiteOptions", "courseRequirements", "programRequirements", "credentialRequirements", "learningObjectiveRequirements", "assessmentRequirements", "awardRequirements", "courseRequirements", "requisiteRequirements", or "all" to expand all referenced objects or types.Additionally, expand "requisites" will expand all requisiteOptions and requisiteRequirements. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleRequisiteType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleRequisiteType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleRequisiteType%40campusapi.org

• requisiteOptionId: (string)

  Id string to match requisiteOption.

  Example:

  requisite.Requisite%3A3767%40base.url

• courseRequirementId: (string)

  Id string to match courseRequirement.

  Example:

  requisite.CourseRequirement%3A98723%40base.url

• programRequirementId: (string)

  Id string to match programRequirement.

  Example:

  requisite.ProgramRequirement%3A89283%40base.url

• credentialRequirementId: (string)

  Id string to match credentialRequirement.

  Example:

  requisite.CredentialRequirement%3A682%40base.url

• learningObjectiveRequirementId: (string)

  Id string to match learningObjectiveRequirement.

  Example:

  requisite.LearningObjectiveRequirement%3A9823%40base.url

• assessmentRequirementId: (string)

  Id string to match assessmentRequirement.

  Example:

  requisite.AssessmentRequirement%3A3827%40base.url

• awardRequirementId: (string)

  Id string to match awardRequirement.

  Example:

  requisite.AwardRequirement%3A873%40base.url

• requisiteRequirementId: (string)

  Id string to match requisiteRequirement.

  Example:

  requisite.Requisite%3A3225%40base.url

• expandRequisites: (boolean)

  expand all requisiteOptions and requisiteRequirements. To be deprecated in favor of expand=requisites.

  Example:

  true

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this requisite

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Requisite",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this requisite. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this requisite. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this requisite for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this requisite.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this requisite. 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 requisite. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this requisite 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 requisite is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this requisite is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this requisite is operational. This requisite is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "sequestered": {
      "description": "Whether this requisite is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "scheduleId": {
      "description": "A schedule that governs the effectiveness of this requisite. If a schedule exists, it is bounded by the effective dates of this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "eventId": {
      "description": "An Event that governs the effectiveness of this requisite such that the start and end dates of the event govern the effectiveness. The event may also be a RecurringEvent in which case the enabler is effective for start and end dates of each event in the series If an event exists, it is bounded by the effective dates of this requisite. If a schedule exists, it is bounded by the effective dates of this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "cyclicEventId": {
      "description": "A CyclicEvent that governs theffectiveness of this requisite. If a cyclic event exists, it is evaluated by the accompanying cyclic time period.",
      "type": "string",
      "format": "osid-id"
    },
    "demographicId": {
      "description": "A Demographic Resource that governs the effectiveness of this requisite.",
      "type": "string",
      "format": "osid-id"
    }, 
    "minimumEarnedCredits": {
      "description": "The minimum earned credits applied to CourseRequirements, if applicable.",
      "type": "number"
    },
    "minimumCourseCount": {
      "description": "The minimum number of courses applied to CourseRequirements, if applicable.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Requisite",
  "description": "The description of this Requisite",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "schedule": "calendaring.Schedule:1747@base.url",
  "event": "calendaring.Event:1747@base.url",
  "cyclicEvent": "cycle.CyclicEvent:1747@base.url",
  "demographic": "resource.Resource:1747@base.url",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "sequestered": false
}

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", "rule", "requisiteOptions", "courseRequirements", "programRequirements", "credentialRequirements", "learningObjectiveRequirements", "assessmentRequirements", "awardRequirements", "courseRequirements", "requisiteRequirements", or "all" to expand all referenced objects or types.Additionally, expand "requisites" will expand all requisiteOptions and requisiteRequirements. 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": "RequisiteQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchSequestered": {
      "description": "Match containables that are sequestered.  true to match any sequestered containables, false to match non-sequestered containables",
      "type": "boolean"
    },
    "matchScheduleIds": {
      "description": "List of associated schedule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scheduleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "scheduleQueries": {
      "description": "calendaring.ScheduleQuery for the schedule. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "schedule-query"
      }
    },
    "matchEventIds": {
      "description": "List of associated event Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "eventQueries": {
      "description": "calendaring.EventQuery for the event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchCyclicEventIds": {
      "description": "List of associated cyclic event Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cyclicEventId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "cyclicEventQueries": {
      "description": "calendaring.CyclicEventQuery for the cyclic event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "cyclic-event-query"
      }
    },
    "matchDemographicIds": {
      "description": "List of demographic resource Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "demographicId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "demographicQueries": {
      "description": "resource.ResourceQuery for the demographic. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this requisite

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this Requisite",
    "description": "The description of this Requisite",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "schedule": "calendaring.Schedule:9756@base.url",
    "event": "calendaring.Event:9756@base.url",
    "cyclicEvent": "cycle.CyclicEvent:9756@base.url",
    "demographic": "resource.Resource:9756@base.url",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "sequestered": false,
    "minimumEarnedCredits": 10,
    "minimumCourseCount": 3
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular requisite type to create

  Example:

  type.Type%3AexampleRequisiteType%40dxtera.org

• recordType: (array of )

  specify support for one or more requisite record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this requisite

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• requisiteId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "requisiteOptions", "courseRequirements", "programRequirements", "credentialRequirements", "learningObjectiveRequirements", "assessmentRequirements", "awardRequirements", "courseRequirements", "requisiteRequirements", or "all" to expand all referenced objects or types.Additionally, expand "requisites" will expand all requisiteOptions and requisiteRequirements. This parameter can be repeated to expand multiples.

  Example:

  all

• expandRequisites: (boolean)

  expand all requisiteOptions and requisiteRequirements. To be deprecated in favor of expand=requisites.

  Example:

  true

URI Parameters

• requisiteId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RequisiteItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this requisite. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this requisite. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this requisite for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this requisite.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this requisite. 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 requisite. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this requisite 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 requisite is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this requisite is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this requisite is operational. This requisite is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "sequestered": {
      "description": "Whether this requisite is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "scheduleId": {
      "description": "A schedule that governs the effectiveness of this requisite. If a schedule exists, it is bounded by the effective dates of this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "eventId": {
      "description": "An Event that governs the effectiveness of this requisite such that the start and end dates of the event govern the effectiveness. The event may also be a RecurringEvent in which case the enabler is effective for start and end dates of each event in the series If an event exists, it is bounded by the effective dates of this requisite. If a schedule exists, it is bounded by the effective dates of this requisite.",
      "type": "string",
      "format": "osid-id"
    },
    "cyclicEventId": {
      "description": "A CyclicEvent that governs theffectiveness of this requisite. If a cyclic event exists, it is evaluated by the accompanying cyclic time period.",
      "type": "string",
      "format": "osid-id"
    },
    "demographicId": {
      "description": "A Demographic Resource that governs the effectiveness of this requisite.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Requisite",
  "description": "The description of this Requisite",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "schedule": "calendaring.Schedule:8813@base.url",
  "event": "calendaring.Event:8813@base.url",
  "cyclicEvent": "cycle.CyclicEvent:8813@base.url",
  "demographic": "resource.Resource:8813@base.url",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "sequestered": false
}

URI Parameters

• requisiteId: required(string)

URI Parameters

• requisiteId: required(string)

URI Parameters

• requisiteId: required(string)
• courseRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• courseRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• programRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• programRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• credentialRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• credentialRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• learningObjectiveRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• learningObjectiveRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• assessmentRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• assessmentRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• awardRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• awardRequirementId: required(string)

URI Parameters

• requisiteId: required(string)
• requisiteId: required(string)

URI Parameters

• requisiteId: required(string)
• requisiteId: required(string)

URI Parameters

• requisiteId: required(string)
• requisiteId: required(string)

URI Parameters

• requisiteId: required(string)
• requisiteId: 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", "rule", "minimumGrade", "minimumScoreSystem", "course", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCourseRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCourseRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCourseRequirementType%40campusapi.org

• courseId: (string)

  the id string to match a course.

  Example:

  course.Course%3A612%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this courseRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseRequirement",
  "type": "object",
  "required": ["courseId"],
  "properties": {
    "id": {
      "description": "The unique id of this course requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course requirement. 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 requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this course requirement is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this course requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course requirement is operational. This course requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this course requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The course associated with this course requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "requiresCompletion": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "timeframe": {
      "description": "The timeframe in which the course has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGradeId": {
      "description": "The minimum grade.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score.",
      "type": "number"
    },
    "minimumEarnedCredits": {
      "description": "The minimum earned credits.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseRequirement",
  "description": "The description of this CourseRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "courseId": "course.Course:8346@base.url",
  "requiresCompletion": true,
  "timeframe": "P3DT3H",
  "minimumGradeId": "grading.Grade:8061@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:3818@base.url",
  "minimumScore": 3.14,
  "minimumEarnedCredits": 3.14
}

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", "rule", "minimumGrade", "minimumScoreSystem", "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": "CourseRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchCourseIds": {
      "description": "List of course Ids for this query to match course requirement that have a related course.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseQueries": {
      "description": "CourseQueries to match the course. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-query"
      }
    },
    "matchRequiresCompletion": {
      "description": "Match boolean value for requiresCompletion.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchTimeframe": {
      "description": "Matches timeframes 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"
          }
        }
      }
    },
    "matchAnyTimeframe": {
      "description": "Match timeframes with any value. true to match CourseRequirements with any timeframe, false to match ProgramOfferings with no timeframe",
      "type": "boolean"
    },
    "matchMinimumGradeIds": {
      "description": "List of Grade Ids for this query to match minimumGrade.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumGradeId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumGradeQueries": {
      "description": "grading.GradeQueries to match the Minimum Grade. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyMinimumGrade": {
      "description": "Match minimum grade with any value. true to match CourseRequirements with any minimum grade, false to match CourseRequirements with no minimum grade",
      "type": "boolean"
    },
    "matchMinimumScoreSystemIds": {
      "description": "List of GradeSystem Ids for this query to match minimumScoreSystem.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumScoreSystemId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumScoreSystemQueries": {
      "description": "grading.GradeSystemQueries to match the Minimum Score System. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyMinimumScoreSystem": {
      "description": "Match minimum score system with any value. true to match CourseRequirements with any minimum score system, false to match CourseRequirements with no minimum score system",
      "type": "boolean"
    },
    "matchMinimumScore": {
      "description": "Match MinimumScore within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumScore": {
      "description": "Match minimumScores with any value. true to match CourseRequirements with any minimum score, false to match ProgramOfferings with no minimum score",
      "type": "boolean"
    },
    "matchMinimumEarnedCredits": {
      "description": "Match MinimumEarnedCredits within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumEarnedCredits": {
      "description": "Match minimumEarnedCredits with any value. true to match CourseRequirements with any minimum earned credits, false to match ProgramOfferings with no minimum earned credits",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this courseRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this CourseRequirement",
    "description": "The description of this CourseRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "requiresCompletion": true,
    "timeframe": "P3DT3H",
    "minimumGradeId": "grading.Grade:6658@base.url",
    "minimumScoreSystemId": "grading.GradeSystem:6234@base.url",
    "minimumScore": 3.14,
    "minimumEarnedCredits": 3.14
  },
  {
    "...": "..."
  }
]

Query Parameters

• courseId: required(string)

  the course of this metadatum.

  Example:

  course.Course%3A612%40base.url

• genusType: (string)

  specify a particular courseRequirement type to create

  Example:

  type.Type%3AexampleCourseRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more courseRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this courseRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• courseRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• courseRequirementId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CourseRequirementItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this course requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this course requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this course requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this course requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this course requirement. 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 requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this course requirement is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this course requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this course requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this course requirement is operational. This course requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this course requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "courseId": {
      "description": "The course associated with this course requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "requiresCompletion": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "timeframe": {
      "description": "The timeframe in which the course has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGradeId": {
      "description": "The minimum grade.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score.",
      "type": "number"
    },
    "minimumEarnedCredits": {
      "description": "The minimum earned credits.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CourseRequirement",
  "description": "The description of this CourseRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "requiresCompletion": true,
  "timeframe": "P3DT3H",
  "minimumGradeId": "grading.Grade:1377@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:4094@base.url",
  "minimumScore": 3.14,
  "minimumEarnedCredits": 3.14
}

URI Parameters

• courseRequirementId: required(string)

URI Parameters

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleProgramRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleProgramRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleProgramRequirementType%40campusapi.org

• programId: (string)

  the id string to match a program.

  Example:

  program.Program%3A882%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this programRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProgramRequirement",
  "type": "object",
  "required": ["programId"],
  "properties": {
    "id": {
      "description": "The unique id of this program requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this program requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this program requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this program requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this program requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this program requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this program requirement 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 program requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this program requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this program requirement is operational. This program requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this program requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "programId": {
      "description": "The program associated with this program requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "requiresCompletion": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "timeframe": {
      "description": "The timeframe in which the program has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGPASystemId": {
      "description": "The scoring system for the minimum GPA.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumGPA": {
      "description": "The minimum GPA.",
      "type": "number"
    },
    "minimumEarnedCredits": {
      "description": "The minimum earned credits.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ProgramRequirement",
  "description": "The description of this ProgramRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "programId": "course.program.Program:2804@base.url",
  "requiresCompletion": true,
  "timeframe": "P3DT3H",
  "minimumGpaSystemId": "grading.GradeSystem:5356@base.url",
  "minimumGPA": 3.14,
  "minimumEarnedCredits": 3.14
}

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", "rule", "minimumGPASystem", "program", 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": "ProgramRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchProgramIds": {
      "description": "List of program Ids for this query to match program requirement that have a related program.",
      "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"
          }
        }
      }
    },
    "programQueries": {
      "description": "ProgramQueries to match the program. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "program-query"
      }
    },
    "matchRequiresCompletion": {
      "description": "Match boolean value for requiresCompletion.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchTimeframe": {
      "description": "Matches timeframes 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"
          }
        }
      }
    },
    "matchAnyTimeframe": {
      "description": "Match timeframes with any value. true to match ProgramRequirements with any timeframe, false to match ProgramOfferings with no timeframe",
      "type": "boolean"
    },
    "matchMinimumGPASystemIds": {
      "description": "List of GradeSystem Ids for this query to match minimumGPASystem.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumGPASystemId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumGPASystemQueries": {
      "description": "grading.GradeSystemQueries to match the Minimum GPA System. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyMinimumGPASystem": {
      "description": "Match minimum gpa system with any value. true to match ProgramRequirements with any minimum gpa system, false to match ProgramRequirements with no minimum gpa system",
      "type": "boolean"
    },
    "matchMinimumGPA": {
      "description": "Match MinimumGPA within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumGPA": {
      "description": "Match minimumGpas with any value. true to match ProgramRequirements with any minimum gpa, false to match ProgramOfferings with no minimum gpa",
      "type": "boolean"
    },
    "matchMinimumEarnedCredits": {
      "description": "Match MinimumEarnedCredits within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumEarnedCredits": {
      "description": "Match minimumEarnedCredits with any value. true to match ProgramRequirements with any minimum earned credits, false to match ProgramOfferings with no minimum earned credits",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this programRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this ProgramRequirement",
    "description": "The description of this ProgramRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "requiresCompletion": true,
    "timeframe": "P3DT3H",
    "minimumGpaSystemId": "grading.GradeSystem:5808@base.url",
    "minimumGPA": 3.14,
    "minimumEarnedCredits": 3.14
  },
  {
    "...": "..."
  }
]

Query Parameters

• programId: required(string)

  the program of this metadatum.

  Example:

  program.Program%3A882%40base.url

• genusType: (string)

  specify a particular programRequirement type to create

  Example:

  type.Type%3AexampleProgramRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more programRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this programRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• programRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• programRequirementId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ProgramRequirementItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this program requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this program requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this program requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this program requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this program requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this program requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this program requirement 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 program requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this program requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this program requirement is operational. This program requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this program requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "programId": {
      "description": "The program associated with this program requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "requiresCompletion": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "timeframe": {
      "description": "The timeframe in which the program has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGPASystemId": {
      "description": "The scoring system for the minimum GPA.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumGPA": {
      "description": "The minimum GPA.",
      "type": "number"
    },
    "minimumEarnedCredits": {
      "description": "The minimum earned credits.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ProgramRequirement",
  "description": "The description of this ProgramRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "requiresCompletion": true,
  "timeframe": "P3DT3H",
  "minimumGpaSystemId": "grading.GradeSystem:9880@base.url",
  "minimumGPA": 3.14,
  "minimumEarnedCredits": 3.14
}

URI Parameters

• programRequirementId: required(string)

URI Parameters

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCredentialRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCredentialRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCredentialRequirementType%40campusapi.org

• credentialId: (string)

  the id string to match a credential.

  Example:

  program.Credential%3A1470%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this credentialRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CredentialRequirement",
  "type": "object",
  "required": ["credentialId"],
  "properties": {
    "id": {
      "description": "The unique id of this credential requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this credential requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this credential requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this credential requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this credential requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this credential requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this credential requirement 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 credential requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this credential requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this credential requirement is operational. This credential requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this credential requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "credentialId": {
      "description": "The credential associated with this credential requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timeframe": {
      "description": "The timeframe in which the credential has to be earned.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CredentialRequirement",
  "description": "The description of this CredentialRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "credentialId": "course.program.Credential:2418@base.url",
  "timeframe": "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", "rule", "credential", 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": "CredentialRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchCredentialIds": {
      "description": "List of credential Ids for this query to match credential requirement that have a related credential.",
      "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"
          }
        }
      }
    },
    "credentialQueries": {
      "description": "CredentialQueries to match the credential. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "credential-query"
      }
    },
    "matchTimeframe": {
      "description": "Matches timeframes 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"
          }
        }
      }
    },
    "matchAnyTimeframe": {
      "description": "Match timeframes with any value. true to match CredentialRequirements with any timeframe, false to match ProgramOfferings with no timeframe",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this credentialRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this CredentialRequirement",
    "description": "The description of this CredentialRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "timeframe": "P3DT3H"
  },
  {
    "...": "..."
  }
]

Query Parameters

• credentialId: required(string)

  the credential of this metadatum.

  Example:

  program.Credential%3A1470%40base.url

• genusType: (string)

  specify a particular credentialRequirement type to create

  Example:

  type.Type%3AexampleCredentialRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more credentialRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this credentialRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• credentialRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• credentialRequirementId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CredentialRequirementItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this credential requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this credential requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this credential requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this credential requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this credential requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this credential requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this credential requirement 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 credential requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this credential requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this credential requirement is operational. This credential requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this credential requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "credentialId": {
      "description": "The credential associated with this credential requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timeframe": {
      "description": "The timeframe in which the credential has to be earned.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this CredentialRequirement",
  "description": "The description of this CredentialRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "timeframe": "P3DT3H"
}

URI Parameters

• credentialRequirementId: required(string)

URI Parameters

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleLearningObjectiveRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleLearningObjectiveRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleLearningObjectiveRequirementType%40campusapi.org

• learningObjectiveId: (string)

  the id string to match a learning-objective.

  Example:

  learning.Objective%3A4032%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this learningObjectiveRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LearningObjectiveRequirement",
  "type": "object",
  "required": ["learningObjectiveId"],
  "properties": {
    "id": {
      "description": "The unique id of this learning objective requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this learning objective requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this learning objective requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this learning objective requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this learning objective requirement. 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 learning objective requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this learning objective requirement 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 learning objective requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this learning objective requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this learning objective requirement is operational. This learning objective requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this learning objective requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "learningObjectiveId": {
      "description": "The learning objective associated with this learning objective requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "minimumProficiencyId": {
      "description": "The minimum proficiency expressed as a Grade.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this LearningObjectiveRequirement",
  "description": "The description of this LearningObjectiveRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "learningObjectiveId": "learning.Objective:3602@base.url",
  "minimumProficiencyId": "grading.Grade:5093@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", "rule", "minimumProficiency", "learningObjective", 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": "LearningObjectiveRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchLearningObjectiveIds": {
      "description": "List of learningObjective Ids for this query to match learning objective requirement that have a related learningObjective.",
      "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"
          }
        }
      }
    },
    "learningObjectiveQueries": {
      "description": "LearningObjectiveQueries to match the learningObjective. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "objective-query"
      }
    },
    "matchMinimumProficiencyIds": {
      "description": "List of Grade Ids for this query to match minimumProficiency.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumProficiencyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumProficiencyQueries": {
      "description": "grading.GradeQueries to match the Minimum Proficiency. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyMinimumProficiency": {
      "description": "Match minimum proficiency with any value. true to match LearningObjectiveRequirements with any minimum proficiency, false to match LearningObjectiveRequirements with no minimum proficiency",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this learningObjectiveRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "LearningObjectiveRequirementBatch",
    "type": "array",
    "Items": {
        "type": "learning-objective-requirement"
    }
}

Example:

[
  {
    "displayName": "Display Name of this LearningObjectiveRequirement",
    "description": "The description of this LearningObjectiveRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "minimumProficiencyId": "grading.Grade:2595@base.url"
  },
  {
    "...": "..."
  }
]

Query Parameters

• learningObjectiveId: required(string)

  the learning-objective of this metadatum.

  Example:

  learning.Objective%3A4032%40base.url

• genusType: (string)

  specify a particular learningObjectiveRequirement type to create

  Example:

  type.Type%3AexampleLearningObjectiveRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more learningObjectiveRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this learningObjectiveRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• learningObjectiveRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• learningObjectiveRequirementId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LearningObjectiveRequirementItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this learning objective requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this learning objective requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this learning objective requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this learning objective requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this learning objective requirement. 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 learning objective requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this learning objective requirement 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 learning objective requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this learning objective requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this learning objective requirement is operational. This learning objective requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this learning objective requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "learningObjectiveId": {
      "description": "The learning objective associated with this learning objective requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "minimumProficiencyId": {
      "description": "The minimum proficiency expressed as a Grade.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this LearningObjectiveRequirement",
  "description": "The description of this LearningObjectiveRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "minimumProficiencyId": "grading.Grade:1367@base.url"
}

URI Parameters

• learningObjectiveRequirementId: required(string)

URI Parameters

• learningObjectiveRequirementId: 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", "rule", "minimumGrade", "minimumScoreSystem", "assessment", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAssessmentRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAssessmentRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAssessmentRequirementType%40campusapi.org

• assessmentId: (string)

  the id string to match a assessment.

  Example:

  assessment.Assessment%3A2100%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this assessmentRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentRequirement",
  "type": "object",
  "required": ["assessmentId"],
  "properties": {
    "id": {
      "description": "The unique id of this assessment requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this assessment requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this assessment requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this assessment requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this assessment requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this assessment requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this assessment requirement is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this assessment requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this assessment requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this assessment requirement is operational. This assessment requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this assessment requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "assessmentId": {
      "description": "The assessment associated with this assessment requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timeframe": {
      "description": "The timeframe in which the assessment has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGradeId": {
      "description": "The minimum grade.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AssessmentRequirement",
  "description": "The description of this AssessmentRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "assessmentId": "assessment.Assessment:5047@base.url",
  "timeframe": "P3DT3H",
  "minimumGradeId": "grading.Grade:9937@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:4820@base.url",
  "minimumScore": 3.14
}

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", "rule", "minimumGrade", "minimumScoreSystem", "assessment", 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": "AssessmentRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchAssessmentIds": {
      "description": "List of assessment Ids for this query to match assessment requirement that have a related assessment.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "assessmentQueries": {
      "description": "AssessmentQueries to match the assessment. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "assessment-query"
      }
    },
    "matchTimeframe": {
      "description": "Matches timeframes 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"
          }
        }
      }
    },
    "matchAnyTimeframe": {
      "description": "Match timeframes with any value. true to match AssessmentRequirements with any timeframe, false to match ProgramOfferings with no timeframe",
      "type": "boolean"
    },
    "matchMinimumGradeIds": {
      "description": "List of Grade Ids for this query to match minimumGrade.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumGradeId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumGradeQueries": {
      "description": "grading.GradeQueries to match the Minimum Grade. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-query"
      }
    },
    "matchAnyMinimumGrade": {
      "description": "Match minimum grade with any value. true to match AssessmentRequirements with any minimum grade, false to match AssessmentRequirements with no minimum grade",
      "type": "boolean"
    },
    "matchMinimumScoreSystemIds": {
      "description": "List of GradeSystem Ids for this query to match minimumScoreSystem.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "minimumScoreSystemId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "minimumScoreSystemQueries": {
      "description": "grading.GradeSystemQueries to match the Minimum Score System. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "grade-system-query"
      }
    },
    "matchAnyMinimumScoreSystem": {
      "description": "Match minimum score system with any value. true to match AssessmentRequirements with any minimum score system, false to match AssessmentRequirements with no minimum score system",
      "type": "boolean"
    },
    "matchMinimumScore": {
      "description": "Match MinimumScore within the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "starting value",
            "type": "number"
          },
          "to": {
            "description": "ending value",
            "type": "number"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMinimumScore": {
      "description": "Match minimumScores with any value. true to match AssessmentRequirements with any minimum score, false to match ProgramOfferings with no minimum score",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this assessmentRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this AssessmentRequirement",
    "description": "The description of this AssessmentRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "timeframe": "P3DT3H",
    "minimumGradeId": "grading.Grade:8853@base.url",
    "minimumScoreSystemId": "grading.GradeSystem:1798@base.url",
    "minimumScore": 3.14
  },
  {
    "...": "..."
  }
]

Query Parameters

• assessmentId: required(string)

  the assessment of this metadatum.

  Example:

  assessment.Assessment%3A2100%40base.url

• genusType: (string)

  specify a particular assessmentRequirement type to create

  Example:

  type.Type%3AexampleAssessmentRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more assessmentRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this assessmentRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• assessmentRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• assessmentRequirementId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AssessmentRequirementItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this assessment requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this assessment requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this assessment requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this assessment requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this assessment requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this assessment requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this assessment requirement is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this assessment requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this assessment requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this assessment requirement is operational. This assessment requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this assessment requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "assessmentId": {
      "description": "The assessment associated with this assessment requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timeframe": {
      "description": "The timeframe in which the assessment has to be completed.",
      "type": "string",
      "format": "duration"
    },
    "minimumGradeId": {
      "description": "The minimum grade.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScoreSystemId": {
      "description": "The scoring system for the minimum score.",
      "type": "string",
      "format": "osid-id"
    },
    "minimumScore": {
      "description": "The minimum score.",
      "type": "number"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AssessmentRequirement",
  "description": "The description of this AssessmentRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "timeframe": "P3DT3H",
  "minimumGradeId": "grading.Grade:477@base.url",
  "minimumScoreSystemId": "grading.GradeSystem:173@base.url",
  "minimumScore": 3.14
}

URI Parameters

• assessmentRequirementId: required(string)

URI Parameters

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

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAwardRequirementType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAwardRequirementType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAwardRequirementType%40campusapi.org

• awardId: (string)

  the id string to match a award.

  Example:

  recognition.Award%3A880%40base.url

• altRequisiteId: (string)

  Id string to match altRequisite.

  Example:

  requisite.Requisite%3A3827%40base.url

• courseCatalogId: (string)

  The id string to match a courseCatalog

  Example:

  course.CourseCatalog%3A8374%40base.url

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this awardRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AwardRequirement",
  "type": "object",
  "required": ["awardId"],
  "properties": {
    "id": {
      "description": "The unique id of this award requirement. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this award requirement. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this award requirement for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this award requirement.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this award requirement. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this award requirement. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this award requirement 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 award requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this award requirement is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this award requirement is operational. This award requirement is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this award requirement.",
      "type": "string",
      "format": "osid-id"
    },
    "awardId": {
      "description": "The award associated with this award requirement.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timeframe": {
      "description": "The timeframe in which the award has to be earned.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this AwardRequirement",
  "description": "The description of this AwardRequirement",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "awardId": "recognition.Award:9769@base.url",
  "timeframe": "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", "rule", "award", 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": "AwardRequirementQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "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"
          }
        }
      }
    },
    "matchAwardIds": {
      "description": "List of award Ids for this query to match award requirement that have a related award.",
      "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"
          }
        }
      }
    },
    "awardQueries": {
      "description": "AwardQueries to match the award. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "award-query"
      }
    },
    "matchTimeframe": {
      "description": "Matches timeframes 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"
          }
        }
      }
    },
    "matchAnyTimeframe": {
      "description": "Match timeframes with any value. true to match AwardRequirements with any timeframe, false to match ProgramOfferings with no timeframe",
      "type": "boolean"
    },
    "matchCourseCatalogIds": {
      "description": "List of CourseCatalog Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "courseCatalogId": {
            "description": "Course Catalog id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "courseCatalogQueries": {
      "description": "CourseCatalogQueries to match Course Catalog. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "course-catalog-query"
      }
    }
  }
}

Example:

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

Query Parameters

• courseCatalogId: (string)

  specify in which course-catalog to create this awardRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

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

Example:

[
  {
    "displayName": "Display Name of this AwardRequirement",
    "description": "The description of this AwardRequirement",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "timeframe": "P3DT3H"
  },
  {
    "...": "..."
  }
]

Query Parameters

• awardId: required(string)

  the award of this metadatum.

  Example:

  recognition.Award%3A880%40base.url

• genusType: (string)

  specify a particular awardRequirement type to create

  Example:

  type.Type%3AexampleAwardRequirementType%40dxtera.org

• recordType: (array of )

  specify support for one or more awardRequirement record types

  Example:

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

• courseCatalogId: (string)

  specify in which course-catalog to create this awardRequirement

  Example:

  requisite.CourseCatalog%3A8374%40base.url

URI Parameters

• awardRequirementId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all