Service Directory > v32.1 > Staffing > Get_Citizenship_Statuses
 

Operation: Get_Citizenship_Statuses

Returns citizenship status details for the requested status. If the request does not specify a citizenship status, the operations returns details for all citizenship statuses.


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

Element containing the references of the Citizenship Statuses requested.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Citizenship_Status_Request_References  [0..1]  Element containing the references of the Citizenship Statuses requested.   
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_Citizenship_Statuses_Response

Response Element for Get Citizenship Statuses.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Citizenship_Status_Request_References  [0..1]  The reference of the Citizenship Status requested.   
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  Citizenship_Status_Response_Data  [0..1]  Response Data for the Citizenship Status.   
top
 

Citizenship_Status_Request_References

part of: Get_Citizenship_Statuses_Request, Get_Citizenship_Statuses_Response
Element containing the references of the Citizenship Statuses requested.
 
Parameter name Type/Value Cardinality Description Validations
Citizenship_Status_Reference  Citizenship_StatusObject  [1..*]  The reference of the Citizenship Status requested.   
top
 

Citizenship_StatusObject

part of: Citizenship_Status_Request_References, Citizenship_Status
 
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
 

Response_Filter

part of: Get_Citizenship_Statuses_Request, Get_Citizenship_Statuses_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_Citizenship_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
 

Citizenship_Status_Response_Data

part of: Get_Citizenship_Statuses_Response
Response Data for the Citizenship Status.
 
Parameter name Type/Value Cardinality Description Validations
Citizenship_Status  Citizenship_Status  [0..*]  Citizenship Status Details.   
top
 

Citizenship_Status

part of: Citizenship_Status_Response_Data
Citizenship Status Details.
 
Parameter name Type/Value Cardinality Description Validations
Citizenship_Status_Reference  Citizenship_StatusObject  [0..1]  The reference of the Citizenship Status requested.   
Citizenship_Status_Data  Citizenship_Status_Data  [0..*]  Citizenship Status Details   
top
 

Citizenship_Status_Data

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