Service Directory > v32.1 > Student_Records > Get_Instructor_Eligibility
 

Operation: Get_Instructor_Eligibility

Public Web Service for Get Instructor Eligibility. * Does not support Request References * If criteria is specified, then Academic Appointee Enabled AND Snapshot Effective Date are required. * If no criteria is specified, the current Instructor Eligibility snapshot for the Academic Appointee Enabled is returned.


@ - 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_Instructor_Eligibility_Request

Instructor Eligibility Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Instructor_Eligibility_Request_References  [0..1]  Instructor Eligibility Request References   
Request_Criteria [Choice]   Instructor_Eligibility_Request_Criteria  [0..1]  Instructor Eligibility Request Criteria   
Response_Filter  Response_Filter  [0..1]  Instructor Eligibility Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Instructor_Eligibility_Response

Instructor Eligibility Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Instructor_Eligibility_Request_References  [0..1]  Instructor Eligibility Request References   
Request_Criteria  Instructor_Eligibility_Request_Criteria  [0..1]  Instructor Eligibility Request Critieria   
Response_Filter  Response_Filter  [0..1]  Instructor Eligibility Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Instructor Eligibility Response Results   
Response_Data  Instructor_Eligibility_Response_Data  [0..1]  Instructor Eligibility Response Data   
top
 

Instructor_Eligibility_Request_References

part of: Get_Instructor_Eligibility_Request, Get_Instructor_Eligibility_Response
Instructor Eligibility Request References
 
Parameter name Type/Value Cardinality Description Validations
top
 

Instructor_Eligibility_Request_Criteria

part of: Get_Instructor_Eligibility_Request, Get_Instructor_Eligibility_Response
Instructor Eligibility Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  The effective snapshot date for this Instructor Eligibility   
Academic_Appointee_Reference  Academic_Appointee_EnabledObject  [1..1]  The Academic Appointee Enabled for this Instructor Eligibility   
top
 

Academic_Appointee_EnabledObject

part of: Instructor_Eligibility_Request_Criteria, Instructor_Eligibility_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  Academic_Appointee_EnabledObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_Appointee_EnabledObjectID

part of: Academic_Appointee_EnabledObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Person_ID, Contingent_Worker_ID, Employee_ID, Student_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
 

Response_Filter

part of: Get_Instructor_Eligibility_Request, Get_Instructor_Eligibility_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_Instructor_Eligibility_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
 

Instructor_Eligibility_Response_Data

part of: Get_Instructor_Eligibility_Response
Instructor Eligibility Response Data
 
Parameter name Type/Value Cardinality Description Validations
Instructor_Eligibility  Instructor_Eligibility  [0..*]  Instructor Eligibility element   
top
 

Instructor_Eligibility

part of: Instructor_Eligibility_Response_Data
Instructor Eligibility element
 
Parameter name Type/Value Cardinality Description Validations
Instructor_Eligibility_Data  Instructor_Eligibility_Data  [0..*]  Instructor Eligibility Data element 
Validation Description
Academic Unit is invalid for Instructor's Academic Appointment Track   
 
top
 

Instructor_Eligibility_Data

part of: Instructor_Eligibility
Instructor Eligibility Data element
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointee_Enabled_Reference  Academic_Appointee_EnabledObject  [0..1]  Academic Appointee for this Instructor Eligibility   
Snapshot_Effective_Date  date  [0..1]  Snapshot Effective Date   
Academic_Unit_Reference  Academic_UnitObject  [0..1]  Academic Unit for Academic Appointment Track   
Instructor_Eligibility_Line_Data  Instructor_Eligibility_Line_Data  [0..*]  Instructor Eligibility Line data for this Instructor Eligibility 
Validation Description
Eligibility line must contain at least one criteria.   
 
Inactive  boolean  [0..1]  Inactive Instructor Eligibility boolean for Academic Appointee   
Validation Description
Academic Unit is invalid for Instructor's Academic Appointment Track   
top
 

