Jump to

• Request
• Response

Update or create a scheduled item

patch

/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}

Request

Path Parameters

• schedulePeriodsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Schedule Periods resource and used to uniquely identify an instance of Schedule Periods. The client should not generate the hash key value. Instead, the client should query on the Schedule Periods collection resource in order to navigate to a specific instance of Schedule Periods to get the hash key.
• scheduledItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ScheduledItemId and CurriculumOptionId ---for the Scheduled Items resource and used to uniquely identify an instance of Scheduled Items. The client should not generate the hash key value. Instead, the client should query on the Scheduled Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Scheduled Items.
  
  For example: scheduledItems?q=ScheduledItemId=<value1>;CurriculumOptionId=<value2>
• studentScheduleByPeriodsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Schedule by Periods resource and used to uniquely identify an instance of Student Schedule by Periods. The client should not generate the hash key value. Instead, the client should query on the Student Schedule by Periods collection resource in order to navigate to a specific instance of Student Schedule by Periods to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AcademicLevelIdOption: integer (int64)
  Title: Academic Level ID Option

  The unique identifier for the academic level of the student enrolling in the course.
• ClassStartDateOption: string (date)
  Title: Class Start Date Option

  The requested start date for the self-paced course.
• CreditOptionFlag: boolean
  Title: Credit Option Flag

  Maximum Length: 1

  Default Value: false

  The type of credit the student is enrolling in.
• EnrolledCreditsOption: number
  Title: Enrolled Credit Units Option

  The number of credits the student wants to enroll in.
• EnrollmentRequestStatusCode: string
  Title: Enrollment Request Status

  Maximum Length: 30

  Default Value: ORA_SCHEDULED

  The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.
• GradingOptionCode: string
  Title: Grading Option Code

  Maximum Length: 30

  The grading method option selected by the student for enrollment.
• instructors: array Instructors
  Title: Instructors

  The instructors resource lists the instructors for the enrolled or scheduled items.
• ItemCurriculumId(required): integer (int64)
  Title: Item Curriculum ID

  The unique identifier of the course or course section that's scheduled.
• meetingPatterns: array Meeting Patterns
  Title: Meeting Patterns

  The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
• OfferSequenceNumber(required): integer (int64)
  Title: Course Offering Sequence Number

  The offering sequence number for the course.

{
    "required":[
        "ItemCurriculumId",
        "OfferSequenceNumber"
    ],
    "type":"object",
    "properties":{
        "AcademicLevelIdOption":{
            "title":"Academic Level ID Option",
            "type":"integer",
            "description":"The unique identifier for the academic level of the student enrolling in the course.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClassStartDateOption":{
            "title":"Class Start Date Option",
            "type":"string",
            "description":"The requested start date for the self-paced course.",
            "format":"date",
            "nullable":true
        },
        "CreditOptionFlag":{
            "title":"Credit Option Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The type of credit the student is enrolling in.",
            "nullable":false,
            "default":false
        },
        "EnrolledCreditsOption":{
            "title":"Enrolled Credit Units Option",
            "type":"number",
            "description":"The number of credits the student wants to enroll in.",
            "nullable":true
        },
        "EnrollmentRequestStatusCode":{
            "title":"Enrollment Request Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.",
            "nullable":false,
            "default":"ORA_SCHEDULED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GradingOptionCode":{
            "title":"Grading Option Code",
            "maxLength":30,
            "type":"string",
            "description":"The grading method option selected by the student for enrollment.",
            "nullable":true
        },
        "ItemCurriculumId":{
            "title":"Item Curriculum ID",
            "type":"integer",
            "description":"The unique identifier of the course or course section that's scheduled.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OfferSequenceNumber":{
            "title":"Course Offering Sequence Number",
            "type":"integer",
            "description":"The offering sequence number for the course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "instructors":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource lists the instructors for the enrolled or scheduled items.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-patch-request"
            }
        },
        "meetingPatterns":{
            "title":"Meeting Patterns",
            "type":"array",
            "description":"The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-patch-request"
            }
        }
    }
}

Nested Schema : Instructors

Type: array

Title: Instructors

The instructors resource lists the instructors for the enrolled or scheduled items.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-patch-request

{
    "title":"Instructors",
    "type":"array",
    "description":"The instructors resource lists the instructors for the enrolled or scheduled items.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-patch-request"
    }
}

Nested Schema : Meeting Patterns

Type: array

Title: Meeting Patterns

The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-patch-request

