Service Directory > v32.1 > Student_Records > Submit_Instructor_Eligibility
 

Operation: Submit_Instructor_Eligibility

Submit Instructor Eligibility web service. * This web service task will initiate a Business Process. Business Process configurations (like Auto-Complete) are made in the Business Process Parameters element.


@ - 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: Submit_Instructor_Eligibility_Request

Submit Instructor Eligibility Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Business Process Parameters   
Instructor_Eligibility_Data  Instructor_Eligibility_Data  [1..1]  Instructor Eligibility Data element 
Validation Description
Academic Unit is invalid for Instructor's Academic Appointment Track   
 
top
 

Response Element: Submit_Instructor_Eligibility_Response

Submit Instructor Eligibility Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Instructor_Eligibility_Data  Instructor_Eligibility_Data  [0..1]  Instructor Eligibility Data element 
Validation Description
Academic Unit is invalid for Instructor's Academic Appointment Track   
 
top
 

Business_Process_Parameters

part of: Submit_Instructor_Eligibility_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_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
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

part of: Submit_Instructor_Eligibility_Request, Submit_Instructor_Eligibility_Response
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_Appointee_EnabledObject

part of: 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
 

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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
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