Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 3.11 KB

RoutesApi.md

File metadata and controls

86 lines (62 loc) · 3.11 KB

RubyEveesiClient::RoutesApi

All URIs are relative to https://esi.evetech.net/latest

Method HTTP request Description
get_route_origin_destination GET /route/{origin}/{destination}/ Get route

get_route_origin_destination

Array<Integer> get_route_origin_destination(destination, origin, opts)

Get route

Get the systems between origin and destination --- Alternate route: /dev/route/{origin}/{destination}/ Alternate route: /legacy/route/{origin}/{destination}/ Alternate route: /v1/route/{origin}/{destination}/ --- This route is cached for up to 86400 seconds

Examples

require 'time'
require 'ruby_eveesi_client'

api_instance = RubyEveesiClient::RoutesApi.new
destination = 56 # Integer | destination solar system ID
origin = 56 # Integer | origin solar system ID
opts = {
  avoid: [37], # Array<Integer> | avoid solar system ID(s)
  connections: [[37]], # Array<Array<Integer>> | connected solar system pairs
  datasource: 'tranquility', # String | The server name you would like data from
  flag: 'shortest', # String | route security preference
  if_none_match: 'if_none_match_example' # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
}

begin
  # Get route
  result = api_instance.get_route_origin_destination(destination, origin, opts)
  p result
rescue RubyEveesiClient::ApiError => e
  puts "Error when calling RoutesApi->get_route_origin_destination: #{e}"
end

Using the get_route_origin_destination_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Array<Integer>, Integer, Hash)> get_route_origin_destination_with_http_info(destination, origin, opts)

begin
  # Get route
  data, status_code, headers = api_instance.get_route_origin_destination_with_http_info(destination, origin, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Array&lt;Integer&gt;
rescue RubyEveesiClient::ApiError => e
  puts "Error when calling RoutesApi->get_route_origin_destination_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
destination Integer destination solar system ID
origin Integer origin solar system ID
avoid Array<Integer> avoid solar system ID(s) [optional]
connections Array<Array<Integer>> connected solar system pairs [optional]
datasource String The server name you would like data from [optional][default to 'tranquility']
flag String route security preference [optional][default to 'shortest']
if_none_match String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

Array<Integer>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json