{
    "title":"Meeting Patterns",
    "type":"array",
    "description":"The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-patch-request"
    }
}

Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response

Type: object

Show Source

• AcademicLevelIdOption: integer (int64)
  Title: Academic Level ID Option

  The unique identifier for the academic level of the student enrolling in the course.
• AcademicLevelNameOption: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of the academic level of the student enrolling in the course.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  The subject code for the course.
• AcademicSubjectId: integer
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for the subject of the course.
• AcademicSubjectName: string
  Title: Subject Name

  Read Only: true

  The subject name for the course.
• CalculatedClassEndDate: string (date)
  Title: Calculated Class End

  Read Only: true

  The calculated end date based on the course section start date for self-paced courses.
• ClassStartDateOption: string (date)
  Title: Class Start Date Option

  The requested start date for the self-paced course.
• CourseCurriculumId: integer
  Title: Course Curriculum ID

  Read Only: true

  The curriculum item identifier for the course.
• CourseEnrollmentStatusCode: string
  Title: Course Enrollment Status Code

  Read Only: true

  The enrollment status code of the course section indicating if the course is available for enrollment.
• CourseEnrollmentStatusMeaning: string
  Title: Course Enrollment Status Meaning

  Read Only: true

  The enrollment status of the course section indicating if the course is available for enrollment.
• CourseOfferingId: integer
  Title: Course Offering ID

  Read Only: true

  The offering identifier for the course.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• CreditOptionFlag: boolean
  Title: Credit Option Flag

  Maximum Length: 1

  Default Value: false

  The type of credit the student is enrolling in.
• CreditTypeCode: string
  Title: Credit Type Code

  Read Only: true

  Maximum Length: 255

  The unique identifier of the credit type associated with the 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: Credit Type

  Read Only: true

  The meaning of the type of credit of the 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: Course Catalog Number

  Read Only: true

  The catalog number for the course.
• CurriculumFormatCode: string
  Title: Format Code

  Read Only: true

  Maximum Length: 30

  The unique identifier for the format of the 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: Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the 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.
• CurriculumOptionId: integer (int64)
  Title: Option ID

  Read Only: true

  The unique identifier of the associated enrollment options record.
• DropEnabledFlag: boolean
  Title: Drop Enabled

  Read Only: true

  Maximum Length: 255

  Indicates the student is allowed to drop the course section.
• EnrolledCreditsOption: number
  Title: Enrolled Credit Units Option

  The number of credits the student wants to enroll in.
• EnrollmentCapacityQuantity: integer
  Title: Enrollment Capacity

  Read Only: true

  The enrollment capacity of the course section.
• EnrollmentRequestStatusCode: string
  Title: Enrollment Request Status

  Maximum Length: 30

  Default Value: ORA_SCHEDULED

  The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.
• EnrollmentRequestStatusMeaning: string
  Title: Enrollment Request Meaning

  Read Only: true

  Maximum Length: 80

  The status of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.
• GradingOptionCode: string
  Title: Grading Option Code

  Maximum Length: 30

  The grading method option selected by the student for enrollment.
• instructors: array Instructors
  Title: Instructors

  The instructors resource lists the instructors for the enrolled or scheduled items.
• IsSelfPacedFlag: boolean
  Title: Self-Paced

  Read Only: true

  Indicates that the course section is self-paced. The default value is false.
• ItemCurriculumId: integer (int64)
  Title: Item Curriculum ID

  The unique identifier of the course or course section that's scheduled.
• ItemCurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the curriculum item for the course or course section that's scheduled.
• ItemCurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The type of curriculum that's scheduled.
• ItemCurriculumTypeId: integer (int64)
  Title: Curriculum Item Type ID

  Read Only: true

  The unique identifier for the type of curriculum that's scheduled.
• ItemCurriculumTypeName: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The type name of the curriculum that's scheduled.
• LastDateToDrop: string (date-time)
  Title: Last Date to Drop

  Read Only: true

  The last date the student can drop the course section without penalty.
• LastDateToDropWithGreaterPenalty: string (date-time)
  Title: Last Date to Drop with Greater Penalty

  Read Only: true

  The last date the student can drop the course section with a greater drop penalty.
• LastDateToDropWithoutRetain: string (date-time)
  Title: Last Date to Drop: Delete Record

  Read Only: true

  The last date the student can drop the course section and not have the course section remain part of their academic record.
