Service Directory > v32.1 > Resource_Management > Get_Travel_Booking_Files
 

Operation: Get_Travel_Booking_Files

Get Travel Booking Files based on Travel Booking File Instance OR based on a Start and End Date range for the Travel File Load Date.


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

Get Travel Booking Files Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Travel_Booking_File_Request_References  [0..1]  Travel Booking File Request References.   
Request_Criteria [Choice]   Travel_Booking_File_Request_Criteria  [0..1]  Travel Booking File Request Criteria. Consists of and Start and End date. Travel Files loaded between Start and End Date are returned.   
Response_Filter  Response_Filter  [0..1]  Travel Booking File Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Travel_Booking_File_Response_Group  [0..1]  Travel Booking File Response Group.   
top
 

Response Element: Get_Travel_Booking_Files_Response

Get Travel Booking Files Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Travel_Booking_File_Request_References  [0..1]  Travel Booking File Request References.   
Request_Criteria  Travel_Booking_File_Request_Criteria  [0..1]  Travel Booking File Request Criteria. Consists of and Start and End date. Travel Files loaded between Start and End Date are returned.   
Response_Filter  Response_Filter  [0..1]  Travel Booking File Request Criteria. Consists of and Start and End date. Travel Files loaded between Start and End Date are returned. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Travel_Booking_File_Response_Group  [0..1]  Travel Booking File Response Group.   
Response_Results  Response_Results  [0..1]  Travel Booking File Response Results.   
Response_Data  Travel_Booking_File_Response_Data  [0..1]  Travel Booking File Response Data.   
top
 

Travel_Booking_File_Request_References

part of: Get_Travel_Booking_Files_Request, Get_Travel_Booking_Files_Response
Travel Booking File Request References.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Booking_File_Reference  Travel_Booking_FileObject  [1..*]  Travel Booking File Request References.   
top
 

Travel_Booking_FileObject

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

Travel_Booking_FileObjectID

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

Travel_Booking_File_Request_Criteria

part of: Get_Travel_Booking_Files_Request, Get_Travel_Booking_Files_Response
Travel Booking File Request Criteria. Consists of and Start and End date. Travel Files loaded between Start and End Date are returned.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Booking_Record_Load_Date_-_Start_Date  date  [0..1]  Travel Booking Record Load Date - Start Date   
Travel_Booking_Record_Load_Date_-_End_Date  date  [0..1]  Travel Booking Record Load Date - End Date   
top
 

Response_Filter

part of: Get_Travel_Booking_Files_Request, Get_Travel_Booking_Files_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
 

Travel_Booking_File_Response_Group

part of: Get_Travel_Booking_Files_Request, Get_Travel_Booking_Files_Response
Travel Booking File Response Group.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates whether to include the Travel Booking File Reference in the response.   
top
 

Response_Results

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

Travel_Booking_File_Response_Data

part of: Get_Travel_Booking_Files_Response
Travel Booking File Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Booking_File  Travel_Booking_File  [0..*]  Travel Booking File.   
top
 

Travel_Booking_File

part of: Travel_Booking_File_Response_Data
Travel Booking File.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Booking_File_Reference  Travel_Booking_FileObject  [0..1]  Travel Booking File Reference.   
Travel_Booking_File_Data  Travel_Booking_File_Data  [0..*]  Travel Booking File Date.   
top
 

Travel_Booking_File_Data

part of: Travel_Booking_File
Travel Booking Record Data.
 
Parameter name Type/Value Cardinality Description Validations
File_ID  string  [0..1]  Travel Booking File ID. This is the Travel Booking unique identifier.   
File_Name  string  [0..1]  Travel Booking File Name.   
File_Date  date  [0..1]  Travel Booking File Date.   
Default_Company_Reference  CompanyObject  [1..1]  Default Company.   
Travel_Booking_Record_Data  Travel_Booking_Record_Data  [0..*]  Travel Booking Record Data. 
Validation Description
Invalid value for Travel Booking Record Destination Country. Text code should be either 2 character alpha code, 3 character alpha code or a 3 digit numeric code.   
Invalid value for Travel Booking Record Origination Country. Text code should be either 2 character alpha code, 3 character alpha code or a 3 digit numeric code.   
 
