Jump to

• Request
• Response

Get all meeting patterns

get

/fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}/child/meetingPatterns

Request

Path Parameters

• curriculumItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Curriculum Items resource and used to uniquely identify an instance of Curriculum Items. The client should not generate the hash key value. Instead, the client should query on the Curriculum Items collection resource in order to navigate to a specific instance of Curriculum Items to get the hash key.
• scheduledCourseUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Scheduled Courses resource and used to uniquely identify an instance of Scheduled Courses. The client should not generate the hash key value. Instead, the client should query on the Scheduled Courses collection resource in order to navigate to a specific instance of Scheduled Courses to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all meeting patterns that match the primary key criteria specified.
    Finder Variables
    • CurriculumScheduleId; integer; Unique identifier for the meeting pattern.
    • ScheduleSequenceNumber; integer; Unique identifier for the meeting pattern.
• 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:
  

  • BuildingName; string; The name of the building associated with the meeting pattern of the scheduled course.
  • BuildingShortCode; string; The unique identifier of the building associated with the meeting pattern of the scheduled course.
  • CurriculumScheduleId; integer; The generated primary key column for a meeting pattern of the scheduled course.
  • DurationQuantity; integer; The numeric value that indicates the length of a meeting of the scheduled course.
  • FacilityDescription; string; The description of the meeting pattern of the scheduled course.
  • FacilityRoomNumber; string; The room number associated with the meeting pattern of the scheduled course.
  • FacilityShortCode; string; The identifier of the facility associated with the meeting pattern of the scheduled course.
  • InstructionalMethodCode; string; The instructional method code of the meeting.
  • InstructionalMethodMeaning; string; The instructional method meaning of the meeting.
  • LocationControlCode; string; The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
  • LocationLatitude; number; The GPS latitude coordinates for the scheduled course meeting location.
  • LocationLongName; string; The name of the single use location associated with the meeting pattern of the scheduled course.
  • LocationLongitude; number; The GPS longitude coordinates for the scheduled course meeting location.
  • MeetingPatternDescription; string; The name of the meeting pattern of the scheduled course.
  • MeetingPatternEndDate; string; The date when the meeting pattern of the scheduled course ends.
  • MeetingPatternEndTime; string; The time when the meeting pattern of the scheduled course ends.
  • MeetingPatternName; string; The meeting name of the course scheduled in the facility.
  • MeetingPatternStartDate; string; The date when the meeting pattern of the scheduled course starts.
  • MeetingPatternStartTime; string; The time when the meeting pattern of the scheduled course starts.
  • RecurrenceDayFriFlag; boolean; The unique identifier for the day of the week Friday.
  • RecurrenceDayMonFlag; boolean; The unique identifier for the day of the week Monday.
  • RecurrenceDaySatFlag; boolean; The unique identifier for the day of the week Saturday.
  • RecurrenceDaySunFlag; boolean; The unique identifier for the day of the week Sunday.
  • RecurrenceDayThuFlag; boolean; The unique identifier for the day of the week Thursday.
  • RecurrenceDayTueFlag; boolean; The unique identifier for the day of the week Tuesday.
  • RecurrenceDayWedFlag; boolean; The unique identifier for the day of the week Wednesday.
  • ScheduleSequenceNumber; integer; The sequence identifier of the meeting pattern of the scheduled course.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : curriculumItems-scheduledCourse-meetingPatterns

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-scheduledCourse-meetingPatterns-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• BuildingName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

  Maximum Length: 6

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  Maximum Length: 20

  The identifier of the facility associated with the meeting pattern of the scheduled course.
• InstructionalMethodCode: string
  Title: Instructional Method Code

  Read Only: true

  Maximum Length: 30

  The instructional method code of the meeting.
• InstructionalMethodMeaning: string
  Title: Instructional Method

  Read Only: true

  Maximum Length: 80

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

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

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_USE_FACILITY

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top