Service Directory > v31.2 > Human_Resources > Get_LGBT_Identifications
 

Operation: Get_LGBT_Identifications

This operation retrieves the LGBT Identifications that are currently defined.


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

Request element for Get LGBT Identification service task.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   LGBT_Identification_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of LGBT Identifications and its associated data.   
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_LGBT_Identifications_Response

Contains the response elements for the Get LGBT Identification and Put LGBT Identification
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  LGBT_Identification_Request_References  [0..1]  Request References   
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  LGBT_Identification_Response_Data  [0..1]  Encapsulating element containing all LGBT Identification data.   
top
 

LGBT_Identification_Request_References

part of: Get_LGBT_Identifications_Request, Get_LGBT_Identifications_Response
Utilize the Request References element to retrieve a specific instance(s) of LGBT Identifications and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
LGBT_Identification_Reference  LGBT_IdentificationObject  [1..*]  A unique identifier used to reference a LGBT Identification   
top
 

LGBT_IdentificationObject

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

LGBT_IdentificationObjectID

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

Response_Filter

part of: Get_LGBT_Identifications_Request, Get_LGBT_Identifications_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_LGBT_Identifications_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
 

LGBT_Identification_Response_Data

part of: Get_LGBT_Identifications_Response
Encapsulating element containing all LGBT Identification data.
 
Parameter name Type/Value Cardinality Description Validations
LGBT_Identification  LGBT_Identification  [0..*]  Reference element representing a unique instance of LGBT Identification   
top
 

LGBT_Identification

part of: LGBT_Identification_Response_Data
Reference element representing a unique instance of LGBT Identification
 
Parameter name Type/Value Cardinality Description Validations
LGBT_Identification_Reference  LGBT_IdentificationObject  [0..1]  A unique identifier used to reference a LGBT Identification   
LGBT_Identification_Data  LGBT_Identification_Data  [0..1]  Encapsulating element containing all LGBT Identification data.   
top
 

LGBT_Identification_Data

part of: LGBT_Identification
Encapsulating element containing all LGBT Identification data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the LGBT Identification (LGBT_Identification_ID).   
Name  string  [1..1]  The name of the LGBT Identification.   
Description  string  [0..1]  The description for the LGBT Identification.   
Location_Reference  Location_ContextObject  [1..1]  The country that the LGBT Identification is for.   
Inactive  boolean  [0..1]  The Inactive status for this LGBT Identification.   
top
 

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_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 of a parent object   
top
 

LGBT_IdentificationReferenceEnumeration

part of: LGBT_IdentificationObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top