Service Directory > v31.2 > Recruiting > Get_Veteran_Statuses
 

Operation: Get_Veteran_Statuses

Returns Veteran Statuses by Reference ID, or returns all Veteran Statuses if no Reference ID is provided.


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

Contains request reference, criteria, and filter for getting Veteran Status data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Veteran_Status_Request_References  [0..1]  Wrapper element containing references to specific Veteran Statuses.   
Request_Criteria [Choice]   Veteran_Status_Request_Criteria  [0..1]  Wrapper element around a list of elements representing the Customer specific criteria needed to search for instances (all of the elements are "AND" conditions). These are attributes and/or references that provide an alternate way to find instances or data outside of the Workday IDs and Lookup IDs contained within the "Request_References" element.   
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_Veteran_Statuses_Response

Contains request reference, criteria, filter and response group for getting Veteran Status data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Veteran_Status_Request_References  [0..1]  Contains Veteran Status references.   
Request_Criteria  Veteran_Status_Request_Criteria  [0..1]  Utilize the following criteria options to search for Veteran Statuses within the Workday system. The Veteran Status references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.   
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  Veteran_Status_Response_Data  [0..1]  Contains Veteran Status data.   
top
 

Veteran_Status_Request_References

part of: Get_Veteran_Statuses_Response, Get_Veteran_Statuses_Request
Contains Veteran Status references.
 
Parameter name Type/Value Cardinality Description Validations
Veteran_Status_Reference  Veteran_StatusObject  [1..*]  Veteran Status Request References.   
top
 

Veteran_StatusObject

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

Veteran_StatusObjectID

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

Veteran_Status_Request_Criteria

part of: Get_Veteran_Statuses_Response, Get_Veteran_Statuses_Request
Utilize the following criteria options to search for Veteran Statuses within the Workday system. The Veteran Status references that are returned are those that satisfy ALL criteria included in the request. Therefore, the result set will become more limited with every criterium that is populated.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Veteran_Statuses_Response, Get_Veteran_Statuses_Request
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_Veteran_Statuses_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
 

Veteran_Status_Response_Data

part of: Get_Veteran_Statuses_Response
Contains Veteran Status data.
 
Parameter name Type/Value Cardinality Description Validations
Veteran_Status  Veteran_Status  [0..*]  Contains ID, Order, Veteran Status Name, Description, Inactive, and Global Setup Data Mapping.   
top
 

Veteran_Status

part of: Veteran_Status_Response_Data
Contains Veteran Status data.
 
Parameter name Type/Value Cardinality Description Validations
Veteran_Status_Reference  Veteran_StatusObject  [0..1]  Reference to a Veteran Status.   
Veteran_Status_Data  Veteran_Status_Data  [0..*]  Contains Veteran Status data.   
top
 

Veteran_Status_Data

part of: Veteran_Status
Contains ID, Order, Veteran Status Name, Description, Inactive, and Global Setup Data Mapping.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique identifier for the Veteran Status. 
Validation Description
Enter another veteran status ID because this 1 already exists: [ID]  No duplicate Veteran Status IDs. 
 
Order  string (6)   [0..1]  Order   
Veteran_Status_Name  string  [0..1]  Veteran Status name. 
Validation Description
Enter a Veteran Status Name.  Veteran Status Name must be provided. 
Enter another Veteran Status Name because this 1 already exists: [name]  No duplicate Veteran Status Names. 
 
Description  string  [0..1]  Veteran Status description.   
Inactive  boolean  [0..1]  Indicates whether Veteran Status is active/inactive.   
Global_Setup_Data_Mapping_Reference  Global_Setup_Data_MappingObject  [0..1]  Global setup data mapping. 
Validation Description
Enter a value for Global Setup Data Mapping.  Must provide global setup data mapping. 
 
top
 

Global_Setup_Data_MappingObject

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

Global_Setup_Data_MappingObjectID

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

part of: Veteran_StatusObjectID
Base Type
string
top
 

Global_Setup_Data_MappingReferenceEnumeration

part of: Global_Setup_Data_MappingObjectID
Base Type
string
top