top
 

CompanyObject

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

CompanyObjectID

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

Travel_Booking_Record_Data

part of: Travel_Booking_File_Data
Travel Booking Record Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [1..1]  Travel Booking Record ID. This is the Travel Booking Record unique identifier.   
Employee_ID  string  [0..1]  This is the unique identifier of the Employee that is associated with the Travel Booking Record.   
Accountholder_Name  string  [0..1]  Accountholder name with the Travel Management Company.   
Traveler_Name  string  [0..1]  Traveler Name for the Itinerary.   
Booking_Date  date  [0..1]  Date of this Travel Booking Record event.   
Company_Reference  CompanyObject  [0..1]  Company of the Employee on the Travel Booking Record   
Ticket_Number  string  [0..1]  Ticket Number on Travel Booking Record   
Travel_Provider  string  [0..1]  Identifying name of the Travel management provider.   
Itinerary_Number  string  [0..1]  Itinerary description from the Travel Management Provider.   
Itinerary_Description  string  [0..1]  Itinerary description from the Travel Management Provider.   
Reservation_Number  string  [0..1]  Reservation number provided for this Travel Booking Record.   
Travel_Record_Type_Reference  Travel_Booking_Record_TypeObject  [0..1]  Type of the Travel Booking Record.   
Booking_Status_Reference  Unique_IdentifierObject  [0..1]  Booking Status of Travel Booking Record.   
Location_Code_Destination  string  [0..1]  Destination Location Code for Travel Booking Record.   
Location_Code_Origin  string  [0..1]  Origination Location Code for Travel Booking Record.   
Air_Routing  string  [0..1]  Air: Concatenate the three digit Airport Codes for this routing (from each leg of travel) separated by a dash. Example: SFO-ORD-GRR-DEN-SFO.   
Class_Of_Service_Reference  Class_of_ServiceObject  [0..1]  Class Of Service for Travel Booking Record.   
Purchased  boolean  [0..1]  Purchase Status of Travel Booking Record.   
Purchase_Date  date  [0..1]  Purchase Date of Travel Booking.   
Source_Ticket_Value  decimal (26, 6)   [0..1]  Identifies the value of the ticket in source currency. If a pre-existing credit has been applied at time of booking, then the extended amount may be different from the ticket value. Populated for Travel Type Air, Rail, and Other only.   
Transaction_Extended_Amount  decimal (26, 6)   [0..1]  Total amount for this Travel Booking item in source currency. Includes the Tax amount. This may be a refund amount or Fees.   
Source_Currency_Reference  CurrencyObject  [0..1]  Source Currency for Travel Booking Record.   
Source_Lowest_Logical_Amount  decimal (32, 6) >0   [0..1]  Identifies the lowest logical fare for the identified Travel Booking booking in Source Currency.   
Last_4_Digits_of_Credit_Card_Number  string (4)   [0..1]  Last four digits of the card number used for Travel Booking.   
Credit_Card_Transaction_Reference  string  [0..1]  Card Transaction Reference Number if Booking Item is prepaid.   
Destination_City  string  [0..1]  Destination City   
Destination_State  string  [0..1]  Destination State   
Destination_Country  string  [0..1]  Destination Country   
Origination_City  string  [0..1]  Origination City   
Origination_State  string  [0..1]  Origination State   
Origination_Country  string  [0..1]  Origination Country   
Merchant_Code  string  [0..1]  Merchant Code   
Merchant_Name  string  [0..1]  Merchant Name for Travel Booking.   
Start_Date  date  [0..1]  Travel Booking related Start Date. Example : Air: Departure Date, Hotel: Check in Date, Car Rental: Pick up Date.   
End_Date  date  [0..1]  Travel Booking Related End Date. Example: Air: Return Date, Hotel: Check Out Date, Car Rental: Return Date.   
Source_Daily_Amount  decimal (26, 6) >0   [0..1]  Source Daily Amount.   
Travel_Policy_Code  string  [0..1]  Travel Policy Code.   
Policy_Description  string  [0..1]  Travel Policy Description.   
Travel_Booking_Record_Name_Match_Data  Travel_Booking_Record_Name_Match_Data  [0..*]  Travel Booking Record Name Match Data. 
Validation Description
Travel Booking Record Name Match must include either a Merchant, Origination City, or a Destination City.  Travel Booking Record Name Match must include either a Merchant, Origination City, or a Destination City. 
Confidence level percentage must between 0 and 100.  Confidence level percentage must between 0 and 100. 
Travel Booking Record matches should only include 1 match of either an Origin City, Destination City, or Merchant (Hotel, Airline, or Car Rental Agency).  Travel Booking Record matches should only include 1 match of either an Origin City, Destination City, or Merchant (Hotel, Airline, or Car Rental Agency). 
 
