Module: Flightxml::V3::Operations

Included in:
Client
Defined in:
lib/flightxml/v3/operations.rb

Instance Method Summary collapse

Instance Method Details

#aircraft_type(type:) ⇒ Hash

Perform a AircraftType request

Parameters:

  • type (String)

Returns:

  • (Hash)

    A Hash containing a AircraftTypeResults response

See Also:


17
18
19
20
21
22
23
24
25
# File 'lib/flightxml/v3/operations.rb', line 17

def aircraft_type(type:)
  command = Command.new(
    command: :AircraftType,
    result: Types::AircraftTypeResults,
    version: 3,
    parameters: {type: type}
  )
  perform_operation(command)
end

#airline_flight_schedules(start_date:, end_date:, origin: nil, destination: nil, airline: nil, flightno: nil, exclude_codeshare: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a AirlineFlightSchedules request

Parameters:

  • start_date (Int)
  • end_date (Int)
  • origin (String) (defaults to: nil)
  • destination (String) (defaults to: nil)
  • airline (String) (defaults to: nil)
  • flightno (String) (defaults to: nil)
  • exclude_codeshare (Boolean) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a AirlineFlightSchedulesResults response

See Also:


40
41
42
43
44
45
46
47
48
# File 'lib/flightxml/v3/operations.rb', line 40

