Skip to content

Latest commit

 

History

History
439 lines (314 loc) · 18.8 KB

FactionWarfareApi.md

File metadata and controls

439 lines (314 loc) · 18.8 KB

Swagger\Client\FactionWarfareApi

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

Method HTTP request Description
getCharactersCharacterIdFwStats GET /characters/{character_id}/fw/stats/ Overview of a character involved in faction warfare
getCorporationsCorporationIdFwStats GET /corporations/{corporation_id}/fw/stats/ Overview of a corporation involved in faction warfare
getFwLeaderboards GET /fw/leaderboards/ List of the top factions in faction warfare
getFwLeaderboardsCharacters GET /fw/leaderboards/characters/ List of the top pilots in faction warfare
getFwLeaderboardsCorporations GET /fw/leaderboards/corporations/ List of the top corporations in faction warfare
getFwStats GET /fw/stats/ An overview of statistics about factions involved in faction warfare
getFwSystems GET /fw/systems/ Ownership of faction warfare systems
getFwWars GET /fw/wars/ Data about which NPC factions are at war

getCharactersCharacterIdFwStats

\Swagger\Client\Model\GetCharactersCharacterIdFwStatsOk getCharactersCharacterIdFwStats($character_id, $datasource, $if_none_match, $token)

Overview of a character involved in faction warfare

Statistical overview of a character involved in faction warfare --- Alternate route: /dev/characters/{character_id}/fw/stats/ Alternate route: /legacy/characters/{character_id}/fw/stats/ Alternate route: /v1/characters/{character_id}/fw/stats/ Alternate route: /v2/characters/{character_id}/fw/stats/ --- This route expires daily at 11:05

Example

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

// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$token = "token_example"; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdFwStats($character_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getCharactersCharacterIdFwStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_id int An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdFwStatsOk

Authorization

evesso

HTTP request headers

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

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

getCorporationsCorporationIdFwStats

\Swagger\Client\Model\GetCorporationsCorporationIdFwStatsOk getCorporationsCorporationIdFwStats($corporation_id, $datasource, $if_none_match, $token)

Overview of a corporation involved in faction warfare

Statistics about a corporation involved in faction warfare --- Alternate route: /dev/corporations/{corporation_id}/fw/stats/ Alternate route: /legacy/corporations/{corporation_id}/fw/stats/ Alternate route: /v1/corporations/{corporation_id}/fw/stats/ Alternate route: /v2/corporations/{corporation_id}/fw/stats/ --- This route expires daily at 11:05

Example

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

// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$corporation_id = 56; // int | An EVE corporation ID
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$token = "token_example"; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCorporationsCorporationIdFwStats($corporation_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getCorporationsCorporationIdFwStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
corporation_id int An EVE corporation ID
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Model\GetCorporationsCorporationIdFwStatsOk

Authorization

evesso

HTTP request headers

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

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

getFwLeaderboards

\Swagger\Client\Model\GetFwLeaderboardsOk getFwLeaderboards($datasource, $if_none_match)

List of the top factions in faction warfare

Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday --- Alternate route: /dev/fw/leaderboards/ Alternate route: /legacy/fw/leaderboards/ Alternate route: /v1/fw/leaderboards/ Alternate route: /v2/fw/leaderboards/ --- This route expires daily at 11:05

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwLeaderboards($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwLeaderboards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwLeaderboardsOk

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]

getFwLeaderboardsCharacters

\Swagger\Client\Model\GetFwLeaderboardsCharactersOk getFwLeaderboardsCharacters($datasource, $if_none_match)

List of the top pilots in faction warfare

Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday --- Alternate route: /dev/fw/leaderboards/characters/ Alternate route: /legacy/fw/leaderboards/characters/ Alternate route: /v1/fw/leaderboards/characters/ Alternate route: /v2/fw/leaderboards/characters/ --- This route expires daily at 11:05

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwLeaderboardsCharacters($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwLeaderboardsCharacters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwLeaderboardsCharactersOk

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]

getFwLeaderboardsCorporations

\Swagger\Client\Model\GetFwLeaderboardsCorporationsOk getFwLeaderboardsCorporations($datasource, $if_none_match)

List of the top corporations in faction warfare

Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday --- Alternate route: /dev/fw/leaderboards/corporations/ Alternate route: /legacy/fw/leaderboards/corporations/ Alternate route: /v1/fw/leaderboards/corporations/ Alternate route: /v2/fw/leaderboards/corporations/ --- This route expires daily at 11:05

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwLeaderboardsCorporations($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwLeaderboardsCorporations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwLeaderboardsCorporationsOk

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]

getFwStats

\Swagger\Client\Model\GetFwStats200Ok[] getFwStats($datasource, $if_none_match)

An overview of statistics about factions involved in faction warfare

Statistical overviews of factions involved in faction warfare --- Alternate route: /dev/fw/stats/ Alternate route: /legacy/fw/stats/ Alternate route: /v1/fw/stats/ Alternate route: /v2/fw/stats/ --- This route expires daily at 11:05

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwStats($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwStats200Ok[]

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]

getFwSystems

\Swagger\Client\Model\GetFwSystems200Ok[] getFwSystems($datasource, $if_none_match)

Ownership of faction warfare systems

An overview of the current ownership of faction warfare solar systems --- Alternate route: /dev/fw/systems/ Alternate route: /legacy/fw/systems/ Alternate route: /v2/fw/systems/ Alternate route: /v3/fw/systems/ --- This route is cached for up to 1800 seconds

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwSystems($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwSystems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwSystems200Ok[]

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]

getFwWars

\Swagger\Client\Model\GetFwWars200Ok[] getFwWars($datasource, $if_none_match)

Data about which NPC factions are at war

Data about which NPC factions are at war --- Alternate route: /dev/fw/wars/ Alternate route: /legacy/fw/wars/ Alternate route: /v1/fw/wars/ Alternate route: /v2/fw/wars/ --- This route expires daily at 11:05

Example

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

$apiInstance = new Swagger\Client\Api\FactionWarfareApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = "tranquility"; // string | The server name you would like data from
$if_none_match = "if_none_match_example"; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getFwWars($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FactionWarfareApi->getFwWars: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
datasource string The server name you would like data from [optional] [default to tranquility]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

\Swagger\Client\Model\GetFwWars200Ok[]

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]