Service Directory > v31.2 > Human_Resources > Get_Pronouns
 

Operation: Get_Pronouns

Returns Pronouns by Reference ID, or returns all Pronouns 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_Pronouns_Request

The request to get pronoun data for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Pronoun_Request_References  [0..1]  Reference to the Pronoun of the person.   
Request_Criteria [Choice]   Pronoun_Request_Criteria  [0..1]  The Criteria of the request   
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_Pronouns_Response

The response to the pronoun get request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Pronoun_Request_References  [0..1]  Reference to the Pronoun of the person.   
Request_Criteria  Pronoun_Request_Criteria  [0..1]  The Criteria of the request   
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  Pronoun_Response_Data  [0..1]  The response to the pronoun get request.   
top
 

Pronoun_Request_References

part of: Get_Pronouns_Request, Get_Pronouns_Response
Reference to the Pronoun of the person.
 
Parameter name Type/Value Cardinality Description Validations
Pronoun_Reference  PronounObject  [1..*]  Reference to the Pronoun of the person.   
top
 

PronounObject

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

PronounObjectID

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

Pronoun_Request_Criteria

part of: Get_Pronouns_Request, Get_Pronouns_Response
The Criteria of the request
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Pronouns_Request, Get_Pronouns_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_Pronouns_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
 

Pronoun_Response_Data

part of: Get_Pronouns_Response
The pronoun response data.
 
Parameter name Type/Value Cardinality Description Validations
Pronoun  Pronoun  [0..*]  The pronoun for a worker.   
top
 

Pronoun

part of: Pronoun_Response_Data
The pronoun for a worker.
 
Parameter name Type/Value Cardinality Description Validations
Pronoun_Reference  PronounObject  [0..1]  Reference to the Pronoun of the person.   
Pronoun_Data  Pronoun_Data  [0..*]  The pronoun data for a worker.   
top
 

Pronoun_Data

part of: Pronoun
The pronoun data for a worker.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The pronoun ID.   
Pronoun_Name  string  [1..1]  The pronoun for a worker.   
Pronoun_Code  string  [0..1]  The pronoun code.   
Pronoun_Description  string  [0..1]  The pronoun description.   
Pronoun_Inactive  boolean  [0..1]  The inactive flag for pronoun.   
top
 

PronounReferenceEnumeration

part of: PronounObjectID
Base Type
string
top