Jump to

• Request
• Response

Get all student schedules

get

/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods

Request

Query Parameters

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

  • PrimaryKey Finds all student schedule by periods that match the Party ID.
    Finder Variables
    • PartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
• 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:
  

  • ConstituentId; string; The unique identifier for a constituent.
  • PartyId; integer; The unique identifier for the party.
  • PreferredFirstName; string; The preferred first name of the person.
  • PreferredFullName; string; The first and last name of the person displayed as a single string.
  • PreferredLastName; string; The preferred last name of the person.
  • PreferredMiddleName; string; The preferred middle name of the person.
  • PreferredNameSuffix; string; The name suffix of the person such as junior or senior.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : studentScheduleByPeriods

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/studentScheduleByPeriods-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentScheduleByPeriods-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-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 : studentScheduleByPeriods-item-response

Type: object

Show Source

• ConstituentId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for a constituent.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier for the party.
• PreferredFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of the person.
• PreferredFullName: string
  Title: Additional Name

  Read Only: true

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• 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.
• PreferredNameSuffix: string
  Title: Name Suffix

  Read Only: true

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• schedulePeriods: array Schedule Periods
  Title: Schedule Periods

  The schedule periods resource is used to show optional and mandatory reporting periods for a student.

{
    "type":"object",
    "properties":{
        "ConstituentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a constituent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "PreferredFullName":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "schedulePeriods":{
            "title":"Schedule Periods",
            "type":"array",
            "description":"The schedule periods resource is used to show optional and mandatory reporting periods for a student.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-item-response"
            }
        },
        "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
        },
        "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
        }
    }
}

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 : Schedule Periods

Type: array

Title: Schedule Periods

The schedule periods resource is used to show optional and mandatory reporting periods for a student.

Show Source

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

{
    "title":"Schedule Periods",
    "type":"array",
    "description":"The schedule periods resource is used to show optional and mandatory reporting periods for a student.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-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 : studentScheduleByPeriods-schedulePeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Read Only: true

  The unique identifier of an academic period.
• AcademicPeriodTypeId: integer (int64)
  Title: Academic Period Type ID

  Read Only: true

  The unique identifier of the academic period type.
• EarliestFirstDateToEnroll: string (date-time)
  Read Only: true

  The date that documents the start of enrollment for an academic period.
• EarliestFirstDateToSearch: string (date-time)
  Read Only: true

  The date that controls when an academic reporting period is available for course searches.
• EndDate: string (date)
  Read Only: true

  The date when the academic period ends.
• enrolledItems: array Enrolled Items
  Title: Enrolled Items

  The enrolled items resource lists course section enrollments associated with a student.
• enrollmentPeriods: array Enrollment Periods
  Title: Enrollment Periods

  The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.
• LatestLastDateToEnroll: string (date-time)
  Read Only: true

  The date that documents the last day of enrollment for an academic period.
• LatestLastDateToSearch: string (date-time)
  Read Only: true

  The date that controls when an academic reporting period is no longer available for course searches.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptionalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if the academic period is required for a student based on their enrolled program. The default value is false.
• PeriodCategoryCode: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  The category code of the academic reporting period.
• PeriodCategoryMeaning: string
  Read Only: true

  Maximum Length: 80

  The category meaning of the academic reporting period.
• PeriodTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period type.
• recommendedItems: array Recommended Items
  Title: Recommended Items

  The recommended items resource is used to display recommended courses from the student's program templates.
• scheduledItems: array Scheduled Items
  Title: Scheduled Items

  The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.
• schedulePeriodDates: array Period Dates
  Title: Period Dates

  The enrollment period dates resource is used to display key dates for an enrollment period.
• SchedulePeriodName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period.
• StartDate: string (date)
  Read Only: true

  The date when the academic period starts.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The number of weeks of instruction for an academic reporting period.

{
    "type":"object",
    "properties":{
        "PeriodTypeName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestFirstDateToSearch":{
            "type":"string",
            "description":"The date that controls when an academic reporting period is available for course searches.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AcademicPeriodId"
                ]
            },
            "x-queryable":true
        },
        "EarliestFirstDateToEnroll":{
            "type":"string",
            "description":"The date that documents the start of enrollment for an academic period.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AcademicPeriodId"
                ]
            },
            "x-queryable":true
        },
        "LatestLastDateToEnroll":{
            "type":"string",
            "description":"The date that documents the last day of enrollment for an academic period.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AcademicPeriodId"
                ]
            },
            "x-queryable":true
        },
        "recommendedItems":{
            "title":"Recommended Items",
            "type":"array",
            "description":"The recommended items resource is used to display recommended courses from the student's program templates.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the academic period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The number of weeks of instruction for an academic reporting period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The category meaning of the academic reporting period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the academic period is required for a student based on their enrolled program. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PeriodRequired"
                ]
            },
            "x-queryable":true
        },
        "scheduledItems":{
            "title":"Scheduled Items",
            "type":"array",
            "description":"The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the academic period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "schedulePeriodDates":{
            "title":"Period Dates",
            "type":"array",
            "description":"The enrollment period dates resource is used to display key dates for an enrollment period.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-response"
            }
        },
        "LatestLastDateToSearch":{
            "type":"string",
            "description":"The date that controls when an academic reporting period is no longer available for course searches.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AcademicPeriodId"
                ]
            },
            "x-queryable":true
        },
        "enrolledItems":{
            "title":"Enrolled Items",
            "type":"array",
            "description":"The enrolled items resource lists course section enrollments associated with a student.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response"
            }
        },
        "enrollmentPeriods":{
            "title":"Enrollment Periods",
            "type":"array",
            "description":"The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SchedulePeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "type":"integer",
            "description":"The unique identifier of an academic period.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicPeriodTypeId":{
            "title":"Academic Period Type ID",
            "type":"integer",
            "description":"The unique identifier of the academic period type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category code of the academic reporting period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Enrolled Items

Type: array

Title: Enrolled Items

The enrolled items resource lists course section enrollments associated with a student.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response

{
    "title":"Enrolled Items",
    "type":"array",
    "description":"The enrolled items resource lists course section enrollments associated with a student.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response"
    }
}

Nested Schema : Enrollment Periods

Type: array

Title: Enrollment Periods

The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-item-response

{
    "title":"Enrollment Periods",
    "type":"array",
    "description":"The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-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 : Recommended Items

Type: array

Title: Recommended Items

The recommended items resource is used to display recommended courses from the student's program templates.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response

{
    "title":"Recommended Items",
    "type":"array",
    "description":"The recommended items resource is used to display recommended courses from the student's program templates.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response"
    }
}

Nested Schema : Scheduled Items

Type: array

Title: Scheduled Items

The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.

Show Source

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

{
    "title":"Scheduled Items",
    "type":"array",
    "description":"The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response"
    }
}

