Service Directory > v32.1 > Resource_Management > Get_Travel_Profiles
 

Operation: Get_Travel_Profiles

A Web Service for retrieving Worker Travel Profiles. Accepts the WIDs of Worker Travel Profiles in the request and returns the referenced Worker Travel Profiles if a WID is supplied. If no WID is supplied, all Worker Travel Profiles are returned.


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

Contains request reference, criteria, filter and response group for getting Travel Profile data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Travel_Profile_Request_References  [0..1]  Element containing reference instances for Travel Profile   
Request_Criteria [Choice]   Travel_Profile_Request_Criteria  [0..1]  Element containing Travel Profile 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  Travel_Profile_Response_Group  [0..1]  Element containing Travel Profile response grouping options   
top
 

Response Element: Get_Travel_Profiles_Response

Element containing the response for the Travel Profile request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Travel_Profile_Request_References  [0..1]  Element containing reference instances for Travel Profile   
Request_Criteria  Travel_Profile_Request_Criteria  [0..1]  Element containing Travel Profile 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  Travel_Profile_Response_Group  [0..1]  Element containing Travel Profile 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  Travel_Profile_Response_Data  [0..1]  Element containing the actual Travel Profiles data requested. It contains one element: Travel Profile, which in turn contains the instance set of Travel Profiles which are returned.   
top
 

Travel_Profile_Request_References

part of: Get_Travel_Profiles_Request, Get_Travel_Profiles_Response
Element containing reference instances for Travel Profile
 
Parameter name Type/Value Cardinality Description Validations
Travel_Profile_Reference  Unique_IdentifierObject  [1..*]  Reference to an existing Travel Profile   
top
 

Unique_IdentifierObject

part of: Travel_Profile_Request_References, Travel_Profile, Expense_Item_Accumulator_Balance_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
 

Travel_Profile_Request_Criteria

part of: Get_Travel_Profiles_Request, Get_Travel_Profiles_Response
Element containing Travel Profile request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Travel_Profiles_Request, Get_Travel_Profiles_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_Profile_Response_Group

part of: Get_Travel_Profiles_Request, Get_Travel_Profiles_Response
Element containing Travel Profile response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Travel_Profiles_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_Profile_Response_Data

part of: Get_Travel_Profiles_Response
Element containing the actual Travel Profiles data requested. It contains one element: Travel Profile, which in turn contains the instance set of Travel Profiles which are returned.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Profile  Travel_Profile  [0..*]  Element containing a set of returned travel profiles and a subelement containing their associated data.   
top
 

Travel_Profile

part of: Travel_Profile_Response_Data
Element containing a set of returned travel profiles and a subelement containing their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Travel_Profile_Reference  Unique_IdentifierObject  [0..1]  Reference to the Worker Travel Profile   
Travel_Profile_Data  Travel_Profile_Data  [0..1]  Element containing all Travel Profile data 
Validation Description
At least one of the selected business assets is not issued to the selected worker for Travel Profile.  At least one of the selected business assets is not issued to the selected worker for Travel Profile. 
 
top
 

Travel_Profile_Data

