Service Directory > v31.2 > Recruiting > Put_Veteran_Status
 

Operation: Put_Veteran_Status

Creates a new Veteran Status with the information supplied in the request.


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

Contains all the request data to add or update a Veteran Status.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Delete Flag 
Validation Description
You can't delete this Veteran Status because it is being used: [Veteran Status]  In-use Veteran Statuses cannot be deleted. 
Enter a reference ID for the Veteran Status you're deleting.  Reference ID must be provided to allow delete. 
 
Veteran_Status_Reference  Veteran_StatusObject  [0..1]  Reference element representing a unique instance of Veteran Status.   
Veteran_Status_Data  Veteran_Status_Data  [0..1]  Contains ID, Order, Veteran Status Name, Description, Inactive, and Global Setup Data Mapping.   
Validation Description
The web service is set to add only, but the Veteran Status already exists.   
Enter information in the Veteran Status Data element.   
top
 

Response Element: Put_Veteran_Status_Response

Wrapper element for Put Veteran Status response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Veteran_Status_Reference  Veteran_StatusObject  [0..1]  Reference to a Veteran Status.   
top
 

Veteran_StatusObject

part of: Put_Veteran_Status_Response, Put_Veteran_Status_Request
 
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_Data

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