• LastDateToDropWithPenalty: string (date-time)
  Title: Last Date to Drop: Withdrew with Penalty

  Read Only: true

  The last date the student can drop the course section with some sort of drop penalty applied.
• LastDateToDropWithRetain: string (date-time)
  Title: Last Date to Drop: Retain Record

  Read Only: true

  The last date the student can drop the course section and receive a withdraw status.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

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

  Read Only: true

  The maximum number of units for which a course can be taken.
• meetingPatterns: array Meeting Patterns
  Title: Meeting Patterns

  The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  The minimum number of units for which a course can be taken.
• OfferSequenceNumber: integer (int64)
  Title: Course Offering Sequence Number

  The offering sequence number for the course.
• RepeatAllowedFlag: boolean
  Title: Repeatable

  Read Only: true

  Indicates that repeating the course is allowed. The default value is false.
• RepeatAllowedTotal: integer
  Title: Total Completions Allowed

  Read Only: true

  The total number of times a student can take a course.
• RepeatInPeriodFlag: boolean
  Title: Allow Multiple Enrollment

  Read Only: true

  Indicates that repeating the course is allowed within the same period.
• RepeatUnitsTotal: number
  Title: Total Units Allowed

  Read Only: true

  The total number of repeated units which are allowed for the course.
• RequisiteExistsFlag: boolean
  Title: Requisite Exists

  Read Only: true

  Maximum Length: 255

  Indicates that requisites exist for the enrolled course.
• RequisiteInformation: string
  Title: Requisite Description

  Read Only: true

  Maximum Length: 255

  The text used to describe the requisites of a course.
• ScheduledCourseCampusId: integer
  Title: Campus

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The name of the campus where the course section is offered.
• ScheduledCourseCode: string
  Title: Scheduled Course Code

  Read Only: true

  The section code of the course section.
• ScheduledCourseEndDate: string (date-time)
  Title: Section End Date

  Read Only: true

  The date when the course section ends.
• ScheduledCourseStartDate: string (date-time)
  Title: Section Start Date

  Read Only: true

  The date when the course section starts.
• ScheduledItemId: integer (int64)
  Title: Scheduled Item ID

  Read Only: true

  The unique identifier of the scheduled item.
• TotalEnrolledQuantity: integer
  Title: Total Enrolled

  Read Only: true

  The number of students currently enrolled in the course section.