part of: Travel_Profile
Element containing all Travel Profile data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Reference to an existing Worker   
Vehicle_Type_Reference  Vehicle_TypeObject  [0..1]  Reference to an existing Vehicle Type. For the selected worker, this vehicle type is the default value for vehicle type on an expense report line item detail.   
Resource_Reference  Business_AssetObject  [0..*]  Reference to an existing Business Asset allocated to the selected worker.   
Fuel_Type_Reference  Fuel_TypeObject  [0..1]  Reference to an existing Fuel Type. For the selected worker, this fuel type is the default value for fuel type on an expense report line item detail.   
Engine_Capacity_Reference  Engine_CapacityObject  [0..1]  Reference to an existing Engine Capacity. For the selected worker, this engine capacity is the default value for engine capacity on an expense report line item detail.   
Vehicle_Plan_Reference  Vehicle_PlanObject  [0..1]  Reference to an existing Vehicle Plan. For the selected worker, this vehicle plan is the default value for vehicle plan on an expense report line item detail.   
Airline_Reference  AirlineObject  [0..*]  Reference to an existing Airline. For the selected worker, this airline is the default value for airline on an expense report line item detail.   
Car_Rental_Agency_Reference  Car_Rental_AgencyObject  [0..*]  Reference to an existing Car Rental Agency. For the selected worker, this car rental agency is the default value for car rental agency on an expense report line item detail.   
Hotel_Reference  HotelObject  [0..*]  Reference to an existing Hotel. For the selected worker, this hotel is the default value for hotel on an expense report line item detail.   
Travel_Country_Reference  CountryObject  [0..*]  Reference to an existing Travel Country. For the selected worker, this travel country is the default value for country on an expense report line item detail.   
Attachment_Data  Worker_Travel_Profile_Attachment_Data  [0..*]  Encapsulating element containing all Worker Travel Profile Attachment data.   
Expense_Item_Accumulator_Balance_Data  Expense_Item_Accumulator_Balance_Data  [0..*]  Element Containing the Expense Item Accumulator Balance 
Validation Description
Select a different Expense Item or Balance Application Date before entering a new accumulator balance.   
Select an Expense Item that has an associated Expense Accumulator.   
One or more of the new accumulator balance entries overlap. Select a different Expense Item or Balance Application Date.   
 
Validation Description
At least one of the selected business assets is not issued to the selected worker for Travel Profile.  At least one of the selected business assets is not issued to the selected worker for Travel Profile. 
top
 

WorkerObject

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

WorkerObjectID

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

Vehicle_TypeObject

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

Vehicle_TypeObjectID

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

Business_AssetObject

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

Business_AssetObjectID

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

Fuel_TypeObject

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

Fuel_TypeObjectID

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

Engine_CapacityObject

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

Engine_CapacityObjectID

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

Vehicle_PlanObject

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

Vehicle_PlanObjectID

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

AirlineObject

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

AirlineObjectID

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

Car_Rental_AgencyObject

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

Car_Rental_AgencyObjectID

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

HotelObject

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

CountryObject

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

CountryObjectID

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

Worker_Travel_Profile_Attachment_Data

part of: Travel_Profile_Data
Encapsulating element containing all Worker Travel Profile Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Attachment_Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
top
 

Expense_Item_Accumulator_Balance_Data

part of: Travel_Profile_Data
Element Containing the Expense Item Accumulator Balance
 
Parameter name Type/Value Cardinality Description Validations
Expense_Item_Accumulator_Balance_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Expense Item Accumulator Balance   
Expense_Item_Reference  Expense_ItemObject  [1..1]  Reference to Expense Item   
Beginning_Balance  decimal (12, 0) >0   [1..1]  Beginning Accumulator Balance   
Balance_Application_Date  date  [1..1]  Balance Application Date   
Applicable_Until_Date  date  [0..1]  Applicable Date Until   
Validation Description
Select a different Expense Item or Balance Application Date before entering a new accumulator balance.   
Select an Expense Item that has an associated Expense Accumulator.   
One or more of the new accumulator balance entries overlap. Select a different Expense Item or Balance Application Date.   
top
 

Expense_ItemObject

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

Expense_ItemObjectID

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

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Vehicle_TypeReferenceEnumeration

part of: Vehicle_TypeObjectID
Base Type
string
top
 

Business_AssetReferenceEnumeration

part of: Business_AssetObjectID
Base Type
string
top
 

Fuel_TypeReferenceEnumeration

part of: Fuel_TypeObjectID
Base Type
string
top
 

Engine_CapacityReferenceEnumeration

part of: Engine_CapacityObjectID
Base Type
string
top
 

Vehicle_PlanReferenceEnumeration

part of: Vehicle_PlanObjectID
Base Type
string
top
 

AirlineReferenceEnumeration

part of: AirlineObjectID
Base Type
string
top
 

Car_Rental_AgencyReferenceEnumeration

part of: Car_Rental_AgencyObjectID
Base Type
string
top
 

HotelReferenceEnumeration

part of: HotelObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Expense_ItemReferenceEnumeration

part of: Expense_ItemObjectID
Base Type
string
top