Skip to content

Latest commit

 

History

History
192 lines (132 loc) · 6.12 KB

WarsApi.md

File metadata and controls

192 lines (132 loc) · 6.12 KB
Raw

Swagger\Client\Eve\WarsApi

All URIs are relative to https://esi.evetech.net, except if the operation defines another base path.

Method HTTP request Description
getWars() GET /v1/wars/ List wars
getWarsWarId() GET /v1/wars/{war_id}/ Get war information
getWarsWarIdKillmails() GET /v1/wars/{war_id}/killmails/ List kills for a war

getWars()

getWars($datasource, $if_none_match, $max_war_id): int[]

List wars

Return a list of wars --- This route is cached for up to 3600 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\WarsApi(
    // 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
$max_war_id = 56; // int | Only return wars with ID smaller than this

try {
    $result = $apiInstance->getWars($datasource, $if_none_match, $max_war_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarsApi->getWars: ', $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]
max_war_id int Only return wars with ID smaller than this [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]

getWarsWarId()

getWarsWarId($war_id, $datasource, $if_none_match): \Swagger\Client\Eve\Model\GetWarsWarIdOk

Get war information

Return details about a war --- This route is cached for up to 3600 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\WarsApi(
    // 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()
);
$war_id = 56; // int | ID for a war
$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->getWarsWarId($war_id, $datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarsApi->getWarsWarId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
war_id int ID for a war
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\Eve\Model\GetWarsWarIdOk

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]

getWarsWarIdKillmails()

getWarsWarIdKillmails($war_id, $datasource, $if_none_match, $page): \Swagger\Client\Eve\Model\GetWarsWarIdKillmails200Ok[]

List kills for a war

Return a list of kills related to a war --- This route is cached for up to 3600 seconds

Example

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



$apiInstance = new Swagger\Client\Eve\Api\WarsApi(
    // 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()
);
$war_id = 56; // int | A valid war 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
$page = 1; // int | Which page of results to return

try {
    $result = $apiInstance->getWarsWarIdKillmails($war_id, $datasource, $if_none_match, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarsApi->getWarsWarIdKillmails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
war_id int A valid war 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]
page int Which page of results to return [optional] [default to 1]

Return type

\Swagger\Client\Eve\Model\GetWarsWarIdKillmails200Ok[]

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]