Service Directory > v31.2 > Human_Resources > Update_Academic_Appointment
 

Operation: Update_Academic_Appointment

This operation will invoke the Business Process to update 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: Update_Academic_Appointment_Request

Top-level request element to update 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.   
Update_Academic_Appointment_Data  Update_Academic_Appointment_Data  [1..1]  Wrapper element for the Update Academic Appointment business process.   
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: Update_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
 

Update_Academic_Appointment_Data

part of: Update_Academic_Appointment_Request
Wrapper element for the Update Academic Appointment business process.
 
Parameter name Type/Value Cardinality Description Validations
Reason_Reference  General_Event_SubcategoryObject  [1..1]  Reference ID for the reason for the academic appointment event.   
Academic_Appointee_Reference  Academic_Appointee_EnabledObject  [1..1]  Reference ID for the person this academic appointment is for. 
Validation Description
Update Academic Appointment requires an appointee.   
An employment position is not allowed when processing an appointment for the appointee.   
The appointee isn’t allowed when processing their appointment as a sub-process.   
 
Academic_Appointment_Data  Academic_Appointment_Snapshot_Data  [1..1]  Used to set or update the Reference ID for the Appointment Thread. The value cannot already be in use by a different appointment thread. 
Validation Description
Update Date must be prior to the Academic Appointment End Date   
The key Reference ID for the Academic Appointment Track/Thread is required for an Update Academic Appointment request.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
 
top
 

General_Event_SubcategoryObject

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

Academic_Appointee_EnabledObject

part of: Academic_Appointment_Response, Update_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  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_Snapshot_Data

part of: Update_Academic_Appointment_Data
Element containing the specifics for the academic appointment being added or updated. An academic appointment tracks an academic worker’s time at a university or college.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [0..1]  Reference ID for the academic appointment thread being updated. Required on Update Academic Appointment events. Leave blank on Add Academic Appointment events. 
Validation Description
The academic appointment isn’t valid for this appointee.   
 
Appointment_Track_ID  string  [0..1]  Unique identifier for academic appointment track. 
Validation Description
The Academic Appointment Track ID you specified is already in use.   
 
Track_Type_Reference  Academic_Track_TypeObject  [0..1]  Reference ID for the academic track type. 
Validation Description
Academic Track Type is required for Add Academic Appointment.   
Updates to Academic Track Type are not allowed for Update Academic Appointment   
Inactive Academic Track Types are not allowed.   
This Academic Track Type is not allowed by the Academic Unit.   
The Academic Track Type Category for this Track Type is set to Inactive.   
 
Appointment_Identifier_Reference  Academic_Appointment_IdentifierObject  [1..1]  Indicates the type of appointment, such as primary, joint, or dual. Workday recommends only 1 primary active academic appointment.   
Position_Reference  Position_ElementObject  [0..1]  Appointee's filled position that's associated with an academic appointment. Can't use on the Hire subprocess, because the position isn't filled yet. 
Validation Description
[position] is not currently a valid Position for worker [worker].   
 
Academic_Unit_Reference  Academic_UnitObject  [1..1]  Reference ID for the academic unit. 
Validation Description
Select an Academic Unit that is available as of [Start Date].   
Select an Academic Unit that is available as of [Start Date].   
 
Roster_Percent  decimal (7, 4) >0   [0..1]  Percent of the academic appointee's total time on an academic appointment. Between 0.00 and 1.00. May be blank or zero for things like centers and institutes. 
Validation Description
Roster Percent cannot be greater than 100 percent (1.0).   
 
Appointment_Start_Date  date  [1..1]  Date when the appointment becomes effective or takes effect. 
Validation Description
[Academic Appointment Start Date Validation]   
 
Appointment_End_Date  date  [0..1]  Date when the academic appointment is intended to end. To end academic appointments, you must complete an End Academic Appointment Track event. 
Validation Description
Appointment End Date must be greater than the Appointment Start Date.   
 
Track_Start_Date_Override  date  [0..1]  Override for academic appointment track start date. 
Validation Description
The value supplied for the Track Start Date must be less than or equal to the Appointment Start Date.   
 
Rank_Reference  Academic_RankObject  [0..1]  Reference ID for the academic rank. 
Validation Description
The Academic Rank must be an allowed value for the Academic Track Type.   
 