Nested Schema : Period Dates

Type: array

Title: Period Dates

The enrollment period dates resource is used to display key dates for an enrollment period.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-response

{
    "title":"Period Dates",
    "type":"array",
    "description":"The enrollment period dates resource is used to display key dates for an enrollment period.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-response"
    }
}

Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response

Type: object

Show Source

• AcademicLevelIdOption: integer (int64)
  The unique identifier of the academic level.
• AcademicLevelNameOption: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 30

  The subject code of the enrolled course.
• AcademicSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

  The subject name of the enrolled course.
• CalculatedClassEndDate: string (date)
  Read Only: true

  The calculated course section end date for the self-paced course enrollment.
• ClassStartDateOption: string (date)
  The course section start date for the self-paced course enrollment
• CourseEnrollingStatusCode: string
  Title: Enrollment Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_OPN

  The enrolling status code for the course section.
• CourseEnrollingStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The enrolling status of the course section.
• CourseOfferingId: integer (int64)
  Read Only: true

  The offering unique identifier of the curriculum item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date the row was created.
• CreditOptionFlag: boolean
  Maximum Length: 1

  Default Value: false

  The credit option for the course enrollment.
• CreditTypeCode: string
  Title: Credit Type Code

  Read Only: true

  Maximum Length: 30

  The credit type code of the enrolled course.
• CreditTypeMeaning: string
  Title: Credit Type

  Read Only: true

  Maximum Length: 80

  The credit type of the enrolled course.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

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

  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
  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)
  The unique identifier of the curriculum enrollment options record.
• DropDate: string (date)
  Title: Drop Date

  Read Only: true

  The date when the student dropped the scheduled course.
• DropEnabledFlag: boolean
  Read Only: true

  Indicates that this course section can be dropped by the student.
• EnrolledCreditQuantity: number
  Title: Units

  Read Only: true

  The number of credits the student enrolled in for the course.
• EnrolledCreditsOption: number
  The number of enrolled credits for the course enrollment.
• EnrollmentCapacityQuantity: integer (int32)
  Title: Enrollment Capacity

  Read Only: true

  The total number of enrolled students allowed to enroll in the enrolled course section.
• EnrollmentDate: string (date)
  Title: Enrollment Date

  Read Only: true

  The date of the enrollment.
