Service Directory > v31.2 > Human_Resources > Change_Veteran_Status_Identification
 

Operation: Change_Veteran_Status_Identification

This web service assigns Veteran Status Identifications for an Employee.


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

The request element containing all necessary information to assign a Veteran Status Identification for a Worker.
 
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.   
Change_Veteran_Status_Identification_Data  Veteran_Status_Identification_Data  [1..1]  The request element containing all necessary information to assign a Veteran Status Identification for a Worker. 
Validation Description
The Worker must have an active position.   
You may not submit your own Veteran Status Identification.   
The Worker must be an Employee.   
Veteran Status Identification is only available for Workers with a position in the United States of America.   
Protected Veteran Type must be turned on in Maintain Veteran Status Identification Form to use Protected Veteran Type(s).   
Protected Veteran Types must be enabled and Recently Separated Veteran Status must be selected to use Discharge Date.   
Protected Veteran Types are only available for those who identify as a Protected Veteran.   
Veteran Discharge Date is required if the Recently Separated Veteran Status is selected.   
The US Veteran Status (Tenanted) is inactive. Use an active status.   
 
top
 

Response Element: Change_Veteran_Status_Identification_Response

The response element containing all necessary information to assign a Veteran Status Identification for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Self-Identification_of_Veteran_Status_Event_Reference  Unique_IdentifierObject  [0..1]  The Self-Identification of Veteran Status Business Process created from the request.   
Change_Veteran_Status_Identification_Data  Veteran_Status_Identification_Data  [0..*]  The request element containing all necessary information to assign a Veteran Status Identification for a Worker. 
Validation Description
The Worker must have an active position.   
You may not submit your own Veteran Status Identification.   
The Worker must be an Employee.   
Veteran Status Identification is only available for Workers with a position in the United States of America.   
Protected Veteran Type must be turned on in Maintain Veteran Status Identification Form to use Protected Veteran Type(s).   
Protected Veteran Types must be enabled and Recently Separated Veteran Status must be selected to use Discharge Date.   
Protected Veteran Types are only available for those who identify as a Protected Veteran.   
Veteran Discharge Date is required if the Recently Separated Veteran Status is selected.   
The US Veteran Status (Tenanted) is inactive. Use an active status.   
 
top
 

Business_Process_Parameters

part of: Change_Veteran_Status_Identification_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, Veteran_Status_Identification_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
 

Veteran_Status_Identification_Data

part of: Change_Veteran_Status_Identification_Request, Change_Veteran_Status_Identification_Response
The request element containing all necessary information to assign a Veteran Status Identification for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  The Worker for this business process.   
US_Veteran_Tenanted_Reference  US_Veteran_Status__Tenanted_Object  [1..1]  The US Veteran Status to be assigned to the Worker.   
US_Protected_Veteran_Status_Type_Reference  US_Protected_Veteran_Status_TypeObject  [0..*]  The US Protected Veteran Status Types for this Worker's Veteran Status.   
Discharge_Date  date  [0..1]  The discharge date for workers that have been recently separated.   
Validation Description
The Worker must have an active position.   
You may not submit your own Veteran Status Identification.   
The Worker must be an Employee.   
Veteran Status Identification is only available for Workers with a position in the United States of America.   
Protected Veteran Type must be turned on in Maintain Veteran Status Identification Form to use Protected Veteran Type(s).   
Protected Veteran Types must be enabled and Recently Separated Veteran Status must be selected to use Discharge Date.   
Protected Veteran Types are only available for those who identify as a Protected Veteran.   
Veteran Discharge Date is required if the Recently Separated Veteran Status is selected.   
The US Veteran Status (Tenanted) is inactive. Use an active status.   
top
 

US_Veteran_Status__Tenanted_Object

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

US_Veteran_Status__Tenanted_ObjectID

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

US_Protected_Veteran_Status_TypeObject

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

US_Protected_Veteran_Status_TypeObjectID

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

Unique_IdentifierObject

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

US_Veteran_Status__Tenanted_ReferenceEnumeration

part of: US_Veteran_Status__Tenanted_ObjectID
Base Type
string
top
 

US_Protected_Veteran_Status_TypeReferenceEnumeration

part of: US_Protected_Veteran_Status_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top