Jump to

• Request
• Response

Get all course offerings

get

/fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings

Request

Path Parameters

• ElementId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• programsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Programs resource and used to uniquely identify an instance of Programs. The client should not generate the hash key value. Instead, the client should query on the Programs collection resource in order to navigate to a specific instance of Programs to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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:
  
  

  • PrimaryKey :Finds all course offerings that match the primary key criteria specified.
    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 of the academic level associated with offering.
  • AcademicLevelName; string; The name of the academic level associated with offering.
  • AcademicSubjectCode; string; The code for the course's academic subject.
  • AcademicSubjectId; integer; The meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
  • AcademicSubjectName; string; The name of the course's academic subject.
  • ClosestScheduledCourseId; integer; The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.
  • ConsentTypeCode; string; 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; The meaning of consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
  • CredentialId; integer; The unique identifier of the credential associated with the curriculum offering.
  • CredentialName; string; The name of the credential associated with the course.
  • CreditTypeCode; string; The code for the type of credit assigned 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; 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; The catalog number associated with the course.
  • CurriculumHeaderId; integer; The generated primary key column for a curriculum record.
  • CurriculumId; integer; The generated primary key column for a curriculum offering.
  • EnrollConsentRequiredFlag; boolean; Indicates that a student must obtain consent to enroll in the curriculum item. The default value is false.
  • InstitutionId; integer; The unique identifier for the institution on the offering of the course.
  • InstitutionName; string; The name of the institution to which the course offering belongs.
  • IsWishableFlag; boolean; Indicates whether the course can be added to the wish list. The default value is true.
  • OfferSequenceNumber; integer; The unique sort identifier for the offering of the course.
  • RepeatAllowedFlag; boolean; Indicates whether a course can be repeated. The default value is false.
  • RepeatAllowedTotal; integer; The total number of times a student can complete a course that's repeatable.
  • RepeatInPeriodFlag; boolean; Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.
  • RepeatUnitsTotal; number; The maximum number of credits that a student can receive for multiple completions of a repeatable course.
  • ScheduledCourseCount; integer; The number of scheduled instances of a course that are available for enrollment as of the current date.
  • StudentRequestConsentFlag; boolean; Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is false.
  • TypicallyOfferedCode; string; The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
  • TypicallyOfferedMeaning; string; The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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:
  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.

Body ()

Root Schema : programs-programElements-courseOfferings

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/programs-programElements-courseOfferings-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object programs-programElements-courseOfferings-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-item-response"
    },
    "x-cardinality":"1"
}

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 : programs-programElements-courseOfferings-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 offering.
• AcademicLevelName: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 100

  The name of the academic level associated with 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 meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
• 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.
• 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 consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
• CredentialId: integer (int64)
  Title: Course Offering Credential ID

  Read Only: true

  The unique identifier of the credential associated with the curriculum offering.
• 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 assigned 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.
• CurriculumHeaderId: integer (int64)
  Title: Curriculum Header ID

  Read Only: true

  The generated primary key column for a curriculum record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated primary key column for a curriculum offering.
• 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 false.
• InstitutionId: integer (int64)
  Title: Institution

  Read Only: true

  The unique identifier for the institution on the offering of the course.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution to which the course offering belongs.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Indicates whether the 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.
• offeringAcademicOrganizations: array Offering Academic Organizations
  Title: Offering Academic Organizations

  The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

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

  Read Only: true

  The unique sort identifier for the offering of the course.
• RepeatAllowedFlag: boolean
  Title: Repeatable

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether a course can be repeated. The default value is false.
• RepeatAllowedTotal: integer (int32)
  Title: Total Completions Allowed

  Read Only: true

  The total number of times a student can complete a course that's repeatable.
• RepeatInPeriodFlag: boolean
  Title: Allow multiple enrollment

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.
• RepeatUnitsTotal: number
  Title: Total Units Allowed

  Read Only: true

  The maximum number of credits that a student can receive for multiple completions of a repeatable course.
• 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.
• 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 false.
• TypicallyOfferedCode: string
  Title: Typically Offered

  Read Only: true

  Maximum Length: 30

  The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
• TypicallyOfferedMeaning: string
  Title: Typically Offered Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.

