Service Directory > v32.1 > Resource_Management > Get_Hotels
 

Operation: Get_Hotels

Returns Hotel objects. A Hotel object consists of an ID, a name and an optional Merchant Code.


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

Element containing sub elements for the Request Reference, Request Criteria, Response Filter and the Response Group
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Hotel_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Hotel_Request_Criteria  [0..1]  Request Criteria   
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  Hotel_Response_Group  [0..1]  Request Group   
top
 

Response Element: Get_Hotels_Response

Element containing Hotel response elements including received criteria, references, data based on criteria, results filter and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Hotel_Request_References  [0..1]  Element containing reference instances for a Hotel object   
Request_Criteria  Hotel_Request_Criteria  [0..1]  Element containing Hotel request criteria   
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  Hotel_Response_Group  [0..1]  Element containing Hotel response grouping options   
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  Hotel_Response_Data  [0..1]  Hotel Response Data   
top
 

Hotel_Request_References

part of: Get_Hotels_Request, Get_Hotels_Response
Element containing reference instances for a Hotel object
 
Parameter name Type/Value Cardinality Description Validations
Hotel_Reference  HotelObject  [1..*]  Reference to an existing Hotel Object   
top
 

HotelObject

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

HotelObjectID

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

Hotel_Request_Criteria

part of: Get_Hotels_Request, Get_Hotels_Response
Element containing Hotel request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Hotels_Request, Get_Hotels_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
 

Hotel_Response_Group

part of: Get_Hotels_Request, Get_Hotels_Response
Element containing Hotel response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Hotel_Response_Data

part of: Get_Hotels_Response
Hotel Response Data
 
Parameter name Type/Value Cardinality Description Validations
Hotel  Hotel  [0..*]  Wrapper element for Hotel Reference and Hotel Data   
top
 

Hotel

part of: Hotel_Response_Data
Wrapper element for Hotel Reference and Hotel Data
 
Parameter name Type/Value Cardinality Description Validations
Hotel_Reference  HotelObject  [0..1]  Hotel Reference   
Hotel_Data  Hotel_Data  [0..*]  Hotel Data 
Validation Description
The Hotel Data Value "[value]" is already in use.  Spend Data instances of the same Data Value and Attribute Type is not allowed. 
[merchant_name] is already used as an alternate name.   
 
top
 

Hotel_Data

part of: Hotel
Element that contains Hotel Data
 
Parameter name Type/Value Cardinality Description Validations
Spend_Data_ID  string  [0..1]  Hotel Reference ID   
Hotel_Value  string  [1..1]  Hotel Value   
Merchant_Code_Reference  Merchant_CodeObject  [0..1]  A Merchant Code to map to this Hotel. If a Merchant Code is specified, it will be used on Expense Credit Card Transactions to match the specified Merchant Code to this Hotel. 
Validation Description
The Merchant Code selected is already mapped to a different Merchant: [merchant]  Each Merchant Code can only be assigned to one Merchant (Airline, Hotel, or Car Rental Agency). 
 
Alternate_Merchant_Name_Data  Alternate_Merchant_Name_Data  [0..*]  Alternate Names for Merchant are entered here. 
Validation Description
Cannot have duplicate alternate names.   
[alternate_name] is already used as an alternate name.   
[alternate_name] is already used a merchant name.   
 
Validation Description
The Hotel Data Value "[value]" is already in use.  Spend Data instances of the same Data Value and Attribute Type is not allowed. 
[merchant_name] is already used as an alternate name.   
top
 

Merchant_CodeObject

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

Merchant_CodeObjectID

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

Alternate_Merchant_Name_Data

part of: Hotel_Data
Alternate Names for Merchant are entered here.
 
Parameter name Type/Value Cardinality Description Validations
Alternate_Name_Value  string  [1..1]  Alternate Name Value   
Validation Description
Cannot have duplicate alternate names.   
[alternate_name] is already used as an alternate name.   
[alternate_name] is already used a merchant name.   
top
 

HotelReferenceEnumeration

part of: HotelObjectID
Base Type
string
top
 

Merchant_CodeReferenceEnumeration

part of: Merchant_CodeObjectID
Base Type
string
top