Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.88 KB

RoutesApi.md

File metadata and controls

68 lines (49 loc) · 2.88 KB
Raw

Swagger\Client\RoutesApi

All URIs are relative to https://esi.tech.ccp.is/latest

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

getRouteOriginDestination

int[] getRouteOriginDestination($destination, $origin, $avoid, $connections, $datasource, $flag, $user_agent, $x_user_agent)

Get route

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RoutesApi(new \Http\Adapter\Guzzle6\Client());
$destination = 56; // int | destination solar system ID
$origin = 56; // int | origin solar system ID
$avoid = array(56); // int[] | avoid solar system ID(s)
$connections = array(new \Swagger\Client\Model\int[]()); // int[][] | connected solar system pairs
$datasource = "tranquility"; // string | The server name you would like data from
$flag = "shortest"; // string | route security preference
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getRouteOriginDestination($destination, $origin, $avoid, $connections, $datasource, $flag, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutesApi->getRouteOriginDestination: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
destination int destination solar system ID
origin int origin solar system ID
avoid int[] avoid solar system ID(s) [optional]
connections int[][] 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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

int[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]