Validation Description
Invalid value for Travel Booking Record Destination Country. Text code should be either 2 character alpha code, 3 character alpha code or a 3 digit numeric code.   
Invalid value for Travel Booking Record Origination Country. Text code should be either 2 character alpha code, 3 character alpha code or a 3 digit numeric code.   
top
 

Travel_Booking_Record_TypeObject

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

Travel_Booking_Record_TypeObjectID

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

Unique_IdentifierObject

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

Class_of_ServiceObject

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

Class_of_ServiceObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Travel_Booking_Record_Name_Match_Data

part of: Travel_Booking_Record_Data
Travel Booking Record Name Match Data.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Booking_Record_Confidence_Percentage  decimal (6, 3) >0   [0..1]  Confidence Percentage for Travel Booking Record match data.   
Origination_Travel_City_Reference  Abstract_Spend_Data_NameObject  [0..1]  Workday Origination City matching the origination city on the Travel Booking Record.   
Destination_Travel_City_Reference  Abstract_Spend_Data_NameObject  [0..1]  Workday Destination City matching the destination city on the Travel Booking Record.   
Merchant_Reference  Abstract_Spend_Data_NameObject  [0..1]  Merchant matching the merchant listed on the Travel Booking Record.   
Validation Description
Travel Booking Record Name Match must include either a Merchant, Origination City, or a Destination City.  Travel Booking Record Name Match must include either a Merchant, Origination City, or a Destination City. 
Confidence level percentage must between 0 and 100.  Confidence level percentage must between 0 and 100. 
Travel Booking Record matches should only include 1 match of either an Origin City, Destination City, or Merchant (Hotel, Airline, or Car Rental Agency).  Travel Booking Record matches should only include 1 match of either an Origin City, Destination City, or Merchant (Hotel, Airline, or Car Rental Agency). 
top
 

Abstract_Spend_Data_NameObject

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

Abstract_Spend_Data_NameObjectID

part of: Abstract_Spend_Data_NameObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Airline_ID, Airport_ID, Applicant_ID, Car_Rental_Agency_ID, Class_of_Service_Value, Contingent_Worker_ID, Employee_ID, External_Committee_Member_ID, Hotel_ID, Invoice_Type_ID, Spend_Data_ID, Travel_City_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
 

Travel_Booking_FileReferenceEnumeration

part of: Travel_Booking_FileObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Travel_Booking_Record_TypeReferenceEnumeration

part of: Travel_Booking_Record_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Class_of_ServiceReferenceEnumeration

part of: Class_of_ServiceObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Abstract_Spend_Data_NameReferenceEnumeration

part of: Abstract_Spend_Data_NameObjectID
Base Type
string
top