Jump to

• Request
• Response

Get all curriculum items

get

/fscmRestApi/resources/11.13.18.05/curriculumItems

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • FacetedSearchFinder: Finds all curriculum items that match the search criteria.
    Finder Variables:
    • CampusIds; string; Campus identifiers for the curriculum item.
    • CurriculumTagValueIds; string; Curriculum tag value identifiers for the curriculum item.
    • Keyword; string; Keyword for the curriculum item.
    • OnFri; boolean; Curriculum Item has a meeting pattern on Friday.
    • OnMon; boolean; Curriculum Item has a meeting pattern on Monday.
    • OnSat; boolean; Curriculum Item has a meeting pattern on Saturday.
    • OnSun; boolean; Curriculum Item has a meeting pattern on Sunday.
    • OnThu; boolean; Curriculum Item has a meeting pattern on Thursday.
    • OnTue; boolean; Curriculum Item has a meeting pattern on Tuesday.
    • OnWed; boolean; Curriculum Item has a meeting pattern on Wednesday.
    • TimeFrom; string; Time start for the curriculum item.
    • TimeTo; string; Time end for the curriculum item.
  • PrimaryKey: Finds all curriculum items that match the primary key criteria specified.
    Finder Variables:
    • CurriculumId; integer; Unique identifier for the curriculum item.
  • SponsoredCourseFinder: Finds all curriculum items which are sponsored.
    Finder Variables:
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicLevelId; integer; The unique identifier for the academic level.
  • AcademicLevelName; string; The name of the academic level associated with curriculum item.
  • AcademicPeriodId; integer; The unique identifier for an academic period.
  • AcademicSubjectId; integer; The unique identifier for the academic subject of the curriculum item.
  • CoursePayToEnrollFlag; boolean; Indicates whether the course curriculum item should be placed in the shopping cart and students must make payment at the point of enrollment. The default value is false.
  • CurriculumFormatCode; string; The code for the format, such as online, of the curriculum item. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
  • CurriculumHeaderId; integer; The unique identifier for a curriculum item header record.
  • CurriculumId; integer; The generated unique identifier of a curriculum item.
  • CurriculumName; string; The name of a curriculum item.
  • CurriculumTitle; string; The title of a curriculum item.
  • CurriculumType; string; The unique identifier of the type category of a curriculum item.
  • FlatAmount; number; The numeric value that indicates the flat amount charge of a curriculum item.
  • IsCartableFlag; boolean; Indicates whether the curriculum item can be added to the shopping cart. The default value is true.
  • MaximumUnitsQuantity; number; A numeric value indicating the maximum units of the course curriculum item.
  • MinimumUnitsQuantity; number; A numeric value indicating the minimum units of the course curriculum item.
  • OwningCurriculumId; integer; The unique identifier for the parent curriculum item.
  • OwningCurriculumName; string; The name for the parent curriculum item.
  • PeriodName; string; The name of the academic period.
  • ReportingPeriodId; integer; The unique identifier for a reporting period.
  • ReportingPeriodName; string; The name of the reporting period.
  • StartDate; string; The date when the curriculum item starts.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : curriculumItems

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object curriculumItems-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level

  Read Only: true

  The unique identifier for the academic level.
• AcademicLevelName: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 50

  The name of the academic level associated with curriculum item.
• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier for an academic period.
• AcademicSubjectId: integer
  Title: Subject

  Read Only: true

  The unique identifier for the academic subject of the curriculum item.
• CoursePayToEnrollFlag: boolean
  Title: Pay to enroll

  Read Only: true

  Maximum Length: 1

  Indicates whether the course curriculum item should be placed in the shopping cart and students must make payment at the point of enrollment. The default value is false.
• CurriculumFormatCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The code for the format, such as online, of the curriculum item. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumHeaderId: integer (int64)
  Read Only: true

  The unique identifier for a curriculum item header record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated unique identifier of a curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of a curriculum item.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of a curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The unique identifier of the type category of a curriculum item.
• FlatAmount: number
  Title: Flat Amount

  Read Only: true

  The numeric value that indicates the flat amount charge of a curriculum item.
• IsCartableFlag: boolean
  Title: Shopping Cart Enabled

  Read Only: true

  Maximum Length: 4

  Indicates whether the curriculum item can be added to the shopping cart. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumUnitsQuantity: number
  Title: Maximum Units

  Read Only: true

  A numeric value indicating the maximum units of the course curriculum item.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  A numeric value indicating the minimum units of the course curriculum item.
• offeringStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  The offering storefronts resource is a child of the curriculum items resource and provides a list of offering storefronts associated with a curriculum item.
• OwningCurriculumId: integer
  Title: Owning Curriculum ID

  Read Only: true

  The unique identifier for the parent curriculum item.
• OwningCurriculumName: string
  Title: Owning Name

  Read Only: true

  Maximum Length: 50

  The name for the parent curriculum item.
• PeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period.
• program: array Programs
  Title: Programs

  The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier for a reporting period.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period.
• scheduledCourse: array Scheduled Courses
  Title: Scheduled Courses

  The scheduled course resource is a child of the curriculum items resource and provides the information for a scheduled course curriculum item.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the curriculum item starts.
• unscheduledCourseOffering: array Unscheduled Course Offerings
  Title: Unscheduled Course Offerings

  The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.

