Service Directory > v32.1 > Learning > Get_Learning_Instructors
 

Operation: Get_Learning_Instructors

Retrieves instructors.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Learning_Instructors_Request

Contains references to find and get instructors and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Instructor_Request_References  [0..1]  Retrieves specific instances of instructors and their associated data.   
Request_Criteria [Choice]   Learning_Instructor_Request_Criteria  [0..1]  Contains request criteria to get specific instructors.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Learning_Instructors_Response

Contains references to instructors and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Instructor_Request_References  [0..1]  Retrieves specific instances of instructors and their associated data.   
Request_Criteria  Learning_Instructor_Request_Criteria  [0..1]  Contains request criteria to get specific instructors.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Learning_Instructor_Response_Data  [0..1]  Contains instructor data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.   
top
 

Learning_Instructor_Request_References

part of: Get_Learning_Instructors_Request, Get_Learning_Instructors_Response
Retrieves specific instances of instructors and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Instructor_Reference  Learning_InstructorObject  [1..*]  References the instructors in the request.   
top
 

Learning_InstructorObject

part of: Learning_Instructor_Request_References, Learning_Instructor
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_InstructorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_InstructorObjectID

part of: Learning_InstructorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Instructor_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Instructor_Request_Criteria

part of: Get_Learning_Instructors_Request, Get_Learning_Instructors_Response
Container for Learning Instructor Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Learning_Instructors_Request, Get_Learning_Instructors_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Learning_Instructors_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Learning_Instructor_Response_Data

part of: Get_Learning_Instructors_Response
Contains instructor data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Instructor  Learning_Instructor  [0..*]  Contains instructor data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.   
top
 

Learning_Instructor

part of: Learning_Instructor_Response_Data
Contains instructor data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Instructor_Reference  Learning_InstructorObject  [0..1]  Reference for an instructor.   
Learning_Instructor_Data  Learning_Instructor_Data  [0..1]  Contains detailed information about an instructor. 
Validation Description
The instructor can't be a terminated worker.  The instructor can't be a terminated worker. 
You can't add an instructor if the worker is already an instructor.  You can't add an instructor if the worker is already an instructor. 
Enter a valid user. This user is not valid.  Enter a valid user. This user is not valid. 
 
top
 

Learning_Instructor_Data

part of: Learning_Instructor
Contains detailed information about an instructor.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the instructor.   
Worker_Reference  WorkerObject  [1..1]  References the worker of the instructor. The worker can't be terminated.   
Learning_Instructor_Inactive  boolean  [0..1]  Indicates whether the instructor is inactive.   
Validation Description
The instructor can't be a terminated worker.  The instructor can't be a terminated worker. 
You can't add an instructor if the worker is already an instructor.  You can't add an instructor if the worker is already an instructor. 
Enter a valid user. This user is not valid.  Enter a valid user. This user is not valid. 
top
 

WorkerObject

part of: Learning_Instructor_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_InstructorReferenceEnumeration

part of: Learning_InstructorObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top