Service Directory > v32.1 > Resource_Management > Get_Airports
 

Operation: Get_Airports

Gets Airport objects. An Airport object consists of a name. You specify the Airport name when retrieving Airport 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_Airports_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]   Airport_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Airport_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  Airport_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Airports_Response

Element containing Airport 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  Airport_Request_References  [0..1]  Element containing reference instances for an Airport object   
Request_Criteria  Airport_Request_Criteria  [0..1]  Element containing Airport 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  Airport_Response_Group  [0..1]  Element containing Airport 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  Airport_Response_Data  [0..1]  Airport Response Data   
top
 

Airport_Request_References

part of: Get_Airports_Request, Get_Airports_Response
Element containing reference instances for an Airport object
 
Parameter name Type/Value Cardinality Description Validations
Airport_Reference  AirportObject  [1..*]  Reference to an existing Airport Object   
top
 

AirportObject

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

AirportObjectID

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

Airport_Request_Criteria

part of: Get_Airports_Request, Get_Airports_Response
Element containing Airport request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Airport_Response_Group

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

Response_Results

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

Airport_Response_Data

part of: Get_Airports_Response
Airport Response Data
 
Parameter name Type/Value Cardinality Description Validations
Airport  Airport  [0..*]  Wrapper Element for Airport Data   
top
 

Airport

part of: Airport_Response_Data
Wrapper Element for Airport Data
 
Parameter name Type/Value Cardinality Description Validations
Airport_Reference  AirportObject  [0..1]  Airport Reference   
Airport_Data  Airport_Data  [0..*]  Airport Data 
Validation Description
The Airport Data Value "[value]" is already in use.  Spend Data instances of the same Data Value and Attribute Type is not allowed. 
A valid country is required.   
A valid Country Region is required   
 
top
 

Airport_Data

part of: Airport
Element that contains Airport Data
 
Parameter name Type/Value Cardinality Description Validations
Spend_Data_ID  string  [0..1]  Airport ID   
Airport_Value  string  [1..1]  Airport Value   
Airport_Name  string  [0..1]  Airport Name   
Country_Reference  CountryObject  [0..1]  Country in which Airport is located   
Country_Region_Reference  Country_RegionObject  [0..1]  Country Region within which the Airport is located   
Travel_City_Reference  Travel_CityObject  [0..1]  Travel City in which Airport is located   
Inactive  boolean  [0..1]  If the value is 1, the airport will be marked as inactive. By default , airports are considered active.   
Validation Description
The Airport Data Value "[value]" is already in use.  Spend Data instances of the same Data Value and Attribute Type is not allowed. 
A valid country is required.   
A valid Country Region is required   
top
 

CountryObject

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

Travel_CityObject

part of: Airport_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_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
 

AirportReferenceEnumeration

part of: AirportObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Travel_CityReferenceEnumeration

part of: Travel_CityObjectID
Base Type
string
top