Service Directory > v32.1 > Human_Resources > End_Academic_Appointment
 

Operation: End_Academic_Appointment

This operation will invoke the Business Process to end an Academic Appointment.


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

Top-level request element to end an academic appointment
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  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.   
End_Academic_Appointment_Data  End_Academic_Appointment_Data  [1..1]  Wrapper element for the End Academic Appointment business process. 
Validation Description
Enter a Track End Date that is after [date_formatted], the most recent add or update date.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
You cannot end an Academic Appointment that is already ended.   
The academic appointment isn’t valid for this appointee.   
The appointee requires an academic appointment track reference because they have more than one academic appointment.   
The appointee has no academic appointments available to end.   
 
top
 

Response Element: Academic_Appointment_Response

Top-level response element for Academic Appointment business process operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Academic Appointment business process.   
Academic_Appointee_Reference  Academic_Appointee_EnabledObject  [0..1]  Academic Appointee Reference relating to Appointment Business Process   
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [0..1]  Reference to the Academic Appointment Track that the business process applies to.   
top
 

Business_Process_Parameters

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

End_Academic_Appointment_Data

part of: End_Academic_Appointment_Request
Wrapper element for the End Academic Appointment business process.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointee_Reference  Academic_Appointee_EnabledObject  [0..1]  Academic Appointee Reference with and Appointment Track to be updated 
Validation Description
The appointee isn’t allowed when processing their appointment as a sub-process.   
An appointee reference is required, unless the end academic appointment business process is a sub-process.   
 
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [0..1]  Reference to the Academic Appointment Track that is being ended.   
Reason_Reference  General_Event_SubcategoryObject  [1..1]  Reference to the Reason for the End Academic Appointment business process.   
Track_End_Date  date  [1..1]  Date that the Academic Appointment Track is being ended.   
Validation Description
Enter a Track End Date that is after [date_formatted], the most recent add or update date.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
You cannot end an Academic Appointment that is already ended.   
The academic appointment isn’t valid for this appointee.   
The appointee requires an academic appointment track reference because they have more than one academic appointment.   
The appointee has no academic appointments available to end.   
top
 

Academic_Appointee_EnabledObject

part of: End_Academic_Appointment_Data, Academic_Appointment_Response
 
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_Appointment_TrackObject

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

Academic_Appointment_TrackObjectID

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

General_Event_SubcategoryObject

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

General_Event_SubcategoryObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Academic_Appointment_TrackObjectID
Base Type
string
top
 

General_Event_SubcategoryReferenceEnumeration

part of: General_Event_SubcategoryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top