{
    "type":"object",
    "properties":{
        "OwningCurriculumName":{
            "title":"Owning Name",
            "maxLength":50,
            "type":"string",
            "description":"The name for the parent curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Owning Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"The offering storefronts resource is a child of the curriculum items resource and provides a list of offering storefronts associated with a curriculum item.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-offeringStorefronts-item-response"
            }
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "program":{
            "title":"Programs",
            "type":"array",
            "description":"The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-item-response"
            },
            "x-cardinality":"1"
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the curriculum item starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "customLinks":"true",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"60",
                "facetControl":"dateRange",
                "title":"Start Date",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level",
            "type":"integer",
            "description":"The unique identifier for the academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "sortNumber":"23",
                "facetControl":"multiSelect",
                "sortBy":"orderBy=PrimacyNumber",
                "title":"Academic Level",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "CoursePayToEnrollFlag":{
            "title":"Pay to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the course curriculum item should be placed in the shopping cart and students must make payment at the point of enrollment. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "maxLength":4,
            "type":"boolean",
            "description":"Indicates whether the curriculum item can be added to the shopping cart. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "displayValue":"Show Available Only",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "defaultValue":"true",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"50",
                "facetControl":"switch",
                "title":"Availability",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic level associated with curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "unscheduledCourseOffering":{
            "title":"Unscheduled Course Offerings",
            "type":"array",
            "description":"The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for an academic period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumHeaderId":{
            "type":"integer",
            "description":"The unique identifier for a curriculum item header record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the course curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the type category of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "showAll":"true",
                "staticValues":"PROGRAM,COURSE:SECTION",
                "staticDisplayValues":"Programs,Courses",
                "sortNumber":"10",
                "facetControl":"singleSelectRadio",
                "isMainFacet":"true",
                "title":"Category",
                "facetDiscriminatorAttribute":"true",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Flat Amount",
            "type":"number",
            "description":"The numeric value that indicates the flat amount charge of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "rangeResource":"curriculumItems",
                "facetDiscriminatorName":"CurriculumType",
                "precision":38,
                "sortNumber":"90",
                "stepPct":"20",
                "facetControl":"rangeSlider",
                "scale":2,
                "rangeAttribute":"FlatAmount",
                "title":"Cost",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the format, such as online, of the curriculum item. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "sortNumber":"30",
                "facetControl":"multiSelect",
                "title":"Format",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "scheduledCourse":{
            "title":"Scheduled Courses",
            "type":"array",
            "description":"The scheduled course resource is a child of the curriculum items resource and provides the information for a scheduled course curriculum item.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-scheduledCourse-item-response"
            },
            "x-cardinality":"1"
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated unique identifier of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Subject",
            "type":"integer",
            "description":"The unique identifier for the academic subject of the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "controlType":"choice",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"40",
                "facetControl":"multiSelect",
                "title":"Subject Code",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier for a reporting period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "filter":"?finder=PeriodCategoryCodeAndDateTimeCodeFinder;ReportingPeriodCategoryCode=ORA_R,AcademicPeriodCategoryCode=ORA_A,DateTimeValue={{curr_date}},FirstDateDttmCode=FIRSTDTTOSC,LastDateDttmCode=LASTDTTOSC",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "controlType":"choice",
                "facetDiscriminatorName":"CurriculumType",
                "precision":18,
                "sortNumber":"26",
                "facetControl":"multiSelect",
                "title":"Academic Period",
                "queryType":"q"
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"A numeric value indicating the maximum units of the course curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of a curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Offering Storefronts

Type: array

Title: Offering Storefronts

The offering storefronts resource is a child of the curriculum items resource and provides a list of offering storefronts associated with a curriculum item.

Show Source

• Array of: object curriculumItems-offeringStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"The offering storefronts resource is a child of the curriculum items resource and provides a list of offering storefronts associated with a curriculum item.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-offeringStorefronts-item-response"
    }
}

Nested Schema : Programs

Type: array

Title: Programs

The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.

Show Source

• Array of: object curriculumItems-program-item-response

{
    "title":"Programs",
    "type":"array",
    "description":"The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Scheduled Courses

Type: array

Title: Scheduled Courses

The scheduled course resource is a child of the curriculum items resource and provides the information for a scheduled course curriculum item.

Show Source

• Array of: object curriculumItems-scheduledCourse-item-response

{
    "title":"Scheduled Courses",
    "type":"array",
    "description":"The scheduled course resource is a child of the curriculum items resource and provides the information for a scheduled course curriculum item.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-scheduledCourse-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Unscheduled Course Offerings

Type: array

Title: Unscheduled Course Offerings

The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.

Show Source

• Array of: object curriculumItems-unscheduledCourseOffering-item-response

{
    "title":"Unscheduled Course Offerings",
    "type":"array",
    "description":"The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : curriculumItems-offeringStorefronts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StorefrontId: integer (int64)
  Title: Storefront ID

  Read Only: true

  The unique identifier for the offering storefront.
• StorefrontName: string
  Title: Storefront Name

  Read Only: true

  The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-program-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level that is associated with a program.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level that is associated with a program.
• AdmissionRequiredFlag: boolean
  Title: Admission Required

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether admission is required for the program.
• CampusId: integer
  Title: Campus ID

  Read Only: true

  The unique identifier for a campus that is associated with a program.
• CampusName: string
  Title: Name

  Read Only: true

  The name of the campus associated with the program.
• CredentialId: integer
  Title: Program Credential ID

  Read Only: true

  The unique identifier of the credential associated with the program.
• CredentialName: string
  Title: Name

  Read Only: true

  The name of the credential associated with the program.
• CreditTypeCode: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 30

  The unique identifier for the type of credit associated with the program. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit of the program. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CurriculumFormatCode: string
  Title: Format

  Read Only: true

  Maximum Length: 30

  The code for the format of the program. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumFormatMeaning: string
  Title: Curriculum Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the program. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated identifier of the program.
• CurriculumLongDescription: string
  Title: Long Description

  Read Only: true

  The description of the program.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the program.
• CurriculumStatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The unique identifier of the status of the program.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of the program.
• EnforceRequirementSequenceFlag: boolean
  Title: List by Sequence

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates how to enforce requirements for the program.
• FirstAdmitDate: string (date)
  Title: First Admit Date

  Read Only: true

  The first date when students can be admitted into the program.
• images: array Images
  Title: Images

  The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.
• InstitutionId: integer (int64)
  Title: Institution

  Read Only: true

  The identifier for the institution to which the program belongs.
• IsCartableFlag: boolean
  Title: Shopping Cart Enabled

  Read Only: true

  Maximum Length: 255

  Indicates whether the program can be added to the shopping cart. The default value is true.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Maximum Length: 255

  Indicates whether the program can be added to the wish list. The default value is true.
• LastAdmitDate: string (date)
  Title: Last Admit Date

  Read Only: true

  The last date when students can be admitted into the program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumTimespanMeasure: string
  Title: Maximum Duration

  Read Only: true

  Maximum Length: 30

  A unit of measure for the maximum length of time allowed to complete the program.
• MaximumTimespanMeasureMeaning: string
  Title: Maximum Duration Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the unit of measure for the maximum length of time allowed to complete the program.
• MaximumTimespanQuantity: integer
  Title: Maximum Duration Quantity

  Read Only: true

  A quantity, which, along with the unit of measure, defines the maximum length of time allowed to complete the program.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

  The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.
• offeringCredentials: array Offering Credentials
  Title: Offering Credentials

  The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
• parameters: array Parameters
  Title: Parameters

  The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  The unique identifier for a program type that is associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main Program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The name of a program type that is associated with a program.
• tags: array Tags
  Title: Tags

  The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.
• TypicalTimespanMeasure: string
  Title: Duration Measurement

  Read Only: true

  Maximum Length: 30

  A numeric value which indicates the typical length of the program.
• TypicalTimespanMeasureMeaning: string
  Title: Typical Time Span

  Read Only: true

  Maximum Length: 80

  The unit value of the time span associated with the length of the program.
• TypicalTimespanQuantity: integer
  Title: Typical Duration

  Read Only: true

  The numeric value, along with time span, used to capture the typical length of the program.
• URLAddress: string
  Title: URL Address

  Read Only: true

  The URL for a webpage associated with a program.

{
    "type":"object",
    "properties":{
        "CredentialId":{
            "title":"Program Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCredentials":{
            "title":"Offering Credentials",
            "type":"array",
            "description":"The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-offeringCredentials-item-response"
            }
        },
        "LastAdmitDate":{
            "title":"Last Admit Date",
            "type":"string",
            "description":"The last date when students can be admitted into the program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the campus associated with the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit of the program. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypicalTimespanMeasure":{
            "title":"Duration Measurement",
            "maxLength":30,
            "type":"string",
            "description":"A numeric value which indicates the typical length of the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main Program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceRequirementSequenceFlag":{
            "title":"List by Sequence",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates how to enforce requirements for the program.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "URLAddress":{
            "title":"URL Address",
            "type":"string",
            "description":"The URL for a webpage associated with a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level that is associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the program can be added to the shopping cart. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level that is associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":50,
            "type":"string",
            "description":"The name of a program type that is associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmissionRequiredFlag":{
            "title":"Admission Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether admission is required for the program.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-images-item-response"
            }
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the program. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypicalTimespanQuantity":{
            "title":"Typical Duration",
            "type":"integer",
            "description":"The numeric value, along with time span, used to capture the typical length of the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The identifier for the institution to which the program belongs.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the credential associated with the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanQuantity":{
            "title":"Maximum Duration Quantity",
            "type":"integer",
            "description":"A quantity, which, along with the unit of measure, defines the maximum length of time allowed to complete the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypicalTimespanMeasureMeaning":{
            "title":"Typical Time Span",
            "maxLength":80,
            "type":"string",
            "description":"The unit value of the time span associated with the length of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "tags":{
            "title":"Tags",
            "type":"array",
            "description":"The tags resource is a child of the  unscheduled course offering resource and provides a list of tags associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-tags-item-response"
            }
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":30,
            "type":"string",
            "description":"The code for the format of the program. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the status of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated identifier of the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that is associated with a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the type of credit associated with the program. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the program can be added to the wish list. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanMeasure":{
            "title":"Maximum Duration",
            "maxLength":30,
            "type":"string",
            "description":"A unit of measure for the maximum length of time allowed to complete the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanMeasureMeaning":{
            "title":"Maximum Duration Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the unit of measure for the maximum length of time allowed to complete the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for a campus that is associated with a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the  unscheduled course offering resource and provides a list of campuses associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-offeringCampuses-item-response"
            }
        },
        "FirstAdmitDate":{
            "title":"First Admit Date",
            "type":"string",
            "description":"The first date when students can be admitted into the program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "parameters":{
            "title":"Parameters",
            "type":"array",
            "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-parameters-item-response"
            }
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-program-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Offering Campuses

Type: array

Title: Offering Campuses

The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-program-offeringCampuses-item-response

{
    "title":"Offering Campuses",
    "type":"array",
    "description":"The offering campuses resource is a child of the  unscheduled course offering resource and provides a list of campuses associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-offeringCampuses-item-response"
    }
}

Nested Schema : Offering Credentials

Type: array

Title: Offering Credentials

The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.

Show Source

• Array of: object curriculumItems-program-offeringCredentials-item-response

{
    "title":"Offering Credentials",
    "type":"array",
    "description":"The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-offeringCredentials-item-response"
    }
}

Nested Schema : Parameters

Type: array

Title: Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Show Source

• Array of: object curriculumItems-program-parameters-item-response

{
    "title":"Parameters",
    "type":"array",
    "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-parameters-item-response"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-program-tags-item-response

{
    "title":"Tags",
    "type":"array",
    "description":"The tags resource is a child of the  unscheduled course offering resource and provides a list of tags associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-tags-item-response"
    }
}

Nested Schema : curriculumItems-program-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The content associated with an attachment in the attachment framework (such as a document or image).
• ImageContextCode: string
  Title: Curriculum Attachment Context

  Read Only: true

  Maximum Length: 30

  The context or usage of a curriculum item attachment file.
• ImageId: integer (int64)
  Title: Curriculum Attachment ID

  Read Only: true

  The unique identifier for an attachment associated with a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"The unique identifier for an attachment associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content associated with an attachment in the attachment framework (such as a document or image).",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Curriculum Attachment Context",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of a curriculum item attachment file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-program-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where a program or course is offered.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where a program or course is offered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where a program or course is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CampusIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"100",
                "facetControl":"multiSelect",
                "title":"Campus",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where a program or course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-program-offeringCredentials-item-response

Type: object

Show Source

• CredentialDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  A sequence number that overrides the default sort order for a program's credentials.
• CredentialFormalName: string
  Read Only: true

  Maximum Length: 100

  The formal name of the credential.
• CredentialId: integer (int64)
  Title: Credential

  Read Only: true

  The unique identifier for a credential value that is associated with a program.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential.
• FinalCredentialFlag: boolean
  Title: Final Credential

  Read Only: true

  Maximum Length: 1

  An indicator that identifies a credential as the final or maximum credential available for a program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FinalCredentialFlag":{
            "title":"Final Credential",
            "maxLength":1,
            "type":"boolean",
            "description":"An indicator that identifies a credential as the final or maximum credential available for a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CredentialDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for a program's credentials.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CredentialFormalName":{
            "maxLength":100,
            "type":"string",
            "description":"The formal name of the credential.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Credential",
            "type":"integer",
            "description":"The unique identifier for a credential value that is associated with a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-program-parameters-item-response

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  Read Only: true

  Default Value: 0

  The number of contact hours required to satisfy a program parameter.
• DisplaySequenceNumber: integer (int32)
  Title: Display Sequence

  Read Only: true

  A sequence number that overrides the default sort order for a program's child courses.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Number of Courses

  Read Only: true

  Default Value: 0

  The maximum number of courses that can be taken towards satisfying a program parameter.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Read Only: true

  Default Value: 0

  The maximum number of credits available for a program.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Number of Courses

  Read Only: true

  Default Value: 0

  The minimum number of courses that must be taken towards satisfying a program parameter.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Read Only: true

  Default Value: 0

  The minimum number of credits available for a program.
• ParameterSequenceNumber: integer (int32)
  Title: Parameter Sequence Number

  Read Only: true

  The sequence number for a program parameter row.
• RequirementCategoryCode: string
  Title: Requirement Category Code

  Read Only: true

  Maximum Length: 30

  A code that categorizes program course requirements.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  Read Only: true

  The unique identifier for a requirement category code assigned to a program parameter.
• RequirementCategoryName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the requirement category code.

{
    "type":"object",
    "properties":{
        "MaximumCoursesQuantity":{
            "title":"Maximum Number of Courses",
            "type":"integer",
            "description":"The maximum number of courses that can be taken towards satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParameterSequenceNumber":{
            "title":"Parameter Sequence Number",
            "type":"integer",
            "description":"The sequence number for a program parameter row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required to satisfy a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for a requirement category code assigned to a program parameter.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplaySequenceNumber":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for a program's child courses.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the requirement category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses that must be taken towards satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":30,
            "type":"string",
            "description":"A code that categorizes program course requirements.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-program-tags-item-response

Type: object

Show Source

• CurriculumTagContextCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.
• CurriculumTagId: integer (int64)
  Title: Curriculum Tag ID

  Read Only: true

  The generated primary key column for a curriculum tag.
• CurriculumTagName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the curriculum tag.
• CurriculumTagNameCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag.
• CurriculumTagNameId: integer (int64)
  Title: Curriculum Tag Name ID

  Read Only: true

  The unique identifier for a curriculum tag name that has been associated with a curriculum item.
• CurriculumTagValue: string
  Title: Tag Value

  Read Only: true

  Maximum Length: 50

  The name of the curriculum tag value.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag value.
• CurriculumTagValueId: integer (int64)
  Title: Curriculum Tag Value ID

  Read Only: true

  The unique identifier for a curriculum tag value that has been associated with a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurriculumTagNameCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagValueId":{
            "title":"Curriculum Tag Value ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum tag value that has been associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CurriculumTagValueIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"20",
                "facetControl":"multiSelect",
                "title":"Area of Study",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CurriculumTagId":{
            "title":"Curriculum Tag ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumTagContextCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the curriculum tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagValueCode":{
            "title":"Tag Value Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumTagValue":{
            "title":"Tag Value",
            "maxLength":50,
            "type":"string",
            "description":"The name of the curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagNameId":{
            "title":"Curriculum Tag Name ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum tag name that has been associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-scheduledCourse-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level value that is associated with a course.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level, such as undergraduate, that is associated with a course.
• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The unique identifier of the academic organization of the scheduled course.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  A code for an academic subject.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier of academic subject of the scheduled course.
• AcademicSubjectName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the academic subject.
• BuildingName: string
  Title: Name

  Read Only: true

  The name of the building associated with the meeting pattern of the scheduled course.
• BuildingShortCode: string
  Title: Code

  Read Only: true

  The unique identifier of the building associated with the meeting pattern of the scheduled course.
• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where a course is offered.
• CampusName: string
  Title: Campus

  Read Only: true

  Maximum Length: 50

  The campus where the scheduled course is offered.
• ConsentTypeCode: string
  Title: Permission Type

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_NOT_REQUIRED

  The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.
• ConsentTypeMeaning: string
  Title: Consent Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
• CoursePayToEnrollFlag: boolean
  Title: Pay to enroll

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the student must pay for the course at the time of enrollment. The default value is false.
• CredentialId: integer (int64)
  Title: Scheduled Course Credential ID

  Read Only: true

  The unique identifier of the credential associated with the course.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the scheduled course.
• CredentialTypeCode: string
  Title: Credential Type

  Read Only: true

  Maximum Length: 30

  The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.
• CreditTypeCode: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 30

  The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the scheduled course.
• CurriculumFormatCode: string
  Title: Format

  Read Only: true

  Maximum Length: 30

  The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumFormatMeaning: string
  Title: Curriculum Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumHeaderId: integer (int64)
  Title: Curriculum Header ID

  Read Only: true

  The unique identifier for a scheduled course header record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated identifier of the scheduled course.
• CurriculumLongDescription: string
  Title: Long Description

  Read Only: true

  The description of the scheduled course.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the scheduled course.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of the scheduled course.
• EnrollConsentRequiredFlag: boolean
  Title: Permission required to enroll

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.
• EnrollmentCapacityQuantity: integer (int32)
  Title: Enrollment Capacity

  Read Only: true

  A numeric value indicating the enrollment capacity of the scheduled course.
• EnrollmentStatusCode: string
  Title: Enrollment Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_OPN

  The code for the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
• EnrollmentStatusMeaning: string
  Title: Enrollment Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
• FacilityDescription: string
  Title: Description

  Read Only: true

  The description of the facility.
• FacilityRoomNumber: string
  Title: Room Number

  Read Only: true

  The room number associated with the meeting pattern of the scheduled course.
• FacilityShortCode: string
  Title: Facility

  Read Only: true

  The identifier of the facility associated with the meeting pattern of the scheduled course.
• FlatAmount: number
  Title: Flat Amount

  Read Only: true

  The numeric value that indicates the flat amount charge of a scheduled course.
• FlatAmountCurrencyCode: string
  Title: Currency Code

  Read Only: true

  The unique identifier of the flat amount charge of a scheduled course.
• FlatAmountCurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  The denomination of the flat amount charge of a scheduled course.
• images: array Images
  Title: Images

  The images resource is a child of the scheduled course resource and provides a list of image attachments associated with a scheduled course.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier for the institution where the scheduled course is offered.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution where the scheduled course is offered.
• InstructorName: string
  Title: Name

  Read Only: true

  The name of the instructor of the scheduled course.
• IsCartableFlag: boolean
  Title: Shopping Cart Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
• IsSchedulableFlag: boolean
  Title: Scheduler Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the scheduler. The default value is true.
• IsSelfPacedFlag: boolean
  Title: Self-Paced

  Read Only: true

  Indicates whether the scheduled course is self-paced. The default value is false.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Indicates whether the scheduled course can be added to the wish list. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationControlCode: string
  Title: Location Control Code

  Read Only: true

  The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The latitude of the location associated with the meeting pattern of the scheduled course.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The longitude of the location associated with the meeting pattern of the scheduled course.
• LocationLongName: string
  Title: Location Long Name

  Read Only: true

  The name of the single use location associated with the meeting pattern of the scheduled course.
• MapIntegrationURL: string
  Title: Map Integration URL

  Read Only: true

  The uniform resource locator of the map application to be used for displaying scheduled course meeting location.
• MaximumUnitsQuantity: number
  Title: Maximum Units

  Read Only: true

  A numeric value indicating the maximum units of the scheduled course.
• MeetingPatternDescription: string
  Title: Pattern Name

  Read Only: true

  The name of the meeting pattern of the scheduled course.
• MeetingPatternEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the meeting pattern of the scheduled course ends.
• MeetingPatternEndTime: string (date-time)
  Title: End Time

  Read Only: true

  The time when the meeting pattern of the scheduled course ends.
• meetingPatterns: array Meeting Patterns
  Title: Meeting Patterns

  The meeting patterns resource is a child of the scheduled course resource and provides a list of meeting patterns associated with a scheduled course.
• MeetingPatternStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the meeting pattern of the scheduled course starts.
• MeetingPatternStartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The time when the meeting pattern of the scheduled course starts.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  A numeric value indicating the minimum units of the scheduled course.
• OwningCurriculumId: integer (int64)
  Title: Owning Curriculum ID

  Read Only: true

  The unique identifier for the parent curriculum item of the scheduled course.
• OwningCurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name for the parent curriculum item of the scheduled course.
• OwningOfferNumber: integer (int32)
  Title: Owning Offer Number

  Read Only: true

  The unique identifier for the parent curriculum item offer number of the scheduled course.
• ReportingPeriodEndDate: string (date)
  Title: Reporting Period End Date

  Read Only: true

  The date when the reporting period associated with the scheduled course ends.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier for the reporting period associated with the scheduled course.
• ReportingPeriodName: string
  Title: Reporting Period

  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with the scheduled course.
• ReportingPeriodStartDate: string (date)
  Title: Reporting Period Start Date

  Read Only: true

  The date when the reporting period associated with the scheduled course starts.
• ScheduledCourseCode: string
  Title: Scheduled Course Code

  Read Only: true

  Maximum Length: 30

  The code used to identify a scheduled course within a given course and academic period.
• ScheduledCourseEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The date when the scheduled course ends.
• ScheduledCourseNumber: integer (int32)
  Title: Scheduled Course Number

  Read Only: true

  A generated unique key for a scheduled course.
• ScheduledCourseStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when the scheduled course starts.
• StudentRequestConsentFlag: boolean
  Title: Allow permission request

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.
• TotalEnrolledQuantity: integer (int32)
  Title: Total Enrolled

  Read Only: true

  A numeric value indicating the number of enrollments in the scheduled course.
• URLAddress: string
  Title: URL Address

  Read Only: true

  The unique URL address of the scheduled course.

{
    "type":"object",
    "properties":{
        "OwningCurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name for the parent curriculum item of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Owning Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item of the scheduled course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ConsentTypeMeaning":{
            "title":"Consent Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentCapacityQuantity":{
            "title":"Enrollment Capacity",
            "type":"integer",
            "description":"A numeric value indicating the enrollment capacity of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MapIntegrationURL":{
            "title":"Map Integration URL",
            "type":"string",
            "description":"The uniform resource locator of the map application to be used for displaying scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level value that is associated with a course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoursePayToEnrollFlag":{
            "title":"Pay to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the student must pay for the course at the time of enrollment. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the shopping cart. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CartEnabledFlag"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsSelfPacedFlag":{
            "title":"Self-Paced",
            "type":"boolean",
            "description":"Indicates whether the scheduled course is self-paced. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningOfferNumber":{
            "title":"Owning Offer Number",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item offer number of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ConsentTypeCode":{
            "title":"Permission Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_NOT_REQUIRED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "meetingPatterns":{
            "title":"Meeting Patterns",
            "type":"array",
            "description":"The meeting patterns resource is a child of the scheduled course resource and provides a list of meeting patterns associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-scheduledCourse-meetingPatterns-item-response"
            }
        },
        "FlatAmountCurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The denomination of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the scheduled course resource and provides a list of image attachments associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-scheduledCourse-images-item-response"
            }
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier of the academic organization of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the institution where the scheduled course is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalEnrolledQuantity":{
            "title":"Total Enrolled",
            "type":"integer",
            "description":"A numeric value indicating the number of enrollments in the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Scheduled Course Code",
            "maxLength":30,
            "type":"string",
            "description":"The code used to identify a scheduled course within a given course and academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSchedulableFlag":{
            "title":"Scheduler Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the scheduler. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated identifier of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier of academic subject of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialTypeCode":{
            "title":"Credential Type",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Scheduled Course Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuildingName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":50,
            "type":"string",
            "description":"The campus where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmountCurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "URLAddress":{
            "title":"URL Address",
            "type":"string",
            "description":"The unique URL address of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseNumber":{
            "title":"Scheduled Course Number",
            "type":"integer",
            "description":"A generated unique key for a scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level, such as undergraduate, that is associated with a course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructorName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the instructor of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the facility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The unique identifier for a scheduled course header record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StudentRequestConsentFlag":{
            "title":"Allow permission request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollConsentRequiredFlag":{
            "title":"Permission required to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Flat Amount",
            "type":"number",
            "description":"The numeric value that indicates the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":30,
            "type":"string",
            "description":"The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"A code for an academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentStatusCode":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"The code for the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_OPN",
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the wish list. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where a course is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier for the reporting period associated with the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"A numeric value indicating the maximum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of the scheduled course resource and provides a list of image attachments associated with a scheduled course.

Show Source

• Array of: object curriculumItems-scheduledCourse-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the scheduled course resource and provides a list of image attachments associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-scheduledCourse-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Meeting Patterns

Type: array

Title: Meeting Patterns

The meeting patterns resource is a child of the scheduled course resource and provides a list of meeting patterns associated with a scheduled course.

Show Source

• Array of: object curriculumItems-scheduledCourse-meetingPatterns-item-response

{
    "title":"Meeting Patterns",
    "type":"array",
    "description":"The meeting patterns resource is a child of the scheduled course resource and provides a list of meeting patterns associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-scheduledCourse-meetingPatterns-item-response"
    }
}

Nested Schema : curriculumItems-scheduledCourse-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The content associated with an attachment in the attachment framework (such as a document or image).
• ImageContextCode: string
  Title: Curriculum Attachment Context

  Read Only: true

  Maximum Length: 30

  The context or usage of a curriculum item attachment file.
• ImageId: integer (int64)
  Title: Curriculum Attachment ID

  Read Only: true

  The unique identifier for an attachment associated with a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"The unique identifier for an attachment associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content associated with an attachment in the attachment framework (such as a document or image).",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Curriculum Attachment Context",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of a curriculum item attachment file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-scheduledCourse-meetingPatterns-item-response

Type: object

Show Source

• BuildingName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the building associated with the meeting pattern of the scheduled course.
• BuildingShortCode: string
  Title: Code

  Read Only: true

  Maximum Length: 6

  The unique identifier of the building associated with the meeting pattern of the scheduled course.
• CurriculumScheduleId: integer (int64)
  Read Only: true

  The generated primary key column for a meeting pattern of the scheduled course.
• DurationQuantity: integer (int32)
  Title: Duration

  Read Only: true

  The numeric value that indicates the length of a meeting of the scheduled course.
• FacilityDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the meeting pattern of the scheduled course.
• FacilityRoomNumber: string
  Title: Room Number

  Read Only: true

  Maximum Length: 10

  The room number associated with the meeting pattern of the scheduled course.
• FacilityShortCode: string
  Title: Facility

  Read Only: true

  Maximum Length: 20

  The identifier of the facility associated with the meeting pattern of the scheduled course.
• InstructionalMethodCode: string
  Read Only: true

  Maximum Length: 30

  The instructional method code of the meeting.
• InstructionalMethodMeaning: string
  Read Only: true

  Maximum Length: 80

  The instructional method meaning of the meeting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationControlCode: string
  Title: Location Control Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_USE_FACILITY

  The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The GPS latitude coordinates for the scheduled course meeting location.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The GPS longitude coordinates for the scheduled course meeting location.
• LocationLongName: string
  Title: Location Long Name

  Read Only: true

  The name of the single use location associated with the meeting pattern of the scheduled course.
• MeetingPatternDescription: string
  Title: Pattern Name

  Read Only: true

  Maximum Length: 50

  The name of the meeting pattern of the scheduled course.
• MeetingPatternEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the meeting pattern of the scheduled course ends.
• MeetingPatternEndTime: string (date-time)
  Title: End Time

  Read Only: true

  The time when the meeting pattern of the scheduled course ends.
• MeetingPatternName: string
  Title: Meeting Name

  Read Only: true

  Maximum Length: 50

  The meeting name of the course scheduled in the facility.
• MeetingPatternStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the meeting pattern of the scheduled course starts.
• MeetingPatternStartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The time when the meeting pattern of the scheduled course starts.
• RecurrenceDayFriFlag: boolean
  Title: Friday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Friday.
• RecurrenceDayMonFlag: boolean
  Title: Monday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Monday.
• RecurrenceDaySatFlag: boolean
  Title: Saturday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Saturday.
• RecurrenceDaySunFlag: boolean
  Title: Sunday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Sunday.
• RecurrenceDayThuFlag: boolean
  Title: Thursday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Thursday.
• RecurrenceDayTueFlag: boolean
  Title: Tuesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Tuesday.
• RecurrenceDayWedFlag: boolean
  Title: Wednesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The unique identifier for the day of the week Wednesday.
• ScheduleSequenceNumber: integer (int32)
  Title: Schedule Sequence Number

  Read Only: true

  The sequence identifier of the meeting pattern of the scheduled course.

{
    "type":"object",
    "properties":{
        "InstructionalMethodMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The instructional method meaning of the meeting.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleSequenceNumber":{
            "title":"Schedule Sequence Number",
            "type":"integer",
            "description":"The sequence identifier of the meeting pattern of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDayTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Tuesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Tuesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnTue",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "BuildingName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionalMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The instructional method code of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The GPS latitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "RecurrenceDayWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Wednesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Wednesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnWed",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":10,
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDaySunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Sunday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Sunday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSun",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDayFriFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Friday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Friday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnFri",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumScheduleId":{
            "type":"integer",
            "description":"The generated primary key column for a meeting pattern of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DurationQuantity":{
            "title":"Duration",
            "type":"integer",
            "description":"The numeric value that indicates the length of a meeting of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MeetingPatternName":{
            "title":"Meeting Name",
            "maxLength":50,
            "type":"string",
            "description":"The meeting name of the course scheduled in the facility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDaySatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Saturday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Saturday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSat",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_USE_FACILITY",
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDayMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Monday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Monday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnMon",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Thursday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Thursday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnThu",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "title":"Day of the Week",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"TimeFrom-TimeTo",
                "customLinks":"true",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"80",
                "facetControl":"timeRange",
                "title":"Time",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The GPS longitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "maxLength":6,
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-unscheduledCourseOffering-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier of the academic level associated with the offering.
• AcademicLevelName: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 100

  The name of the academic level associated with the offering.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The code for the course's academic subject.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for the course's academic subject.
• AcademicSubjectName: string
  Title: Subject

  Read Only: true

  Maximum Length: 50

  The name of the course's academic subject.
• ClosestScheduledCourseId: integer
  Title: Closest Scheduled ID

  Read Only: true

  The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.
• CredentialId: integer (int64)
  Title: Course Offering Credential ID

  Read Only: true

  The unique identifier of the credential associated with the course.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the course.
• CreditTypeCode: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 30

  The code for the type of credit attached to a course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CreditTypeMeaning: string
  Title: Type of Credit Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit attached to a course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number associated with the course.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The unique identifier for a curriculum item such as a course.
• images: array Images
  Title: Images

  The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.
• InstitutionId: integer (int64)
  Title: Institution

  Read Only: true

  The unique identifier for the institution that owns the course.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Indicates whether the course can be added to the wish list. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

  The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.
• OfferSequenceNumber: integer (int32)
  Title: Offer Number

  Read Only: true

  The unique sort identifier for the offering of the curriculum item.
• ScheduledCourseCount: integer
  Title: Scheduled Course Count

  Read Only: true

  The number of scheduled instances of a course that are available for enrollment as of the current date.
• tags: array Tags
  Title: Tags

  The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number associated with the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-images-item-response"
            }
        },
        "CredentialId":{
            "title":"Course Offering Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The unique identifier for the institution that owns the course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit attached to a course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "tags":{
            "title":"Tags",
            "type":"array",
            "description":"The tags resource is a child of the  unscheduled course offering resource and provides a list of tags associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-tags-item-response"
            }
        },
        "OfferSequenceNumber":{
            "title":"Offer Number",
            "type":"integer",
            "description":"The unique sort identifier for the offering of the curriculum item.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum item such as a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ClosestScheduledCourseId":{
            "title":"Closest Scheduled ID",
            "type":"integer",
            "description":"The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier of the academic level associated with the offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credit attached to a course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the course's academic subject.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "type":"boolean",
            "description":"Indicates whether the course can be added to the wish list. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject",
            "maxLength":50,
            "type":"string",
            "description":"The name of the course's academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level associated with the offering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the  unscheduled course offering resource and provides a list of campuses associated with a  unscheduled course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-offeringCampuses-item-response"
            }
        },
        "ScheduledCourseCount":{
            "title":"Scheduled Course Count",
            "type":"integer",
            "description":"The number of scheduled instances of a course that are available for enrollment as of the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-unscheduledCourseOffering-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Offering Campuses

Type: array

Title: Offering Campuses

The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-unscheduledCourseOffering-offeringCampuses-item-response

{
    "title":"Offering Campuses",
    "type":"array",
    "description":"The offering campuses resource is a child of the  unscheduled course offering resource and provides a list of campuses associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-offeringCampuses-item-response"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering.

Show Source

• Array of: object curriculumItems-unscheduledCourseOffering-tags-item-response

{
    "title":"Tags",
    "type":"array",
    "description":"The tags resource is a child of the  unscheduled course offering resource and provides a list of tags associated with a  unscheduled course offering.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-unscheduledCourseOffering-tags-item-response"
    }
}

Nested Schema : curriculumItems-unscheduledCourseOffering-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The content associated with an attachment in the attachment framework (such as a document or image).
• ImageContextCode: string
  Title: Curriculum Attachment Context

  Read Only: true

  Maximum Length: 30

  The context or usage of a curriculum item attachment file.
• ImageId: integer (int64)
  Title: Curriculum Attachment ID

  Read Only: true

  The unique identifier for an attachment associated with a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"The unique identifier for an attachment associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content associated with an attachment in the attachment framework (such as a document or image).",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Curriculum Attachment Context",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of a curriculum item attachment file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-unscheduledCourseOffering-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where a program or course is offered.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where a program or course is offered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where a program or course is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CampusIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"100",
                "facetControl":"multiSelect",
                "title":"Campus",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where a program or course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : curriculumItems-unscheduledCourseOffering-tags-item-response

Type: object

Show Source

• CurriculumTagContextCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.
• CurriculumTagId: integer (int64)
  Title: Curriculum Tag ID

  Read Only: true

  The generated primary key column for a curriculum tag.
• CurriculumTagName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the curriculum tag.
• CurriculumTagNameCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag.
• CurriculumTagNameId: integer (int64)
  Title: Curriculum Tag Name ID

  Read Only: true

  The unique identifier for a curriculum tag name that has been associated with a curriculum item.
• CurriculumTagValue: string
  Title: Tag Value

  Read Only: true

  Maximum Length: 50

  The name of the curriculum tag value.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag value.
• CurriculumTagValueId: integer (int64)
  Title: Curriculum Tag Value ID

  Read Only: true

  The unique identifier for a curriculum tag value that has been associated with a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurriculumTagNameCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagValueId":{
            "title":"Curriculum Tag Value ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum tag value that has been associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CurriculumTagValueIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"20",
                "facetControl":"multiSelect",
                "title":"Area of Study",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CurriculumTagId":{
            "title":"Curriculum Tag ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumTagContextCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the curriculum tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagValueCode":{
            "title":"Tag Value Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumTagValue":{
            "title":"Tag Value",
            "maxLength":50,
            "type":"string",
            "description":"The name of the curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagNameId":{
            "title":"Curriculum Tag Name ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum tag name that has been associated with a curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top