Service Directory > v31.2 > Resource_Management > Get_Guests
 

Operation: Get_Guests

This operation will get all Guests for the specified criteria. The response will include specific information about the Guests such as the Guest Name, Guest Company and Guest Title.


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

This element is the top-level request element for all Guests "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Guest_Request_References  [0..1]  This element content contains the echoed Guests Request Reference Element   
Request_Criteria [Choice]   Guest_Request_Criteria  [0..1]  This element content contains the echoed Guests Request Criteria Element   
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_Group  Guest_Response_Group  [0..1]  This element content contains the echoed Guests Response Group Element   
top
 

Response Element: Get_Guests_Response

Element containing Guest response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Guest_Request_References  [0..1]  Guest Reference element contains the specific instance set containing the requested Guest.   
Request_Criteria  Guest_Request_Criteria  [0..1]  The Request Criteria element lets you apply additional criteria to identify the specific instance(s) of Guests.   
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_Group  Guest_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Guest response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Guest_Response_Data  [0..1]  This element content contains the Guest Response Data element.   
top
 

Guest_Request_References

part of: Get_Guests_Request, Get_Guests_Response
Guest Reference element contains the specific instance set containing the requested Guest.
 
Parameter name Type/Value Cardinality Description Validations
Guest_Reference  Unique_IdentifierObject  [1..*]  Instance set containing the Guest object.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Guest_Request_Criteria

part of: Get_Guests_Request, Get_Guests_Response
The Request Criteria element lets you apply additional criteria to identify the specific instance(s) of Guests.
 
Parameter name Type/Value Cardinality Description Validations
Expense_Payee_Reference  Expense_PayeeObject  [0..1]  Expense Payee reference for Guest.   
top
 

Expense_PayeeObject

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

Expense_PayeeObjectID

part of: Expense_PayeeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Applicant_ID, Contingent_Worker_ID, Employee_ID, External_Committee_Member_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_Guests_Request, Get_Guests_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
 

Guest_Response_Group

part of: Get_Guests_Request, Get_Guests_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Guest response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Guest Reference data is to be included in the response   
top
 

Response_Results

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

Guest_Response_Data

part of: Get_Guests_Response
Wrapper element containing guest response data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Guest  Guest_WWS  [0..*]  Wrapper element that includes guest instance and data   
top
 

Guest_WWS

part of: Guest_Response_Data
Wrapper element that includes guest instance and data
 
Parameter name Type/Value Cardinality Description Validations
Guest_Reference  Unique_IdentifierObject  [0..1]  Wrapper element that includes guest instance and data   
Expense_Payee_Reference  Expense_PayeeObject  [0..*]  Reference to the person who the guest is for.   
Guest_Name  string  [0..1]  Guest Name   
Guest_Company  string  [0..1]  Guest Company   
Guest_Title  string  [0..1]  Guest Title   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Expense_PayeeReferenceEnumeration

part of: Expense_PayeeObjectID
Base Type
string
top