{
    "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
        },
        "ConsentTypeMeaning":{
            "title":"Consent Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of 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
        },
        "CredentialId":{
            "title":"Course Offering Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the curriculum offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepeatInPeriodFlag":{
            "title":"Allow multiple enrollment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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
        },
        "RepeatUnitsTotal":{
            "title":"Total Units Allowed",
            "type":"number",
            "description":"The maximum number of credits that a student can receive for multiple completions of a repeatable course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "TypicallyOfferedMeaning":{
            "title":"Typically Offered Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatAllowedFlag":{
            "title":"Repeatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a course can be repeated. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier of the academic level associated with offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepeatAllowedTotal":{
            "title":"Total Completions Allowed",
            "type":"integer",
            "description":"The total number of times a student can complete a course that's repeatable.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the course's academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the academic level associated with offering.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "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
        },
        "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
        },
        "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 false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the institution to which the course offering belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The unique identifier for the institution on the offering of the course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TypicallyOfferedCode":{
            "title":"Typically Offered",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.",
            "nullable":true,
            "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 false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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
        },
        "OfferSequenceNumber":{
            "title":"Offer Number",
            "type":"integer",
            "description":"The unique sort identifier for the offering of the course.",
            "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 generated primary key column for a curriculum offering.",
            "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
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the type of credit assigned 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 meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.",
            "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 true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringCampuses-item-response"
            }
        },
        "offeringAcademicOrganizations":{
            "title":"Offering Academic Organizations",
            "type":"array",
            "description":"The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-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 Academic Organizations

Type: array

Title: Offering Academic Organizations

The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.

Show Source

• Array of: object programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response

{
    "title":"Offering Academic Organizations",
    "type":"array",
    "description":"The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response"
    }
}

Nested Schema : Offering Campuses

Type: array

Title: Offering Campuses

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

Show Source

• Array of: object programs-programElements-courseOfferings-offeringCampuses-item-response

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

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 : programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The academic organization that owns the curriculum item.
• AcademicOrgName: string
  Title: Academic Organization

  Read Only: true

  Maximum Length: 50

  The name of the academic organization associated with the offering.
• CurriculumOrgId: integer (int64)
  Title: Curriculum Organization ID

  Read Only: true

  The generated primary key column for an offering academic organization.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• offeringOrganizationStaff: array Offering Organization Staff
  Title: Offering Organization Staff

  The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

{
    "type":"object",
    "properties":{
        "offeringOrganizationStaff":{
            "title":"Offering Organization Staff",
            "type":"array",
            "description":"The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumOrgId":{
            "title":"Curriculum Organization ID",
            "type":"integer",
            "description":"The generated primary key column for an offering academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The academic organization that owns the curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the academic organization associated with the offering.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 Organization Staff

Type: array

Title: Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Show Source

• Array of: object programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response

{
    "title":"Offering Organization Staff",
    "type":"array",
    "description":"The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response"
    }
}

Nested Schema : programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response

Type: object

Show Source

• CurriculumStaffId: integer (int64)
  Title: Curriculum Staff ID

  Read Only: true

  The generated primary key column for a curriculum staff record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonAcademicTitle: string
  Title: Academic Title

  Read Only: true

  Maximum Length: 30

  The academic title of the program staff person.
• PersonImageContent: string (byte)
  Title: Staff Image

  Read Only: true

  The content of a staff attachment such as an image file.
• PersonImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  A unique identifier for an attachment associated with a program.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 450

  The name of a program staff person.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the program staff person.
• StaffBiography: string
  Title: Biography

  Read Only: true

  The text providing biographical or background information on a staff member.
• StaffPrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true.
• StaffRoleTypeCode: string
  Title: Role Type

  Read Only: true

  Maximum Length: 30

  The role type of the staff member associated with the course. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffRoleTypeMeaning: string
  Title: Role Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the role type of the staff member associated with the course. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffSequenceNumber: integer (int32)
  Title: Staff Sequence Number

  Read Only: true

  The sequence number of a staff row associated with a program.

{
    "type":"object",
    "properties":{
        "PersonImageContent":{
            "title":"Staff Image",
            "type":"string",
            "description":"The content of a staff attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of a program staff person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the role type of the staff member associated with the course. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffBiography":{
            "title":"Biography",
            "type":"string",
            "description":"The text providing biographical or background information on a staff member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffSequenceNumber":{
            "title":"Staff Sequence Number",
            "type":"integer",
            "description":"The sequence number of a staff row associated with a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PersonImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"A unique identifier for an attachment associated with a program.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "PersonAcademicTitle":{
            "title":"Academic Title",
            "maxLength":"30",
            "type":"string",
            "description":"The academic title of the program staff person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeCode":{
            "title":"Role Type",
            "maxLength":"30",
            "type":"string",
            "description":"The role type of the staff member associated with the course. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumStaffId":{
            "title":"Curriculum Staff ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum staff record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the program staff person.",
            "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 : programs-programElements-courseOfferings-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

  The name of the campus where a 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 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 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"
    }
}

Back to Top