• EnrollmentItemId: integer (int64)
  Title: Student Curriculum Item ID

  Read Only: true

  The unique identifier of the enrollment item.
• EnrollmentStatus: string
  Title: Enrollment Status

  Read Only: true

  Maximum Length: 30

  The status code of the enrollment.
• EnrollmentStatusMeaning: string
  Title: Enrollment Status Meaning

  Read Only: true

  Maximum Length: 80

  The status of the enrollment.
• GradingOptionCode: string
  Maximum Length: 30

  The grading option for the course 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

  Maximum Length: 1

  Indicates that the enrolled course section is self paced.
• ItemCurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The identifier of the enrolled curriculum item.
• ItemCurriculumName: string
  Title: Title

  Read Only: true

  Maximum Length: 150

  The name of the enrolled curriculum item.
• ItemCurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The curriculum type code of the enrolled item.
• ItemCurriculumTypeId: integer (int64)
  Title: Curriculum Type

  Read Only: true

  The identifier of the curriculum type for the enrolled item.
• ItemCurriculumTypeName: string
  Read Only: true

  Maximum Length: 50

  The name of the curriculum type.
• LastDateToDrop: string (date-time)
  Read Only: true

  The last day the student is allowed to drop this course.
• LastDateToDropWithGreaterPenalty: string (date-time)
  Read Only: true

  The last day the student is allowed to drop where the student will receive a greater financial penalty for dropping the course.
• LastDateToDropWithoutRetain: string (date-time)
  Read Only: true

  The last day the student is allowed to drop where the course won't appear on the student's academic record.
• LastDateToDropWithPenalty: string (date-time)
  Read Only: true

  The last day the student is allowed to drop where the student will receive a financial penalty for dropping the course.
• LastDateToDropWithRetain: string (date-time)
  Read Only: true

  The last day the student is allowed to drop where the course will appear on the student's academic record.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  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 (int32)
  Title: Owning Offer Number

  Read Only: true

  The offering sequence number of the course.
• OwningCurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The curriculum Id of the course that owns the course section.
• OwningCurriculumName: string
  Title: Title

  Read Only: true

  Maximum Length: 150

  The curriculum name of the course that owns the course section.
• RepeatAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that repeating the course is allowed. The default value is false.
• RepeatAllowedTotal: integer (int32)
  Read Only: true

  The total number of times a student can take a course.
• RepeatInPeriodFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that repeating the course is allowed within the same period.
• RepeatUnitsTotal: number
  Read Only: true

  The total number of repeated units which are allowed for the course.
• RequisiteExistsFlag: boolean
  Read Only: true

  Indicates that requisites exist for the enrolled course.
• RequisiteInformation: string
  Read Only: true

  The text used to describe the requisites of a course.
• RequisiteStatusCode: string
  Title: Requisite Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the course requisites at time of enrollment.
• RequisiteStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The status of the course requisites at the time of enrollment.
• ScheduledCourseCampusId: integer (int64)
  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: 50

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The end date of the enrolled course section.
• ScheduledCourseStartDate: string (date-time)
  Title: Section Start Date

  Read Only: true

  The start date of the enrolled course section.
• TotalEnrolledQuantity: integer (int32)
  Title: Total Enrolled

  Read Only: true

  The total number of students enrolled in the course section.

