Service Directory > v31.2 > Staffing > Put_Citizenship_Status
 

Operation: Put_Citizenship_Status

Adds or updates citizenship status.


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

Request element for the Put Citizenship Status operation
 
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.   
Citizenship_Status_Reference  Citizenship_StatusObject  [0..1]  Reference element representing a unique instance of Citizenship Status.   
Citizenship_Status_Data  Citizenship_Status_Data  [0..1]  Citizenship Status Details   
Validation Description
Citizenship Status ID for [c_status_id] already exists.   
top
 

Response Element: Put_Citizenship_Status_Response

Response element for the Put Citizenship Status operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Citizenship_Status_Reference  Citizenship_StatusObject  [0..1]  Reference element representing a unique instance of Citizenship Status.   
top
 

Citizenship_StatusObject

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

Citizenship_StatusObjectID

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

Citizenship_Status_Data

part of: Put_Citizenship_Status_Request
Citizenship Status Details
 
Parameter name Type/Value Cardinality Description Validations
Citizenship_Status_ID  string  [0..1]  Citizenship Status ID   
Citizenship_Status_Name  string  [0..1]  Citizenship Status Name 
Validation Description
Name is required.   
 
Citizenship_Status_Description  string  [0..1]  Citizenship Status Description.   
Country_Reference  CountryObject  [0..1]  The Country reference for the Citizenship Status 
Validation Description
Location (Country or Country Region) is required.   
 
Citizenship_Status_Mapping_Reference  Global_Setup_Data_MappingObject  [0..1]  The Citizenship Status metadata value the tenanted instance maps to   
Citizen  boolean  [0..1]  Indicates if the citizenship status indicates citizenship for the country.   
Inactive  boolean  [0..1]  Inactive Flag.   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Global_Setup_Data_MappingObject

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

Citizenship_StatusReferenceEnumeration

part of: Citizenship_StatusObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Global_Setup_Data_MappingReferenceEnumeration

part of: Global_Setup_Data_MappingObjectID
Base Type
string
top