esi

v0.1.1

esi v0.1.1 ESI.API.Route

Summary

Types

route_opt()
route_opts()

Options for Route.route/3

Functions

route(origin, destination, opts \\ [])

Get the systems between origin and destination

Types

route_opt() 
route_opt ::
  {:avoid, nil | [integer]} |
  {:connections, nil | [[integer]]} |
  {:flag, nil | :shortest | :secure | :insecure}
route_opts() 
route_opts() :: [route_opt]

Options for Route.route/3.

  • :avoid — avoid solar system ID(s)
  • :connections — connected solar system pairs
  • :flag (DEFAULT: :shortest) — route security preference

Functions

route(origin, destination, opts \\ []) 
route(origin :: integer, destination :: integer, opts :: route_opts) :: ESI.Request.t

Get the systems between origin and destination.

Response Example

Solar systems in route from origin to destination:

[30002771, 30002770, 30002769, 30002772]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_route_origin_destination
  • path — /route/{origin}/{destination}/

View on ESI Site