{
    "type":"object",
    "properties":{
        "OwningCurriculumName":{
            "title":"Title",
            "maxLength":150,
            "type":"string",
            "description":"The curriculum name of the course that owns the course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The curriculum Id of the course that owns the course section.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CourseEnrollingStatusCode":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"The enrolling status code for the course section.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_OPN",
            "x-queryable":true
        },
        "RepeatInPeriodFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed within the same period.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "EnrollmentCapacityQuantity":{
            "title":"Enrollment Capacity",
            "type":"integer",
            "description":"The total number of enrolled students allowed to enroll in the enrolled course section.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EnrolledCreditQuantity":{
            "title":"Units",
            "type":"number",
            "description":"The number of credits the student enrolled in for the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Credit Type",
            "maxLength":80,
            "type":"string",
            "description":"The credit type of the enrolled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the course requisites at the time of enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumTypeName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the curriculum type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "instructors":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource lists the instructors for the enrolled or scheduled items.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrolledItems-instructors-item-response"
            }
        },
        "EnrollmentStatus":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatAllowedTotal":{
            "type":"integer",
            "description":"The total number of times a student can take a course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ClassStartDateOption":{
            "type":"string",
            "description":"The course section start date for the self-paced course enrollment",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EnrolledCreditsOption":{
            "type":"number",
            "description":"The number of enrolled credits for the course enrollment.",
            "nullable":true,
            "x-queryable":true
        },
        "CourseEnrollingStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The enrolling status of the course section.",
            "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"
            }
        },
        "IsSelfPacedFlag":{
            "title":"Self-Paced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the enrolled course section is self paced.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-enrolledItems-meetingPatterns-item-response"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumName":{
            "title":"Title",
            "maxLength":150,
            "type":"string",
            "description":"The name of the enrolled curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDropWithPenalty":{
            "type":"string",
            "description":"The last day the student is allowed to drop where the student will receive a financial penalty for dropping the course.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalEnrolledQuantity":{
            "title":"Total Enrolled",
            "type":"integer",
            "description":"The total number of students enrolled in the course section.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Associated Section Code",
            "maxLength":30,
            "type":"string",
            "description":"The section code identifier of the enrolled course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where the course section is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The subject unique identifier of the enrolled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisiteInformation":{
            "type":"string",
            "description":"The text used to describe the requisites of a course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MessageText"
                ]
            },
            "x-queryable":true
        },
        "DropEnabledFlag":{
            "type":"boolean",
            "description":"Indicates that this course section can be dropped by the student.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier of the enrolled curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseStartDate":{
            "title":"Section Start Date",
            "type":"string",
            "description":"The start date of the enrolled course section.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradingOptionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The grading option for the course enrollment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditOptionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The credit option for the course enrollment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AcademicLevelIdOption":{
            "type":"integer",
            "description":"The unique identifier of the academic level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentItemId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The unique identifier of the enrollment item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequisiteStatusCode":{
            "title":"Requisite Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the course requisites at time of enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDropWithRetain":{
            "type":"string",
            "description":"The last day the student is allowed to drop where the course will appear on the student's academic record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumOptionId":{
            "type":"integer",
            "description":"The unique identifier of the curriculum enrollment options record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The status of the enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteExistsFlag":{
            "type":"boolean",
            "description":"Indicates that requisites exist for the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "RequisiteInformation"
                ]
            },
            "x-queryable":true
        },
        "RepeatUnitsTotal":{
            "type":"number",
            "description":"The total number of repeated units which are allowed for the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "RepeatAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CourseOfferingId":{
            "type":"integer",
            "description":"The offering unique identifier of the curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCurriculumTypeId":{
            "title":"Curriculum Type",
            "type":"integer",
            "description":"The identifier of the curriculum type for the enrolled item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentDate":{
            "title":"Enrollment Date",
            "type":"string",
            "description":"The date of the enrollment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject Name",
            "maxLength":50,
            "type":"string",
            "description":"The subject name of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DropDate":{
            "title":"Drop Date",
            "type":"string",
            "description":"The date when the student dropped the scheduled course.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseEndDate":{
            "title":"Section End Date",
            "type":"string",
            "description":"The end date of the enrolled course section.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where the course section is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastDateToDrop":{
            "type":"string",
            "description":"The last day the student is allowed to drop this course.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumFormatMeaning":{
            "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
        },
        "CalculatedClassEndDate":{
            "type":"string",
            "description":"The calculated course section end date for the self-paced course enrollment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"The minimum number of units for which a course can be taken.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "AcademicLevelNameOption":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDropWithoutRetain":{
            "type":"string",
            "description":"The last day the student is allowed to drop where the course won't appear on the student's academic record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "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
        },
        "OfferSequenceNumber":{
            "title":"Owning Offer Number",
            "type":"integer",
            "description":"The offering sequence number of the course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The subject code of the enrolled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum type code of the enrolled item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Credit Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The credit type code of the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDropWithGreaterPenalty":{
            "type":"string",
            "description":"The last day the student is allowed to drop where the student will receive a greater financial penalty for dropping the course.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum number of units for which a course can be taken.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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-enrolledItems-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-enrolledItems-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-enrolledItems-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-enrolledItems-meetingPatterns-item-response"
    }
}

Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-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)
  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)
  Read Only: true

  The image data of the instructor.
• PersonImageId: integer (int64)
  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
  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)
  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
  Read Only: true

  Maximum Length: 80

  The role that the course section staff will be filling.

{
    "type":"object",
    "properties":{
        "StaffAdministratorOnlyFlag":{
            "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
        },
        "CurriculumOrgId":{
            "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
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"The primary instructor of the course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageContent":{
            "type":"string",
            "description":"The image data of the instructor.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "StaffRoleTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The role that the course section staff will be filling.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PersonImageId":{
            "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
        },
        "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 instructor if one is available.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "StaffPartyId":{
            "type":"integer",
            "description":"The unique identifier for the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        }
    }
}

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 : studentScheduleByPeriods-schedulePeriods-enrolledItems-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
  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
  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)
  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
  Read Only: true

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

  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":{
        "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
        },
        "LocationLongName":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The scheduled end date of the meeting.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The scheduled end 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumScheduleId":{
            "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
        },
        "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
        },
        "CurriculumFormatMeaning":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the meeting pattern for the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The scheduled start time of the meeting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        }
    }
}

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

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier for the academic period.
• AcademicPeriodTypeId: integer (int64)
  Title: Academic Period Type ID

  Read Only: true

  The unique identifier of the academic period type.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the academic period ends.
• enrollmentPeriodDates: array Period Dates
  Title: Period Dates

  The enrollment period dates resource is used to display key dates for an enrollment period.
• EnrollmentPeriodName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodCategoryCode: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  The category code of the academic period.
• PeriodCategoryMeaning: string
  Read Only: true

  Maximum Length: 80

  The category of the academic period.
• PeriodTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period type.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the academic period starts.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The number of weeks of instruction for the academic period.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the academic period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodTypeName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period type.",
            "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"
            }
        },
        "enrollmentPeriodDates":{
            "title":"Period Dates",
            "type":"array",
            "description":"The enrollment period dates resource is used to display key dates for an enrollment period.",
            "items":{
                "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-response"
            }
        },
        "EnrollmentPeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the academic period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The number of weeks of instruction for the academic period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The category of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodTypeId":{
            "title":"Academic Period Type ID",
            "type":"integer",
            "description":"The unique identifier of the academic period type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category code of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Period Dates

Type: array

Title: Period Dates

The enrollment period dates resource is used to display key dates for an enrollment period.

Show Source

• Array of: object studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-response

{
    "title":"Period Dates",
    "type":"array",
    "description":"The enrollment period dates resource is used to display key dates for an enrollment period.",
    "items":{
        "$ref":"#/components/schemas/studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-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 : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-response

Type: object

Show Source

• AcademicPeriodDateId: integer (int64)
  Title: Academic Period Date ID

  The unique identifier for an academic period date attribute.
• DateTimeCode: string
  Title: Date Time Code

  Read Only: true

  Maximum Length: 30

  The unique code identifier for the date attribute.
• DateTimeId: integer (int64)
  Title: Period Attribute ID

  The unique identifier for the date attribute associated with the academic period.
• DateTimeMeaning: string
  Title: Date Time Meaning

  Read Only: true

  Maximum Length: 50

  The name of the identifier for the date attribute.
• FirstDateTime: string (date-time)
  Title: Date

  The date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecondDateTime: string (date-time)
  Title: Date Range End

  The end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.

{
    "type":"object",
    "properties":{
        "AcademicPeriodDateId":{
            "title":"Academic Period Date ID",
            "type":"integer",
            "description":"The unique identifier for an academic period date attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FirstDateTime":{
            "title":"Date",
            "type":"string",
            "description":"The date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DateTimeCode":{
            "title":"Date Time Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code identifier for the date attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateTimeId":{
            "title":"Period Attribute ID",
            "type":"integer",
            "description":"The unique identifier for the date attribute associated with the academic period.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "SecondDateTime":{
            "title":"Date Range End",
            "type":"string",
            "description":"The end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DateTimeMeaning":{
            "title":"Date Time Meaning",
            "maxLength":50,
            "type":"string",
            "description":"The name of the identifier for the date attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response

Type: object

Show Source

• AcademicSubjectCode: string
  Read Only: true

  Maximum Length: 255

  The subject code for the course.
• AcademicSubjectId: integer
  Read Only: true

  The unique identifier for the subject of the course.
• AcademicSubjectName: string
  Read Only: true

  Maximum Length: 255

  The subject name for the course.
• CourseEnrollmentStatusCode: string
  Read Only: true

  Maximum Length: 255

  The enrollment status code of the course section indicating if the course is available for enrollment.
• CourseEnrollmentStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  The enrollment status of the course section indicating if the course is available for enrollment.
• CourseOfferingId: integer
  Read Only: true

  The offering identifier for the course.
• CreditTypeCode: string
  Read Only: true

  Maximum Length: 255

  The credit type code for the course.
• CreditTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  The credit type for the course or course section.
• CurriculumCatalogNumber: string
  Read Only: true

  Maximum Length: 255

  The catalog number for the course.
• ItemCurriculumId: integer
  Read Only: true

  The unique identifier of the curriculum item (course) that's recommended.
• ItemCurriculumName: string
  Read Only: true

  The name of the curriculum item (course) that's recommended.
• ItemCurriculumType: string
  Read Only: true

  The type of curriculum that's recommended.
• ItemCurriculumTypeId: integer
  Read Only: true

  The unique identifier for the type of curriculum that's recommended.
• ItemCurriculumTypeName: string
  Read Only: true

  Maximum Length: 255

  The type name of the curriculum that's recommended.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumUnitsQuantity: number
  Read Only: true

  The maximum number of units for which a course can be taken.
• MinimumUnitsQuantity: number
  Read Only: true

  The minimum number of units for which a course can be taken.
• OfferSequenceNumber: integer
  Read Only: true

  The offering sequence number for the course.
• RepeatAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that repeating the course is allowed. The default value is false.
• RepeatAllowedTotal: integer
  Read Only: true

  The total number of times a student can take a course.
• RepeatInPeriodFlag: boolean
  Read Only: true

  Indicates that repeating the course is allowed within the same period.
• RepeatUnitsTotal: number
  Read Only: true

  The total number of repeated units which are allowed for the course.
• RequisiteExistsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if requisites exist for the course.
• RequisiteInformation: string (byte)
  Read Only: true

  Maximum Length: 255

  The text used to describe the requisites of a course.
• SourceProgramCurriculumId: integer
  Read Only: true

  The curriculum ID of the program used to generate the recommendation.
• SourceProgramTemplateId: integer
  Read Only: true

  The template ID of the program template used to generate the recommendation.
• SourceTemplatePeriodId: integer
  Read Only: true

  The template period ID of the program template used to generate the recommendation.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The catalog number for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatInPeriodFlag":{
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed within the same period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTemplatePeriodId":{
            "type":"integer",
            "description":"The template period ID of the program template used to generate the recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The credit type for the course or course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteExistsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if requisites exist for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatUnitsTotal":{
            "type":"number",
            "description":"The total number of repeated units which are allowed for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"The type name of the curriculum that's recommended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseOfferingId":{
            "type":"integer",
            "description":"The offering identifier for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumTypeId":{
            "type":"integer",
            "description":"The unique identifier for the type of curriculum that's recommended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatAllowedTotal":{
            "type":"integer",
            "description":"The total number of times a student can take a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseEnrollmentStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The enrollment status of the course section indicating if the course is available for enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProgramCurriculumId":{
            "type":"integer",
            "description":"The curriculum ID of the program used to generate the recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The subject name for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemCurriculumName":{
            "type":"string",
            "description":"The name of the curriculum item (course) that's recommended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "type":"number",
            "description":"The minimum number of units for which a course can be taken.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "SourceProgramTemplateId":{
            "type":"integer",
            "description":"The template ID of the program template used to generate the recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferSequenceNumber":{
            "type":"integer",
            "description":"The offering sequence number for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "maxLength":255,
            "type":"string",
            "description":"The subject code for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumType":{
            "type":"string",
            "description":"The type of curriculum that's recommended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "type":"integer",
            "description":"The unique identifier for the subject of the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"The credit type code for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteInformation":{
            "maxLength":255,
            "type":"string",
            "description":"The text used to describe the requisites of a course.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurriculumId":{
            "type":"integer",
            "description":"The unique identifier of the curriculum item (course) that's recommended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "type":"number",
            "description":"The maximum number of units for which a course can be taken.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "CourseEnrollmentStatusCode":{
            "maxLength":255,
            "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":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 : studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response

Type: object

Show Source

• AcademicLevelIdOption: integer (int64)
  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
  Read Only: true

  The subject code for the course.
• AcademicSubjectId: integer
  Read Only: true

  The unique identifier for the subject of the course.
• AcademicSubjectName: string
  Read Only: true

  The subject name for the course.
• CalculatedClassEndDate: string (date)
  Read Only: true

  The calculated end date based on the course section start date for self-paced courses.
• ClassStartDateOption: string (date)
  The requested start date for the self-paced course.
• CourseCurriculumId: integer
  Read Only: true

  The curriculum item identifier for the course.
• CourseEnrollmentStatusCode: string
  Read Only: true

  The enrollment status code of the course section indicating if the course is available for enrollment.
• CourseEnrollmentStatusMeaning: string
  Read Only: true

  The enrollment status of the course section indicating if the course is available for enrollment.
• CourseOfferingId: integer
  Read Only: true

  The offering identifier for the course.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date the row was created.
• CreditOptionFlag: boolean
  Maximum Length: 1

  Default Value: false

  The type of credit the student is enrolling in.
• CreditTypeCode: string
  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
  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
  Read Only: true

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

  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
  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)
  The unique identifier of the associated enrollment options record.
• DropEnabledFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates the student is allowed to drop the course section.
• EnrolledCreditsOption: number
  The number of credits the student wants to enroll in.
• EnrollmentCapacityQuantity: integer
  Read Only: true

  The enrollment capacity of the course section.
• EnrollmentRequestStatusCode: string
  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
  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
  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
  Read Only: true

  Indicates that the course section is self-paced. The default value is false.
• ItemCurriculumId: integer (int64)
  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)
  Read Only: true

  The unique identifier for the type of curriculum that's scheduled.
• ItemCurriculumTypeName: string
  Read Only: true

  Maximum Length: 50

  The type name of the curriculum that's scheduled.
• LastDateToDrop: string (date-time)
  Read Only: true

  The last date the student can drop the course section without penalty.
• LastDateToDropWithGreaterPenalty: string (date-time)
  Read Only: true

  The last date the student can drop the course section with a greater drop penalty.
• LastDateToDropWithoutRetain: string (date-time)
  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)
  Read Only: true

  The last date the student can drop the course section with some sort of drop penalty applied.
• LastDateToDropWithRetain: string (date-time)
  Read Only: true

  The last date the student can drop the course section and receive a withdraw status.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  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
  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
  Read Only: true

  The minimum number of units for which a course can be taken.
• OfferSequenceNumber: integer (int64)
  The offering sequence number for the course.
• RepeatAllowedFlag: boolean
  Read Only: true

  Indicates that repeating the course is allowed. The default value is false.
• RepeatAllowedTotal: integer
  Read Only: true

  The total number of times a student can take a course.
• RepeatInPeriodFlag: boolean
  Read Only: true

  Indicates that repeating the course is allowed within the same period.
• RepeatUnitsTotal: number
  Read Only: true

  The total number of repeated units which are allowed for the course.
• RequisiteExistsFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates that requisites exist for the enrolled course.
• RequisiteInformation: string
  Read Only: true

  Maximum Length: 255

  The text used to describe the requisites of a course.
• ScheduledCourseCampusId: integer
  Read Only: true

  The unique identifier for the campus where the course section is offered.
• ScheduledCourseCampusName: string
  Read Only: true

  Maximum Length: 255

  The name of the campus where the course section is offered.
• ScheduledCourseCode: string
  Read Only: true

  The section code of the course section.
• ScheduledCourseEndDate: string (date-time)
  Read Only: true

  The date when the course section ends.
• ScheduledCourseStartDate: string (date-time)
  Read Only: true

  The date when the course section starts.
• ScheduledItemId: integer (int64)
  Read Only: true

  The unique identifier of the scheduled item.
• TotalEnrolledQuantity: integer
  Read Only: true

  The number of students currently enrolled in the course section.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatInPeriodFlag":{
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed within the same period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentCapacityQuantity":{
            "type":"integer",
            "description":"The enrollment capacity of the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreditTypeMeaning":{
            "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
        },
        "ItemCurriculumTypeName":{
            "maxLength":50,
            "type":"string",
            "description":"The type name of the curriculum that's scheduled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "ScheduledItemId":{
            "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
        },
        "RepeatAllowedTotal":{
            "type":"integer",
            "description":"The total number of times a student can take a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CourseEnrollmentStatusMeaning":{
            "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"
                ]
            }
        },
        "ClassStartDateOption":{
            "type":"string",
            "description":"The requested start date for the self-paced course.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EnrolledCreditsOption":{
            "type":"number",
            "description":"The number of credits the student wants to enroll in.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsSelfPacedFlag":{
            "type":"boolean",
            "description":"Indicates that the course section is self-paced. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDateToDropWithPenalty":{
            "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
        },
        "TotalEnrolledQuantity":{
            "type":"integer",
            "description":"The number of students currently enrolled in the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCode":{
            "type":"string",
            "description":"The section code of the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCampusName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the campus where the course section is offered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AcademicSubjectId":{
            "type":"integer",
            "description":"The unique identifier for the subject of the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteInformation":{
            "maxLength":255,
            "type":"string",
            "description":"The text used to describe the requisites of a course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DropEnabledFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates the student is allowed to drop the course section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemCurriculumId":{
            "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
        },
        "CourseEnrollmentStatusCode":{
            "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"
                ]
            }
        },
        "CurriculumCatalogNumber":{
            "type":"string",
            "description":"The catalog number for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseStartDate":{
            "type":"string",
            "description":"The date when the course section starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentRequestStatusCode":{
            "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-queryable":true
        },
        "GradingOptionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The grading method option selected by the student for enrollment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditOptionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The type of credit the student is enrolling in.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AcademicLevelIdOption":{
            "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
        },
        "LastDateToDropWithRetain":{
            "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
        },
        "CurriculumOptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated enrollment options record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RequisiteExistsFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that requisites exist for the enrolled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepeatUnitsTotal":{
            "type":"number",
            "description":"The total number of repeated units which are allowed for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepeatAllowedFlag":{
            "type":"boolean",
            "description":"Indicates that repeating the course is allowed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CourseOfferingId":{
            "type":"integer",
            "description":"The offering identifier for the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CourseCurriculumId",
                    "OfferSequenceNumber"
                ]
            },
            "x-queryable":true
        },
        "ItemCurriculumTypeId":{
            "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
        },
        "AcademicSubjectName":{
            "type":"string",
            "description":"The subject name for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseEndDate":{
            "type":"string",
            "description":"The date when the course section ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduledCourseCampusId":{
            "type":"integer",
            "description":"The unique identifier for the campus where the course section is offered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDateToDrop":{
            "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
        },
        "CurriculumFormatMeaning":{
            "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
        },
        "CalculatedClassEndDate":{
            "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
        },
        "MinimumUnitsQuantity":{
            "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
            }
        },
        "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
        },
        "LastDateToDropWithoutRetain":{
            "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
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "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
        },
        "AcademicSubjectCode":{
            "type":"string",
            "description":"The subject code for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferSequenceNumber":{
            "type":"integer",
            "description":"The offering sequence number for the course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "CreditTypeCode":{
            "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
        },
        "EnrollmentRequestStatusMeaning":{
            "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
        },
        "LastDateToDropWithGreaterPenalty":{
            "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
        },
        "MaximumUnitsQuantity":{
            "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
            }
        },
        "CourseCurriculumId":{
            "type":"integer",
            "description":"The curriculum item identifier for the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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)
  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)
  Read Only: true

  The image data of the instructor.
• PersonImageId: integer (int64)
  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
  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)
  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
  Read Only: true

  Maximum Length: 80

  The role that the course section staff will be filling.

{
    "type":"object",
    "properties":{
        "StaffAdministratorOnlyFlag":{
            "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
        },
        "CurriculumOrgId":{
            "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
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"The primary instructor of the course section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageContent":{
            "type":"string",
            "description":"The image data of the instructor.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "StaffRoleTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The role that the course section staff will be filling.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PersonImageId":{
            "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
        },
        "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 instructor if one is available.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "StaffPartyId":{
            "type":"integer",
            "description":"The unique identifier for the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        }
    }
}

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 : 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
  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
  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)
  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
  Read Only: true

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

  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":{
        "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
        },
        "LocationLongName":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The scheduled end date of the meeting.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The scheduled end 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumScheduleId":{
            "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
        },
        "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
        },
        "CurriculumFormatMeaning":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the meeting pattern for the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "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
        },
        "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
        },
        "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
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The scheduled start time of the meeting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        }
    }
}

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

Type: object

Show Source

• AcademicPeriodDateId: integer (int64)
  Title: Academic Period Date ID

  The unique identifier for an academic period date attribute.
• DateTimeCode: string
  Title: Date Time Code

  Read Only: true

  Maximum Length: 30

  The unique code identifier for the date attribute.
• DateTimeId: integer (int64)
  Title: Period Attribute ID

  The unique identifier for the date attribute associated with the academic period.
• DateTimeMeaning: string
  Title: Date Time Meaning

  Read Only: true

  Maximum Length: 50

  The name of the identifier for the date attribute.
• FirstDateTime: string (date-time)
  Title: Date

  The date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecondDateTime: string (date-time)
  Title: Date Range End

  The end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.

{
    "type":"object",
    "properties":{
        "AcademicPeriodDateId":{
            "title":"Academic Period Date ID",
            "type":"integer",
            "description":"The unique identifier for an academic period date attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FirstDateTime":{
            "title":"Date",
            "type":"string",
            "description":"The date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DateTimeCode":{
            "title":"Date Time Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code identifier for the date attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateTimeId":{
            "title":"Period Attribute ID",
            "type":"integer",
            "description":"The unique identifier for the date attribute associated with the academic period.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "SecondDateTime":{
            "title":"Date Range End",
            "type":"string",
            "description":"The end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DateTimeMeaning":{
            "title":"Date Time Meaning",
            "maxLength":50,
            "type":"string",
            "description":"The name of the identifier for the date attribute.",
            "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