Get a meeting pattern
get
/fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems/{scheduledCourseItemsUniqID}/child/scheduledCourses/{scheduledCoursesUniqID}/child/meetingPatterns/{meetingPatternsUniqID}
Request
Path Parameters
-
CartHeaderId(required): integer(int64)
The unique identifier of the shopping cart header.
-
meetingPatternsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ScheduleSequenceNumber and CurriculumScheduleId ---for the Meeting Patterns resource and used to uniquely identify an instance of Meeting Patterns. The client should not generate the hash key value. Instead, the client should query on the Meeting Patterns collection resource with a filter on the primary key values in order to navigate to a specific instance of Meeting Patterns.
For example: meetingPatterns?q=ScheduleSequenceNumber=<value1>;CurriculumScheduleId=<value2> -
scheduledCourseItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Scheduled Course Items resource and used to uniquely identify an instance of Scheduled Course Items. The client should not generate the hash key value. Instead, the client should query on the Scheduled Course Items collection resource in order to navigate to a specific instance of Scheduled Course Items to get the hash key.
-
scheduledCoursesUniqID(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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response
Type:
Show Source
object
-
BuildingName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
Code
Read Only:true
Maximum Length:6
The unique identifier of the building associated with the meeting pattern of the scheduled course. -
CurriculumScheduleId: integer
(int64)
Read Only:
true
The generated primary key column for a meeting pattern of the scheduled course. -
DurationQuantity: integer
(int32)
Title:
Duration
Read Only:true
The numeric value that indicates the length of a meeting of the scheduled course. -
FacilityDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the meeting pattern of the scheduled course. -
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
Maximum Length:10
The room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
Facility
Read Only:true
Maximum Length:20
The identifier of the facility associated with the meeting pattern of the scheduled course. -
InstructionalMethodCode: string
Read Only:
true
Maximum Length:30
The instructional method code of the meeting. -
InstructionalMethodMeaning: string
Read Only:
true
Maximum Length:80
The instructional method meaning of the meeting. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control Code
Read Only:true
Maximum Length:30
Default Value:ORA_USE_FACILITY
The unique identifier of the single use location associated with the meeting pattern of the scheduled course. -
LocationLatitude: number
Title:
Latitude
Read Only:true
The GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: number
Title:
Longitude
Read Only:true
The GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long Name
Read Only:true
The name of the single use location associated with the meeting pattern of the scheduled course. -
MeetingPatternDescription: string
Title:
Pattern Name
Read Only:true
Maximum Length:50
The name of the meeting pattern of the scheduled course. -
MeetingPatternEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the meeting pattern of the scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the meeting pattern of the scheduled course ends. -
MeetingPatternName: string
Title:
Meeting Name
Read Only:true
Maximum Length:50
The meeting name of the course scheduled in the facility. -
MeetingPatternStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the meeting pattern of the scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The time when the meeting pattern of the scheduled course starts. -
RecurrenceDayFriFlag: boolean
Title:
Friday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Friday. -
RecurrenceDayMonFlag: boolean
Title:
Monday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Monday. -
RecurrenceDaySatFlag: boolean
Title:
Saturday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Saturday. -
RecurrenceDaySunFlag: boolean
Title:
Sunday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Sunday. -
RecurrenceDayThuFlag: boolean
Title:
Thursday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Thursday. -
RecurrenceDayTueFlag: boolean
Title:
Tuesday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
Wednesday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence Number
Read Only:true
The sequence identifier of the meeting pattern of the scheduled course.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.