Service Directory > v31.2 > Human_Resources > Get_Sexual_Orientations
 

Operation: Get_Sexual_Orientations

Returns Sexual Orientations by Reference ID, or returns all Sexual Orientations 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_Sexual_Orientations_Request

The request to get sexual orientation data for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Sexual_Orientation_Request_References  [0..1]  Reference to the sexual orientation of the person.   
Request_Criteria [Choice]   Sexual_Orientation_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_Sexual_Orientations_Response

The response to the sexual orientation get request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Sexual_Orientation_Request_References  [0..1]  Reference to the sexual orientation of the person.   
Request_Criteria  Sexual_Orientation_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  Sexual_Orientation_Response_Data  [0..1]  The sexual orientation response data.   
top
 

Sexual_Orientation_Request_References

part of: Get_Sexual_Orientations_Request, Get_Sexual_Orientations_Response
Reference to the sexual orientation of the person.
 
Parameter name Type/Value Cardinality Description Validations
Sexual_Orientation_Reference  Sexual_OrientationObject  [1..*]  Reference to the sexual orientation of the person.   
top
 

Sexual_OrientationObject

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

Sexual_OrientationObjectID

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

Sexual_Orientation_Request_Criteria

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

Response_Filter

part of: Get_Sexual_Orientations_Request, Get_Sexual_Orientations_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_Sexual_Orientations_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
 

Sexual_Orientation_Response_Data

part of: Get_Sexual_Orientations_Response
The sexual orientation response data.
 
Parameter name Type/Value Cardinality Description Validations
Sexual_Orientation  Sexual_Orientation  [0..*]  The sexual orientation for a worker.   
top
 

Sexual_Orientation

part of: Sexual_Orientation_Response_Data
The sexual orientation for a worker.
 
Parameter name Type/Value Cardinality Description Validations
Sexual_Orientation_Reference  Sexual_OrientationObject  [0..1]  Reference to the sexual orientation of the person.   
Sexual_Orientation_Data  Sexual_Orientation_Data  [0..*]  The sexual orientation data for a worker.   
top
 

Sexual_Orientation_Data

part of: Sexual_Orientation
The sexual orientation data for a worker.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The sexual orientation ID.   
Sexual_Orientation_Name  string  [1..1]  The sexual orientation for workers.   
Sexual_Orientation_Code  string  [0..1]  The sexual orientation code.   
Sexual_Orientation_Description  string  [0..1]  The sexual orientation description.   
Sexual_Orientation_Inactive  boolean  [0..1]  The inactive flag for sexual orientation.   
top
 

Sexual_OrientationReferenceEnumeration

part of: Sexual_OrientationObjectID
Base Type
string
top