Named_Professorship_Reference  Named_ProfessorshipObject  [0..1]  Reference ID for the named professorship. 
Validation Description
[professorship] is not a valid Named Professorship for the Appointment as it is in a Pending status.   
[professorship] is not a valid Named Professorship for the Appointment as it has been associated with the current Appointment track in the past.   
[professorship] is not a valid Named Professorship for the Appointment as it associated with In-Progress Edit Named Professorship event.   
[professorship] is not a valid Named Professorship for the Appointment as it associated with an In-Progress Academic Appointment event.   
[professorship] is not a valid Named Professorship for the Appointment as it is in a Discontinued status.   
[professorship] is not a valid Named Professorship for the Appointment as it is in a On Hold status.   
[professorship] is not a valid Named Professorship for the Appointment as it is Filled.   
[professorship] is not a valid Named Professorship for the Appointment as the Initial Established Date is greater than Appointment Start Date.   
 
Appointment_Specialty_Reference  Appointment_SpecialtyObject  [0..1]  Reference ID for the appointment specialty. 
Validation Description
Enter an active Appointment Specialty.   
Enter an Appointment Specialty that is associated with 1 of these: the appointment's Academic Unit, Academic Unit Hierarchy or its superiors.   
 
Constructed_Title  string  [0..1]  Do not enter, Constructed Title will be defaulted and used if all fields pertaining to rule set for track is supplied. 
Validation Description
Do not enter, Constructed Title will be defaulted and used if all fields pertaining to rule set for track is supplied.   
 
Appointment_Title  string  [1..1]  Title for the academic appointment.   
Adjusted_Title_Start_Date  date  [0..1]  Date when the academic appointment title was designated.   
Academic_Review_Date  date  [0..1]  Manually maintained date that acts as a reminder to review the academic for promotion. Only applies when the Appointment’s Track includes a Promotion program. On an update, the existing value will be retained if not sent. 
Validation Description
Academic Review Date must be greater than the Appointment Start Date.   
 
Related_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Reference ID for the related academic unit. 
Validation Description
Select a Related Academic Unit that is available as of [Start Date].   
Select a Related Academic Unit that is available as of [Start Date].   
 
Tenure_Home_Reference  Academic_UnitObject  [0..1]  Reference ID for the academic unit for the tenure track appointment. 
Validation Description
Tenure Home is required If the track type includes a tenure program. Otherwise, Tenure Home is not allowed.   
Select a Tenure Home that is available as of [Start Date].   
Select a Tenure Home that is available as of [Start Date].   
 
Tenure_Status_Reference  Academic_Tenure_StatusObject  [0..1]  Reference ID for the tenure status. 
Validation Description
Tenure Status is not allowed if the Academic Track does not include a tenure program.   
Tenure Status Reference is required if the Academic Track includes tenure program.   
 
Probationary_End_Date  date  [0..1]  Date when the tenure probationary period ends. 
Validation Description
Probationary End Date is not allowed if the Academic Track Type does not include a tenure program.   
Probationary End Date must be greater than the Appointment Start Date.   
Probationary end date is not allowed if the academic tenured status has a value of true for "tenured."   
 
Tenure_Award_Date  date  [0..1]  Date when the academic appointee was awarded tenure. 
Validation Description
Tenure Award Date is not allowed if the Academic Track does not include a tenure program.   
Tenure Award Date is required if Academic Tenure Status is set to Tenured.   
Tenure Award Date is not allowed if the Academic Tenure Status is not Tenured.   
 
Validation Description
Update Date must be prior to the Academic Appointment End Date   
The key Reference ID for the Academic Appointment Track/Thread is required for an Update Academic Appointment request.   
Appointment Tracks with an In-Progress event cannot be updated or ended until the In-Progress event is completed or cancelled   
top
 

Academic_Appointment_TrackObject

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

Academic_Track_TypeObject

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

Academic_Track_TypeObjectID

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

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

Academic_Appointment_IdentifierObjectID

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

Position_ElementObject

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

Position_ElementObjectID

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

Academic_RankObject

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

Academic_RankObjectID

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

Named_ProfessorshipObject

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

Named_ProfessorshipObjectID

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

Appointment_SpecialtyObject

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

Appointment_SpecialtyObjectID

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

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

Academic_Tenure_StatusObjectID

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

General_Event_SubcategoryReferenceEnumeration

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

Academic_Track_TypeReferenceEnumeration

part of: Academic_Track_TypeObjectID
Base Type
string
top
 

Academic_Appointment_IdentifierReferenceEnumeration

part of: Academic_Appointment_IdentifierObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_RankReferenceEnumeration

part of: Academic_RankObjectID
Base Type
string
top
 

Named_ProfessorshipReferenceEnumeration

part of: Named_ProfessorshipObjectID
Base Type
string
top
 

Appointment_SpecialtyReferenceEnumeration

part of: Appointment_SpecialtyObjectID
Base Type
string
top
 

Academic_Tenure_StatusReferenceEnumeration

part of: Academic_Tenure_StatusObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top