Get an instructor
get
/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}/child/instructors/{CurriculumStaffId}
Request
Path Parameters
-
CurriculumStaffId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
enrolledItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Enrolled Items resource and used to uniquely identify an instance of Enrolled Items. The client should not generate the hash key value. Instead, the client should query on the Enrolled Items collection resource in order to navigate to a specific instance of Enrolled Items to get the hash key.
-
schedulePeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Schedule Periods resource and used to uniquely identify an instance of Schedule Periods. The client should not generate the hash key value. Instead, the client should query on the Schedule Periods collection resource in order to navigate to a specific instance of Schedule Periods to get the hash key.
-
studentScheduleByPeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Schedule by Periods resource and used to uniquely identify an instance of Student Schedule by Periods. The client should not generate the hash key value. Instead, the client should query on the Student Schedule by Periods collection resource in order to navigate to a specific instance of Student Schedule by Periods to get the hash key.
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
-
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 : studentScheduleByPeriods-schedulePeriods-enrolledItems-instructors-item-response
Type:
Show Source
object
-
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.
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.