{
    "type":"object",
    "properties":{
        "AcademicLevelIdOption":{
            "title":"Academic Level ID Option",
            "type":"integer",
            "description":"The unique identifier for the academic level of the student enrolling in the course.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicLevelNameOption":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level of the student enrolling in the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "type":"string",
            "description":"The subject code for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the subject of the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject Name",
            "type":"string",
            "description":"The subject name for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedClassEndDate":{
            "title":"Calculated Class End",
            "type":"string",
            "description":"The calculated end date based on the course section start date for self-paced courses.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassStartDateOption":{
            "title":"Class Start Date Option",
            "type":"string",
            "description":"The requested start date for the self-paced course.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CourseCurriculumId":{
            "title":"Course Curriculum ID",
            "type":"integer",
            "description":"The curriculum item identifier for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CourseEnrollmentStatusCode":{
            "title":"Course Enrollment Status Code",
            "type":"string",
            "description":"The enrollment status code of the course section indicating if the course is available for enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ItemCurriculumType"
                ]
            }
        },
        "CourseEnrollmentStatusMeaning":{
            "title":"Course Enrollment Status Meaning",
            "type":"string",
            "description":"The enrollment status of the course section indicating if the course is available for enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ItemCurriculumType"
                ]
            }
        },
        "CourseOfferingId":{
            "title":"Course Offering ID",
            "type":"integer",
            "description":"The offering identifier for the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CourseCurriculumId",
                    "OfferSequenceNumber"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditOptionFlag":{
            "title":"Credit Option Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The type of credit the student is enrolling in.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the credit type associated with the 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":false
        },
        "CreditTypeMeaning":{
            "title":"Credit Type",
            "type":"string",
            "description":"The meaning of the type of credit of the 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":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumCatalogNumber":{
            "title":"Course Catalog Number",
            "type":"string",
            "description":"The catalog number for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumFormatCode":{
            "title":"Format Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the format of the 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
        },
        "CurriculumFormatMeaning":{
            "title":"Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the 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
        },
        "CurriculumOptionId":{
            "title":"Option ID",
            "type":"integer",
            "description":"The unique identifier of the associated enrollment options record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DropEnabledFlag":{
            "title":"Drop Enabled",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates the student is allowed to drop the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrolledCreditsOption":{
            "title":"Enrolled Credit Units Option",
            "type":"number",
            "description":"The number of credits the student wants to enroll in.",
            "nullable":true,
            "x-queryable":true
        },
        "EnrollmentCapacityQuantity":{
            "title":"Enrollment Capacity",
            "type":"integer",
            "description":"The enrollment capacity of the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentRequestStatusCode":{
            "title":"Enrollment Request Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.",
            "nullable":false,
            "default":"ORA_SCHEDULED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnrollmentRequestStatusMeaning":{
            "title":"Enrollment Request Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The status of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GradingOptionCode":{
            "title":"Grading Option Code",
            "maxLength":30,
            "type":"string",
            "description":"The grading method option selected by the student for enrollment.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSelfPacedFlag":{
            "title":"Self-Paced",
            "type":"boolean",
            "description":"Indicates that the course section is self-paced. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemCurriculumId":{
            "title":"Item Curriculum ID",
            "type":"integer",
            "description":"The unique identifier of the course or course section that's scheduled.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the curriculum item for the course or course section that's scheduled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of curriculum that's scheduled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumTypeId":{
            "title":"Curriculum Item Type ID",
            "type":"integer",
            "description":"The unique identifier for the type of curriculum that's scheduled.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCurriculumTypeName":{
            "title":"Curriculum Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The type name of the curriculum that's scheduled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDrop":{
            "title":"Last Date to Drop",
            "type":"string",
            "description":"The last date the student can drop the course section without penalty.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDateToDropWithGreaterPenalty":{
            "title":"Last Date to Drop with Greater Penalty",
            "type":"string",
            "description":"The last date the student can drop the course section with a greater drop penalty.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDateToDropWithPenalty":{
            "title":"Last Date to Drop: Withdrew with Penalty",
            "type":"string",
            "description":"The last date the student can drop the course section with some sort of drop penalty applied.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDateToDropWithRetain":{
            "title":"Last Date to Drop: Retain Record",
            "type":"string",
            "description":"The last date the student can drop the course section and receive a withdraw status.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDateToDropWithoutRetain":{
            "title":"Last Date to Drop: Delete Record",
            "type":"string",
            "description":"The last date the student can drop the course section and not have the course section remain part of their academic record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum number of units for which a course can be taken.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"The minimum number of units for which a course can be taken.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "OfferSequenceNumber":{
            "title":"Course Offering Sequence Number",
            "type":"integer",
            "description":"The offering sequence number for the course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepeatAllowedFlag":{
            "title":"Repeatable",
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepeatAllowedTotal":{
            "title":"Total Completions Allowed",
            "type":"integer",
            "description":"The total number of times a student can take a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepeatInPeriodFlag":{
            "title":"Allow Multiple Enrollment",
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed within the same period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepeatUnitsTotal":{
            "title":"Total Units Allowed",
            "type":"number",
            "description":"The total number of repeated units which are allowed for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisiteExistsFlag":{
            "title":"Requisite Exists",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that requisites exist for the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisiteInformation":{
            "title":"Requisite Description",
            "maxLength":255,
            "type":"string",
            "description":"The text used to describe the requisites of a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where the course section is offered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCampusName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the campus where the course section is offered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCode":{
            "title":"Scheduled Course Code",
            "type":"string",
            "description":"The section code of the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseEndDate":{
            "title":"Section End Date",
            "type":"string",
            "description":"The date when the course section ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseStartDate":{
            "title":"Section Start Date",
            "type":"string",
            "description":"The date when the course section starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledItemId":{
            "title":"Scheduled Item ID",
            "type":"integer",
            "description":"The unique identifier of the scheduled item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TotalEnrolledQuantity":{
            "title":"Total Enrolled",
            "type":"integer",
            "description":"The number of students currently enrolled in the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "instructors":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource lists the instructors for the enrolled or scheduled items.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "meetingPatterns":{
            "title":"Meeting Patterns",
            "type":"array",
            "description":"The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response"
            }
        }
    }
}

Nested Schema : Instructors

Type: array

Title: Instructors

The instructors resource lists the instructors for the enrolled or scheduled items.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-response

{
    "title":"Instructors",
    "type":"array",
    "description":"The instructors resource lists the instructors for the enrolled or scheduled items.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-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 lists the meeting pattern information for enrolled or scheduled items.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response

{
    "title":"Meeting Patterns",
    "type":"array",
    "description":"The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response"
    }
}

Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-response

Type: object

Show Source

• CurriculumOfferingId: integer (int64)
  Title: Curriculum Offering ID

  Read Only: true

  The unique identifier of curriculum offering of the course section.
• CurriculumOrgId: integer (int64)
  Title: Curriculum Organization ID

  Read Only: true

  The unique identifier of the curriculum organization of the course section staff.
• CurriculumStaffId: integer (int64)
  Title: Curriculum Staff ID

  Read Only: true

  The unique identifier of the curriculum staff.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferSequenceNumber: integer (int32)
  Title: Offer Number

  Read Only: true

  The offering sequence number of the course section.
• PersonAcademicTitle: string
  Title: Academic Title

  Read Only: true

  Maximum Length: 30

  The academic title of the instructor if one is available.
• PersonImageContent: string (byte)
  Title: Staff Image

  Read Only: true

  The image data of the instructor.
• PersonImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  The image or photograph of the instructor, if available.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the instructor.
• PreferredFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of the person.
• PreferredLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The preferred last name of the person.
• PreferredMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The preferred middle name of the person.
• PreferredName: string
  Title: Additional Name

  Read Only: true

  Maximum Length: 360

  The preferred first and last name of the person displayed as a single string.
• StaffAdministratorOnlyFlag: boolean
  Title: Administrator Only

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that this staff member is part of the administrative staff. The default value is false.
• StaffBiography: string (byte)
  Title: Biography

  Read Only: true

  The biography of the instructor, if available.
• StaffPartyId: integer (int64)
  Title: Staff ID

  Read Only: true

  The unique identifier for the party.
• StaffPrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  The primary instructor of the course section.
• StaffRoleTypeCode: string
  Title: Role Type

  Read Only: true

  Maximum Length: 30

  The role code that the course section staff will be filling
• StaffRoleTypeMeaning: string
  Title: Role Meaning

  Read Only: true

  Maximum Length: 80

  The role that the course section staff will be filling.

{
    "type":"object",
    "properties":{
        "CurriculumOfferingId":{
            "title":"Curriculum Offering ID",
            "type":"integer",
            "description":"The unique identifier of curriculum offering of the course section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumOrgId":{
            "title":"Curriculum Organization ID",
            "type":"integer",
            "description":"The unique identifier of the curriculum organization of the course section staff.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumStaffId":{
            "title":"Curriculum Staff ID",
            "type":"integer",
            "description":"The unique identifier of the curriculum staff.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OfferSequenceNumber":{
            "title":"Offer Number",
            "type":"integer",
            "description":"The offering sequence number of the course section.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonAcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The academic title of the instructor if one is available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageContent":{
            "title":"Staff Image",
            "type":"string",
            "description":"The image data of the instructor.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The image or photograph of the instructor, if available.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The preferred first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "PreferredLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The preferred last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PreferredMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The preferred middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "PreferredName":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The preferred first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StaffAdministratorOnlyFlag":{
            "title":"Administrator Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this staff member is part of the administrative staff. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "StaffBiography":{
            "title":"Biography",
            "type":"string",
            "description":"The biography of the instructor, if available.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StaffPartyId":{
            "title":"Staff ID",
            "type":"integer",
            "description":"The unique identifier for the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"The primary instructor of the course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeCode":{
            "title":"Role Type",
            "maxLength":30,
            "type":"string",
            "description":"The role code that the course section staff will be filling",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The role that the course section staff will be filling.",
            "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"
            }
        }
    }
}

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 : 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 : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response

Type: object

Show Source

• BuildingName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The building name of the facility where the meeting will be held.
• BuildingShortCode: string
  Title: Code

  Read Only: true

  Maximum Length: 6

  The building code of the facility where the meeting will be held.
• CurriculumFormatCode: string
  Title: Format Code

  Read Only: true

  Maximum Length: 30

  The unique identifier for the format of the 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: Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the format of the 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.
• CurriculumScheduleId: integer (int64)
  Title: Schedule ID

  Read Only: true

  The unique identifier of the meeting record.
• DurationQuantity: integer (int32)
  Title: Duration

  Read Only: true

  The duration of the meeting.
• FacilityDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  A description of the facility where the meeting will be held.
• FacilityRoomNumber: string
  Title: Room Number

  Read Only: true

  Maximum Length: 10

  The room number of the facility where the meeting will be held.
• FacilityShortCode: string
  Title: Facility

  Read Only: true

  Maximum Length: 20

  The abbreviated facility code representing the building and room number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The latitude of the building where the meeting will be held.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The longitude of the building where the meeting will be held.
• LocationLongName: string
  Title: Location Long Name

  Read Only: true

  Contains formatted address from either the associated facility or the user entered course location address.
• MeetingPatternDescription: string
  Title: Pattern Description

  Read Only: true

  Maximum Length: 50

  The description of the meeting pattern for the meeting.
• MeetingPatternEndDate: string (date)
  Title: End Date

  Read Only: true

  The scheduled end date of the meeting.
• MeetingPatternEndTime: string (date-time)
  Title: End Time

  Read Only: true

  The scheduled end time of the meeting.
• MeetingPatternName: string
  Title: Meeting Name

  Read Only: true

  Maximum Length: 50

  The descriptive name of the meeting such as lab or lecture.
• MeetingPatternStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the meeting schedule indicating the first day of class.
• MeetingPatternStartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The scheduled start time of the meeting.
• RecurrenceDayFriFlag: boolean
  Title: Friday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Friday.
• RecurrenceDayMonFlag: boolean
  Title: Monday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Monday.
• RecurrenceDaySatFlag: boolean
  Title: Saturday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Saturday.
• RecurrenceDaySunFlag: boolean
  Title: Sunday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Sunday.
• RecurrenceDayThuFlag: boolean
  Title: Thursday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Thursday.
• RecurrenceDayTueFlag: boolean
  Title: Tuesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Tuesday.
• RecurrenceDayWedFlag: boolean
  Title: Wednesday

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that the meeting will occur on a Wednesday.
• ScheduleSequenceNumber: integer (int32)
  Title: Schedule Sequence Number

  Read Only: true

  The sequence of the meeting. Used when a course section has more than a single meeting pattern.

{
    "type":"object",
    "properties":{
        "BuildingName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The building name of the facility where the meeting will be held.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "maxLength":6,
            "type":"string",
            "description":"The building code of the facility where the meeting will be held.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "title":"Format Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the format of the 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
        },
        "CurriculumFormatMeaning":{
            "title":"Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the format of the 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
        },
        "CurriculumScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the meeting record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DurationQuantity":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the meeting.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A description of the facility where the meeting will be held.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":10,
            "type":"string",
            "description":"The room number of the facility where the meeting will be held.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "maxLength":20,
            "type":"string",
            "description":"The abbreviated facility code representing the building and room number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the building where the meeting will be held.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"Contains formatted address from either the associated facility or the user entered course location address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CustomLocationLongName",
                    "FacilityLocationLongName",
                    "LocationControlCode"
                ]
            },
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the building where the meeting will be held.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Description",
            "maxLength":50,
            "type":"string",
            "description":"The description of the meeting pattern for the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The scheduled end date of the meeting.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The scheduled end time of the meeting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternName":{
            "title":"Meeting Name",
            "maxLength":50,
            "type":"string",
            "description":"The descriptive name of the meeting such as lab or lecture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the meeting schedule indicating the first day of class.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The scheduled start time of the meeting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceDayFriFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Friday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDayMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Monday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDaySatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Saturday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDaySunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Sunday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDayThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Thursday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDayTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Tuesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "RecurrenceDayWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the meeting will occur on a Wednesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ScheduleSequenceNumber":{
            "title":"Schedule Sequence Number",
            "type":"integer",
            "description":"The sequence of the meeting. Used when a course section has more than a single meeting pattern.",
            "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"
            }
        }
    }
}

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"
    }
}

Links

EnrollmentRequestStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{EnrollmentRequestStatusCode}%2CLookupType%3DORA_HER_ENROLLMENT_RQST_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: EnrollmentRequestStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

instructors

Operation: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/instructors

Parameters:

• schedulePeriodsUniqID: $request.path.schedulePeriodsUniqID
• scheduledItemsUniqID: $request.path.scheduledItemsUniqID
• studentScheduleByPeriodsUniqID: $request.path.studentScheduleByPeriodsUniqID

The instructors resource lists the instructors for the enrolled or scheduled items.

meetingPatterns

Operation: /fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}/child/meetingPatterns

Parameters:

• schedulePeriodsUniqID: $request.path.schedulePeriodsUniqID
• scheduledItemsUniqID: $request.path.scheduledItemsUniqID
• studentScheduleByPeriodsUniqID: $request.path.studentScheduleByPeriodsUniqID

The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.

Back to Top