def airline_flight_schedules(start_date:, end_date:, origin: nil, destination: nil, airline: nil, flightno: nil, exclude_codeshare: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :AirlineFlightSchedules,
    result: Types::AirlineFlightSchedulesResults,
    version: 3,
    parameters: {start_date: start_date, end_date: end_date, origin: origin, destination: destination, airline: airline, flightno: flightno, exclude_codeshare: exclude_codeshare, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#airline_info(airline_code:) ⇒ Hash

Perform a AirlineInfo request

Parameters:

  • airline_code (String)

Returns:

  • (Hash)

    A Hash containing a AirlineInfoResults response

See Also:


55
56
57
58
59
60
61
62
63
# File 'lib/flightxml/v3/operations.rb', line 55

def airline_info(airline_code:)
  command = Command.new(
    command: :AirlineInfo,
    result: Types::AirlineInfoResults,
    version: 3,
    parameters: {airline_code: airline_code}
  )
  perform_operation(command)
end

#airport_boards(airport_code:, include_ex_data: nil, filter: nil, type: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a AirportBoards request

Parameters:

  • airport_code (String)
  • include_ex_data (Boolean) (defaults to: nil)
  • filter (String) (defaults to: nil)
  • type (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a AirportBoardsResults response

See Also:


75
76
77
78
79
80
81
82
83
# File 'lib/flightxml/v3/operations.rb', line 75

def airport_boards(airport_code:, include_ex_data: nil, filter: nil, type: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :AirportBoards,
    result: Types::AirportBoardsResults,
    version: 3,
    parameters: {airport_code: airport_code, include_ex_data: include_ex_data, filter: filter, type: type, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#airport_delays(airport_code: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a AirportDelays request

Parameters:

  • airport_code (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a AirportDelaysResults response

See Also:


92
93
94
95
96
97
98
99
100
# File 'lib/flightxml/v3/operations.rb', line 92

def airport_delays(airport_code: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :AirportDelays,
    result: Types::AirportDelaysResults,
    version: 3,
    parameters: {airport_code: airport_code, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#airport_info(airport_code:) ⇒ Hash

Perform a AirportInfo request

Parameters:

  • airport_code (String)

Returns:

  • (Hash)

    A Hash containing a AirportInfoResults response

See Also:


107
108
109
110
111
112
113
114
115
# File 'lib/flightxml/v3/operations.rb', line 107

def airport_info(airport_code:)
  command = Command.new(
    command: :AirportInfo,
    result: Types::AirportInfoResults,
    version: 3,
    parameters: {airport_code: airport_code}
  )
  perform_operation(command)
end

#block_ident_check(ident:) ⇒ Hash

Perform a BlockIdentCheck request

Parameters:

  • ident (String)

Returns:

  • (Hash)

    A Hash containing a BlockIdentCheckResults response

See Also:


122
123
124
125
126
127
128
129
130
# File 'lib/flightxml/v3/operations.rb', line 122

def block_ident_check(ident:)
  command = Command.new(
    command: :BlockIdentCheck,
    result: Types::BlockIdentCheckResults,
    version: 3,
    parameters: {ident: ident}
  )
  perform_operation(command)
end

#count_airport_operations(airport_code:) ⇒ Hash

Perform a CountAirportOperations request

Parameters:

  • airport_code (String)

Returns:

  • (Hash)

    A Hash containing a CountAirportOperationsResults response

See Also:


137
138
139
140
141
142
143
144
145
# File 'lib/flightxml/v3/operations.rb', line 137

def count_airport_operations(airport_code:)
  command = Command.new(
    command: :CountAirportOperations,
    result: Types::CountAirportOperationsResults,
    version: 3,
    parameters: {airport_code: airport_code}
  )
  perform_operation(command)
end

#count_all_enroute_airline_operationsHash

Perform a CountAllEnrouteAirlineOperations request

Returns:

  • (Hash)

    A Hash containing a CountAllEnrouteAirlineOperationsResults response

See Also:


151
152
153
154
155
156
157
158
159
# File 'lib/flightxml/v3/operations.rb', line 151

def count_all_enroute_airline_operations()
  command = Command.new(
    command: :CountAllEnrouteAirlineOperations,
    result: Types::CountAllEnrouteAirlineOperationsResults,
    version: 3,
    parameters: {}
  )
  perform_operation(command)
end

#decode_flight_route(faFlightID:) ⇒ Hash

Perform a DecodeFlightRoute request

Parameters:

  • faFlightID (String)

Returns:

  • (Hash)

    A Hash containing a DecodeFlightRouteResults response

See Also:


166
167
168
169
170
171
172
173
174
# File 'lib/flightxml/v3/operations.rb', line 166

def decode_flight_route(faFlightID:)
  command = Command.new(
    command: :DecodeFlightRoute,
    result: Types::DecodeFlightRouteResults,
    version: 3,
    parameters: {faFlightID: faFlightID}
  )
  perform_operation(command)
end

#decode_route(origin:, route:, destination:) ⇒ Hash

Perform a DecodeRoute request

Parameters:

  • origin (String)
  • route (String)
  • destination (String)

Returns:

  • (Hash)

    A Hash containing a DecodeRouteResults response

See Also:


183
184
185
186
187
188
189
190
191
# File 'lib/flightxml/v3/operations.rb', line 183

def decode_route(origin:, route:, destination:)
  command = Command.new(
    command: :DecodeRoute,
    result: Types::DecodeRouteResults,
    version: 3,
    parameters: {origin: origin, route: route, destination: destination}
  )
  perform_operation(command)
end

#find_flight(origin:, destination:, include_ex_data: nil, type: nil, filter: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a FindFlight request

Parameters:

  • origin (String)
  • destination (String)
  • include_ex_data (Boolean) (defaults to: nil)
  • type (String) (defaults to: nil)
  • filter (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a FindFlightResults response

See Also:


204
205
206
207
208
209
210
211
212
# File 'lib/flightxml/v3/operations.rb', line 204

def find_flight(origin:, destination:, include_ex_data: nil, type: nil, filter: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :FindFlight,
    result: Types::FindFlightResults,
    version: 3,
    parameters: {origin: origin, destination: destination, include_ex_data: include_ex_data, type: type, filter: filter, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#fleet_boards(fleet_code:, include_ex_data: nil, type: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a FleetBoards request

Parameters:

  • fleet_code (String)
  • include_ex_data (Boolean) (defaults to: nil)
  • type (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a FleetBoardsResults response

See Also:


223
224
225
226
227
228
229
230
231
# File 'lib/flightxml/v3/operations.rb', line 223

def fleet_boards(fleet_code:, include_ex_data: nil, type: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :FleetBoards,
    result: Types::FleetBoardsResults,
    version: 3,
    parameters: {fleet_code: fleet_code, include_ex_data: include_ex_data, type: type, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#flight_cancellation_statistics(time_period:, type_matching:, ident_filter: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a FlightCancellationStatistics request

Parameters:

  • time_period (String)
  • type_matching (String)
  • ident_filter (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a FlightCancellationStatisticsResults response

See Also:


242
243
244
245
246
247
248
249
250
# File 'lib/flightxml/v3/operations.rb', line 242

def flight_cancellation_statistics(time_period:, type_matching:, ident_filter: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :FlightCancellationStatistics,
    result: Types::FlightCancellationStatisticsResults,
    version: 3,
    parameters: {time_period: time_period, type_matching: type_matching, ident_filter: ident_filter, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#flight_info_status(ident:, include_ex_data: nil, filter: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a FlightInfoStatus request

Parameters:

  • ident (String)
  • include_ex_data (Boolean) (defaults to: nil)
  • filter (String) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a FlightInfoStatusResults response

See Also:


261
262
263
264
265
266
267
268
269
# File 'lib/flightxml/v3/operations.rb', line 261

def flight_info_status(ident:, include_ex_data: nil, filter: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :FlightInfoStatus,
    result: Types::FlightInfoStatusResults,
    version: 3,
    parameters: {ident: ident, include_ex_data: include_ex_data, filter: filter, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#get_flight_track(ident:, include_position_estimates: nil) ⇒ Hash

Perform a GetFlightTrack request

Parameters:

  • ident (String)
  • include_position_estimates (Boolean) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a GetFlightTrackResults response

See Also:


277
278
279
280
281
282
283
284
285
# File 'lib/flightxml/v3/operations.rb', line 277

def get_flight_track(ident:, include_position_estimates: nil)
  command = Command.new(
    command: :GetFlightTrack,
    result: Types::GetFlightTrackResults,
    version: 3,
    parameters: {ident: ident, include_position_estimates: include_position_estimates}
  )
  perform_operation(command)
end

#lat_longs_to_distance(lat1:, lon1:, lat2:, lon2:) ⇒ Hash

Perform a LatLongsToDistance request

Parameters:

  • lat1 (Float)
  • lon1 (Float)
  • lat2 (Float)
  • lon2 (Float)

Returns:

  • (Hash)

    A Hash containing a LatLongsToDistanceResults response

See Also:


295
296
297
298
299
300
301
302
303
# File 'lib/flightxml/v3/operations.rb', line 295

def lat_longs_to_distance(lat1:, lon1:, lat2:, lon2:)
  command = Command.new(
    command: :LatLongsToDistance,
    result: Types::LatLongsToDistanceResults,
    version: 3,
    parameters: {lat1: lat1, lon1: lon1, lat2: lat2, lon2: lon2}
  )
  perform_operation(command)
end

#lat_longs_to_heading(lat1:, lon1:, lat2:, lon2:) ⇒ Hash

Perform a LatLongsToHeading request

Parameters:

  • lat1 (Float)
  • lon1 (Float)
  • lat2 (Float)
  • lon2 (Float)

Returns:

  • (Hash)

    A Hash containing a LatLongsToHeadingResults response

See Also:


313
314
315
316
317
318
319
320
321
# File 'lib/flightxml/v3/operations.rb', line 313

def lat_longs_to_heading(lat1:, lon1:, lat2:, lon2:)
  command = Command.new(
    command: :LatLongsToHeading,
    result: Types::LatLongsToHeadingResults,
    version: 3,
    parameters: {lat1: lat1, lon1: lon1, lat2: lat2, lon2: lon2}
  )
  perform_operation(command)
end

#nearby_airports(latitude: nil, longitude: nil, airport_code: nil, radius:, only_iap: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a NearbyAirports request

Parameters:

  • latitude (Float) (defaults to: nil)
  • longitude (Float) (defaults to: nil)
  • airport_code (String) (defaults to: nil)
  • radius (Int)
  • only_iap (Boolean) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a NearbyAirportsResults response

See Also:


334
335
336
337
338
339
340
341
342
# File 'lib/flightxml/v3/operations.rb', line 334

def nearby_airports(latitude: nil, longitude: nil, airport_code: nil, radius:, only_iap: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :NearbyAirports,
    result: Types::NearbyAirportsResults,
    version: 3,
    parameters: {latitude: latitude, longitude: longitude, airport_code: airport_code, radius: radius, only_iap: only_iap, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#routes_between_airports(origin:, destination:, max_file_age:, sort_by:, howMany: nil, offset: nil) ⇒ Hash

Perform a RoutesBetweenAirports request

Parameters:

  • origin (String)
  • destination (String)
  • max_file_age (String)
  • sort_by (String)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a RoutesBetweenAirportsResults response

See Also:


354
355
356
357
358
359
360
361
362
# File 'lib/flightxml/v3/operations.rb', line 354

def routes_between_airports(origin:, destination:, max_file_age:, sort_by:, howMany: nil, offset: nil)
  command = Command.new(
    command: :RoutesBetweenAirports,
    result: Types::RoutesBetweenAirportsResults,
    version: 3,
    parameters: {origin: origin, destination: destination, max_file_age: max_file_age, sort_by: sort_by, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#tail_owner(ident:) ⇒ Hash

Perform a TailOwner request

Parameters:

  • ident (String)

Returns:

  • (Hash)

    A Hash containing a TailOwnerResults response

See Also:


369
370
371
372
373
374
375
376
377
# File 'lib/flightxml/v3/operations.rb', line 369

def tail_owner(ident:)
  command = Command.new(
    command: :TailOwner,
    result: Types::TailOwnerResults,
    version: 3,
    parameters: {ident: ident}
  )
  perform_operation(command)
end

#weather_conditions(airport_code:, weather_date: nil, temperature_units: nil, return_nearby_weather: nil, howMany: nil, offset: nil) ⇒ Hash

Perform a WeatherConditions request

Parameters:

  • airport_code (String)
  • weather_date (Int) (defaults to: nil)
  • temperature_units (String) (defaults to: nil)
  • return_nearby_weather (Boolean) (defaults to: nil)
  • howMany (Int) (defaults to: nil)
  • offset (Int) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a WeatherConditionsResults response

See Also:


389
390
391
392
393
394
395
396
397
# File 'lib/flightxml/v3/operations.rb', line 389

def weather_conditions(airport_code:, weather_date: nil, temperature_units: nil, return_nearby_weather: nil, howMany: nil, offset: nil)
  command = Command.new(
    command: :WeatherConditions,
    result: Types::WeatherConditionsResults,
    version: 3,
    parameters: {airport_code: airport_code, weather_date: weather_date, temperature_units: temperature_units, return_nearby_weather: return_nearby_weather, howMany: howMany, offset: offset}
  )
  perform_operation(command)
end

#weather_forecast(airport_code:, weather_date: nil, return_nearby_weather: nil) ⇒ Hash

Perform a WeatherForecast request

Parameters:

  • airport_code (String)
  • weather_date (Int) (defaults to: nil)
  • return_nearby_weather (Boolean) (defaults to: nil)

Returns:

  • (Hash)

    A Hash containing a WeatherForecastResults response

See Also:


406
407
408
409
410
411
412
413
414
# File 'lib/flightxml/v3/operations.rb', line 406

def weather_forecast(airport_code:, weather_date: nil, return_nearby_weather: nil)
  command = Command.new(
    command: :WeatherForecast,
    result: Types::WeatherForecastResults,
    version: 3,
    parameters: {airport_code: airport_code, weather_date: weather_date, return_nearby_weather: return_nearby_weather}
  )
  perform_operation(command)
end

#zipcode_info(zipcode:) ⇒ Hash

Perform a ZipcodeInfo request

Parameters:

  • zipcode (String)

Returns:

  • (Hash)

    A Hash containing a ZipcodeInfoResults response

See Also:


421
422
423
424
425
426
427
428
429
# File 'lib/flightxml/v3/operations.rb', line 421

def zipcode_info(zipcode:)
  command = Command.new(
    command: :ZipcodeInfo,
    result: Types::ZipcodeInfoResults,
    version: 3,
    parameters: {zipcode: zipcode}
  )
  perform_operation(command)
end