Skip to content

Latest commit

 

History

History
266 lines (187 loc) · 10.6 KB

AllianceApi.md

File metadata and controls

266 lines (187 loc) · 10.6 KB

Swagger\Client\AllianceApi

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

Method HTTP request Description
getAlliances GET /alliances/ List all alliances
getAlliancesAllianceId GET /alliances/{alliance_id}/ Get alliance information
getAlliancesAllianceIdCorporations GET /alliances/{alliance_id}/corporations/ List alliance's corporations
getAlliancesAllianceIdIcons GET /alliances/{alliance_id}/icons/ Get alliance icon
getAlliancesNames GET /alliances/names/ Get alliance names

getAlliances

int[] getAlliances($datasource, $user_agent, $x_user_agent)

List all alliances

List all active player alliances --- Alternate route: /v1/alliances/ Alternate route: /legacy/alliances/ Alternate route: /dev/alliances/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\AllianceApi(new \Http\Adapter\Guzzle6\Client());
$datasource = "tranquility"; // string | The server name you would like data from
$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->getAlliances($datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliances: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
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]

getAlliancesAllianceId

\Swagger\Client\Model\GetAlliancesAllianceIdOk getAlliancesAllianceId($alliance_id, $datasource, $user_agent, $x_user_agent)

Get alliance information

Public information about an alliance --- Alternate route: /v2/alliances/{alliance_id}/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\AllianceApi(new \Http\Adapter\Guzzle6\Client());
$alliance_id = 56; // int | An EVE alliance ID
$datasource = "tranquility"; // string | The server name you would like data from
$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->getAlliancesAllianceId($alliance_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliancesAllianceId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
alliance_id int An EVE alliance ID
datasource string The server name you would like data from [optional] [default to tranquility]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetAlliancesAllianceIdOk

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]

getAlliancesAllianceIdCorporations

int[] getAlliancesAllianceIdCorporations($alliance_id, $datasource, $user_agent, $x_user_agent)

List alliance's corporations

List all current member corporations of an alliance --- Alternate route: /v1/alliances/{alliance_id}/corporations/ Alternate route: /legacy/alliances/{alliance_id}/corporations/ Alternate route: /dev/alliances/{alliance_id}/corporations/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\AllianceApi(new \Http\Adapter\Guzzle6\Client());
$alliance_id = 56; // int | An EVE alliance ID
$datasource = "tranquility"; // string | The server name you would like data from
$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->getAlliancesAllianceIdCorporations($alliance_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliancesAllianceIdCorporations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
alliance_id int An EVE alliance ID
datasource string The server name you would like data from [optional] [default to tranquility]
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]

getAlliancesAllianceIdIcons

\Swagger\Client\Model\GetAlliancesAllianceIdIconsOk getAlliancesAllianceIdIcons($alliance_id, $datasource, $user_agent, $x_user_agent)

Get alliance icon

Get the icon urls for a alliance --- Alternate route: /v1/alliances/{alliance_id}/icons/ Alternate route: /legacy/alliances/{alliance_id}/icons/ Alternate route: /dev/alliances/{alliance_id}/icons/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\AllianceApi(new \Http\Adapter\Guzzle6\Client());
$alliance_id = 56; // int | An EVE alliance ID
$datasource = "tranquility"; // string | The server name you would like data from
$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->getAlliancesAllianceIdIcons($alliance_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliancesAllianceIdIcons: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
alliance_id int An EVE alliance ID
datasource string The server name you would like data from [optional] [default to tranquility]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetAlliancesAllianceIdIconsOk

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]

getAlliancesNames

\Swagger\Client\Model\GetAlliancesNames200Ok[] getAlliancesNames($alliance_ids, $datasource, $user_agent, $x_user_agent)

Get alliance names

Resolve a set of alliance IDs to alliance names --- Alternate route: /v1/alliances/names/ Alternate route: /legacy/alliances/names/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\AllianceApi(new \Http\Adapter\Guzzle6\Client());
$alliance_ids = array(56); // int[] | A comma separated list of alliance IDs
$datasource = "tranquility"; // string | The server name you would like data from
$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->getAlliancesNames($alliance_ids, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliancesNames: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
alliance_ids int[] A comma separated list of alliance IDs
datasource string The server name you would like data from [optional] [default to tranquility]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetAlliancesNames200Ok[]

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]