Academic_UnitObject

part of: Instructor_Eligibility_Line_Data, Instructor_Eligibility_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  Academic_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_UnitObjectID

part of: Academic_UnitObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Unit_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
 

Instructor_Eligibility_Line_Data

part of: Instructor_Eligibility_Data
Contains Instructor Eligibility Line Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [0..1]  Academic unit where the instructor is eligible to teach. 
Validation Description
The Academic Unit must be configured for the Academic Level on the Snapshot Date, with "Offer Courses" configuration option.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic levels that the instructor is eligible to teach. 
Validation Description
Academic Level(s) must be valid for Academic Unit and Snapshot Effective Date.   
 
Course_Subject_Reference  Course_SubjectObject  [0..*]  Course subjects that the instructor is eligible to teach. 
Validation Description
Course subject(s) must be valid. A course subject is valid if: The academic unit of the course subject is in common with the academic unit for this eligibility line.   
 
Course_Reference  Course_DefinitionObject  [0..*]  Courses that the instructor is eligible to teach. 
Validation Description
Course must be valid. A course is valid if: 1) The academic level for the course is in common with the academic levels for this eligibility line. 2) The academic unit(s) for the course is in common with the academic unit for this eligibility line. 3) The course subject for the course is in common with the course subjects for this eligibility line.   
 
Delivery_Mode_Reference  Delivery_ModeObject  [0..*]  Delivery modes for which the instructor is eligible. 
Validation Description
Select a Student Specific Delivery Mode.   
 
Course_Tag_Reference  Student_Course_TagObject  [0..*]  Course tags for the courses that the instructor is eligible to teach.   
Location_Reference  LocationObject  [0..*]  Locations where the instructor is eligible to teach. 
Validation Description
All Locations must be Campus Locations.   
 
Educational_Taxonomy_Code_Reference  Educational_Taxonomy_CodeObject  [0..*]  Educational taxonomy codes for the courses that the instructor is eligible to teach. 
Validation Description
Select an active Educational Taxonomy Code that is part of an active taxonomy scheme.   
 
Validation Description
Eligibility line must contain at least one criteria.   
top
 

Academic_LevelObject

part of: Instructor_Eligibility_Line_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  Academic_LevelObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_LevelObjectID

part of: Academic_LevelObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_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
 

Course_SubjectObject

part of: Instructor_Eligibility_Line_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  Course_SubjectObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Course_SubjectObjectID

part of: Course_SubjectObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Course_Subject_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
 

Course_DefinitionObject

part of: Instructor_Eligibility_Line_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  Course_DefinitionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Course_DefinitionObjectID

part of: Course_DefinitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Course_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
 

Delivery_ModeObject

part of: Instructor_Eligibility_Line_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  Delivery_ModeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Delivery_ModeObjectID

part of: Delivery_ModeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Delivery_Mode_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
 

Student_Course_TagObject

part of: Instructor_Eligibility_Line_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  Student_Course_TagObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Course_TagObjectID

part of: Student_Course_TagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Course_Tag_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
 

LocationObject

part of: Instructor_Eligibility_Line_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  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_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
 

Educational_Taxonomy_CodeObject

part of: Instructor_Eligibility_Line_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  Educational_Taxonomy_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Educational_Taxonomy_CodeObjectID

part of: Educational_Taxonomy_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Educational_Taxonomy_Code_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
 

Academic_Appointee_EnabledReferenceEnumeration

part of: Academic_Appointee_EnabledObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Course_SubjectReferenceEnumeration

part of: Course_SubjectObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Delivery_ModeReferenceEnumeration

part of: Delivery_ModeObjectID
Base Type
string
top
 

Student_Course_TagReferenceEnumeration

part of: Student_Course_TagObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Educational_Taxonomy_CodeReferenceEnumeration

part of: Educational_Taxonomy_CodeObjectID
Base Type
string
top