Service Directory > v32.1 > Resource_Management > Get_Travel_Cities
 

Operation: Get_Travel_Cities

Returns Travel City objects. Use filtering criteria to retrieve specific Travel City objects.


@ - 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_Cities_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]   Travel_City_Request_References  [0..1]  Element containing reference instances for a Travel City Object   
Request_Criteria [Choice]   Travel_City_Request_Criteria  [0..1]  Element containing Travel City 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_City_Response_Group  [0..1]  Element containing Travel City response grouping options   
top
 

Response Element: Get_Travel_Cities_Response

Element containing Travel City response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Travel_City_Request_References  [0..1]  Travel City Request References   
Request_Criteria  Travel_City_Request_Criteria  [0..1]  Travel City 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_City_Response_Group  [0..1]  Travel City 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  Travel_City_Response_Data  [0..1]  Wrapper Element that includes Travel City Instance and Data   
top
 

Travel_City_Request_References

part of: Get_Travel_Cities_Request, Get_Travel_Cities_Response
Element containing reference instances for a Travel City Object
 
Parameter name Type/Value Cardinality Description Validations
Travel_City_Reference  Travel_CityObject  [1..*]  Reference to an existing Travel City Object   
top
 

Travel_CityObject

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

Travel_CityObjectID

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

part of: Get_Travel_Cities_Request, Get_Travel_Cities_Response
Element containing Travel City request criteria
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [0..1]  Country Reference   
Travel_Region_Reference  Country_RegionObject  [0..1]  Reference to a Travel Region.   
top
 

CountryObject

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

Country_RegionObject

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

Country_RegionObjectID

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

Response_Filter

part of: Get_Travel_Cities_Request, Get_Travel_Cities_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_City_Response_Group

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

Response_Results

part of: Get_Travel_Cities_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_City_Response_Data

part of: Get_Travel_Cities_Response
Wrapper Element that includes Travel City Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Travel_City  Travel_City  [0..*]  Travel City   
top
 

Travel_City

part of: Travel_City_Response_Data
Element that contains Travel City Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Travel_City_Reference  Travel_CityObject  [0..1]  Travel City Reference   
Travel_City_Data  Travel_City_Data  [0..*]  Travel City Data 
Validation Description
The combination of Data Value "[value]", Country Region [country region], and Country [country] for Travel City is already in use.  Travel Cities with the same Data Value, Country Region, and Country combination is not allowed. 
 
top
 

Travel_City_Data

part of: Travel_City
Element that contains Travel City Data
 
Parameter name Type/Value Cardinality Description Validations
Spend_Data_ID  string  [0..1]  Travel City ID   
Travel_City_Value  string  [1..1]  Travel City Value   
Travel_Region_Reference  Country_RegionObject  [0..1]  Reference to a Travel Region. 
Validation Description
Travel Region [region] is invalid for Country [country].  The Travel Region and Country combination must be valid. 
 
Country_Reference  CountryObject  [0..1]  Reference to a Country.   
Alternate_Travel_City_Name  Travel_City_Alternate_Name_Data  [0..*]  Element used to specify alternate names. 
Validation Description
There can't be duplicate alternate city names per Country.   
Enter a unique Travel City name. [travel_city] is already in use as an alternate name.   
Enter a unique Travel City. [alternate_name] is already in use as an alternate name.   
 
Inactive  boolean  [0..1]  Inactive   
Validation Description
The combination of Data Value "[value]", Country Region [country region], and Country [country] for Travel City is already in use.  Travel Cities with the same Data Value, Country Region, and Country combination is not allowed. 
top
 

Travel_City_Alternate_Name_Data

part of: Travel_City_Data
Element used to specify alternate names.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Data_Alternate_Name_Reference  Unique_IdentifierObject  [0..1]  Reference to the Alternate Name of Travel City.   
Alternate_Name  string  [1..1]  Travel city alternate name.   
Validation Description
There can't be duplicate alternate city names per Country.   
Enter a unique Travel City name. [travel_city] is already in use as an alternate name.   
Enter a unique Travel City. [alternate_name] is already in use as an alternate name.   
top
 

Unique_IdentifierObject

part of: Travel_City_Alternate_Name_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_CityReferenceEnumeration

part of: Travel_CityObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top