Service Directory > v31.2 > Human_Resources > Get_Change_Veteran_Status_Identification
 

Operation: Get_Change_Veteran_Status_Identification

This web service request gets veteran status identification for a worker. The response can be used as input to the web service request Change Veteran Status Identification.


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

This request element contains the necessary data for requesting Veteran Status Identifications of a Worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Change_Veteran_Status_Identification_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Change_Veteran_Status_Identification_Response

Element containing the Change Veteran Status Identification response elements including echoed request data and request references.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Change_Veteran_Status_Identification_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Change_Veteran_Status_Identification_Response_Data  [0..1]  Element containing the worker data for the Veteran Status Identification response.   
top
 

Get_Change_Veteran_Status_Identification_Request_References

part of: Get_Change_Veteran_Status_Identification_Request, Get_Change_Veteran_Status_Identification_Response
Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..*]  A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345". If Skip Non Existing Instances value is set to true. When a reference id value that does not meet the entry date criteria is passed, the non existent reference id will be ignored.   
top
 

WorkerObject

part of: Veteran_Status_Identification_Data, Get_Change_Veteran_Status_Identification_Request_References
 
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
 

Response_Filter

part of: Get_Change_Veteran_Status_Identification_Request, Get_Change_Veteran_Status_Identification_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_Change_Veteran_Status_Identification_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
 

Change_Veteran_Status_Identification_Response_Data

part of: Get_Change_Veteran_Status_Identification_Response
Element containing the worker data for the Veteran Status Identification response.
 
Parameter name Type/Value Cardinality Description Validations
Change_Veteran_Status_Identification  Change_Veteran_Status_Identification  [0..*]  This request element contains the data element for Veteran Status Identification for a Worker.   
top
 

Change_Veteran_Status_Identification

part of: Change_Veteran_Status_Identification_Response_Data
This request element contains the data element for Veteran Status Identification for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
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
 

Veteran_Status_Identification_Data

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

WorkerReferenceEnumeration

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