Service Directory > v31.2 > Resource_Management > Get_Worker_Travel_Profile_Listing_Files
 

Operation: Get_Worker_Travel_Profile_Listing_Files

Get Travel Profile Files based on Travel Profile File Instance.


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

Get Worker Travel Profile Listing Files Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_Travel_Profile_Listing_File_Request_References  [0..1]  Worker Travel Profile Listing File Request References   
Request_Criteria [Choice]   Worker_Travel_Profile_Listing_File_Request_Criteria  [0..1]  Worker Travel Profile Listing File Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Worker Travel Profile Listing File Response Filter [EL] 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Worker_Travel_Profile_Listing_File_Response_Group  [0..1]  Worker Travel Profile Listing File Response Group   
top
 

Response Element: Get_Worker_Travel_Profile_Listing_Files_Response

Get Worker Travel Profile Listing Files Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Travel_Profile_Listing_File_Request_References  [0..1]  Worker Travel Profile Listing File Request References   
Request_Criteria  Worker_Travel_Profile_Listing_File_Request_Criteria  [0..1]  Worker Travel Profile Listing File 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  Worker_Travel_Profile_Listing_File_Response_Group  [0..1]  Worker Travel Profile Listing File Response Group   
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  Worker_Travel_Profile_Listing_File_Response_Data  [0..1]  Worker Travel Profile Listing File Response Data   
top
 

Worker_Travel_Profile_Listing_File_Request_References

part of: Get_Worker_Travel_Profile_Listing_Files_Request, Get_Worker_Travel_Profile_Listing_Files_Response
Worker Travel Profile Listing File Request References
 
Parameter name Type/Value Cardinality Description Validations
Worker_Travel_Profile_Listing_File_Reference  Worker_Travel_Profile_Listing_FileObject  [1..*]  Worker Travel Profile Listing File Request References   
top
 

Worker_Travel_Profile_Listing_FileObject

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

Worker_Travel_Profile_Listing_FileObjectID

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

part of: Get_Worker_Travel_Profile_Listing_Files_Request, Get_Worker_Travel_Profile_Listing_Files_Response
Worker Travel Profile Listing File Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Worker_Travel_Profile_Listing_Files_Request, Get_Worker_Travel_Profile_Listing_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
 

Worker_Travel_Profile_Listing_File_Response_Group

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

Response_Results

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

Worker_Travel_Profile_Listing_File_Response_Data

part of: Get_Worker_Travel_Profile_Listing_Files_Response
Travel Profile Listing File Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Travel_Profile_Listing_File  Worker_Travel_Profile_Listing_File  [0..*]  Worker Travel Profile Listing File   
top
 

Worker_Travel_Profile_Listing_File

part of: Worker_Travel_Profile_Listing_File_Response_Data
Worker Travel Profile Listing File
 
Parameter name Type/Value Cardinality Description Validations
Worker_Travel_Profile_Listing_File_Reference  Worker_Travel_Profile_Listing_FileObject  [0..1]  Worker Travel Profile Listing File Reference   
Worker_Travel_Profile_Listing_File_Data  Worker_Travel_Profile_Listing_File_WWS  [0..*]  Container for Worker Travel Profile Listing File Data   
top
 

Worker_Travel_Profile_Listing_File_WWS

part of: Worker_Travel_Profile_Listing_File
Container for Worker Travel Profile Listing File Data
 
Parameter name Type/Value Cardinality Description Validations
Travel_Profile_Listing_File_Number  string  [0..1]  Worker Travel Profile Listing File Number. This is the Worker Travel Profile Listing File unique identifier.   
Travel_Profile_Listing_File_Name  string  [0..1]  Worker Travel Profile Listing File Name   
Travel_Profile_Listing_File_Date  date  [0..1]  Worker Travel Profile Listing File Date   
Travel_Profile_Data  Worker_Travel_Profile_WWS  [0..*]  Container for Worker Travel Profile records   
top
 

Worker_Travel_Profile_WWS

part of: Worker_Travel_Profile_Listing_File_WWS
Container for Worker Travel Profile records
 
Parameter name Type/Value Cardinality Description Validations
Worker_Travel_Profile_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Worker Travel Profile Listing File for update only purposes.   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Airline_Reference  AirlineObject  [0..*]  Airline Reference   
Business_Asset_Reference  Business_AssetObject  [0..1]  Business Asset Reference   
Hotel_Reference  HotelObject  [0..*]  Hotel Reference   
Travel_Country_Reference  CountryObject  [0..*]  Travel Country Reference   
Vehicle_Type_Reference  Vehicle_TypeObject  [0..1]  Vehicle Type Reference   
Car_Rental_Agency_Reference  Car_Rental_AgencyObject  [0..*]  Car Rental Agency Reference   
Fuel_Type_Reference  Fuel_TypeObject  [0..1]  Fuel Type Reference   
Engine_Capacity_Reference  Engine_CapacityObject  [0..1]  Engine Capacity Reference   
Vehicle_Plan_Reference  Vehicle_PlanObject  [0..1]  Vehicle Plan Reference   
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.   
 
top
 

Unique_IdentifierObject

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

WorkerObject

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

AirlineObject

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

Business_AssetObject

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

HotelObject

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

Vehicle_TypeObject

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

Car_Rental_AgencyObject

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

Fuel_TypeObject

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

Expense_Item_Accumulator_Balance_Data

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

Worker_Travel_Profile_Listing_FileReferenceEnumeration

part of: Worker_Travel_Profile_Listing_FileObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

AirlineReferenceEnumeration

part of: AirlineObjectID
Base Type
string
top
 

Business_AssetReferenceEnumeration

part of: Business_AssetObjectID
Base Type
string
top
 

HotelReferenceEnumeration

part of: HotelObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Vehicle_TypeReferenceEnumeration

part of: Vehicle_TypeObjectID
Base Type
string
top
 

Car_Rental_AgencyReferenceEnumeration

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

Expense_ItemReferenceEnumeration

part of: Expense_ItemObjectID
Base Type
string
top