Skip to content

Latest commit

 

History

History
178 lines (129 loc) · 6.77 KB

WarsApi.md

File metadata and controls

178 lines (129 loc) · 6.77 KB
Raw

nullx27\ESI\WarsApi

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

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

getWars

int[] getWars($datasource, $maxWarId, $userAgent, $xUserAgent)

List wars

Return a list of wars --- Alternate route: /dev/wars/ Alternate route: /legacy/wars/ Alternate route: /v1/wars/ --- This route is cached for up to 3600 seconds

Example

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

$apiInstance = new nullx27\ESI\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
$maxWarId = 56; // int | Only return wars with ID smaller than this.
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getWars($datasource, $maxWarId, $userAgent, $xUserAgent);
    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]
maxWarId int Only return wars with ID smaller than this. [optional]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent 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]

getWarsWarId

\nullx27\ESI\nullx27\ESI\Models\GetWarsWarIdOk getWarsWarId($warId, $datasource, $userAgent, $xUserAgent)

Get war information

Return details about a war --- Alternate route: /dev/wars/{war_id}/ Alternate route: /legacy/wars/{war_id}/ Alternate route: /v1/wars/{war_id}/ --- This route is cached for up to 3600 seconds

Example

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

$apiInstance = new nullx27\ESI\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()
);
$warId = 56; // int | ID for a war
$datasource = "tranquility"; // string | The server name you would like data from
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getWarsWarId($warId, $datasource, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarsApi->getWarsWarId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
warId int ID for a war
datasource string The server name you would like data from [optional] [default to tranquility]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent string Client identifier, takes precedence over User-Agent [optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\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

\nullx27\ESI\nullx27\ESI\Models\GetWarsWarIdKillmails200Ok[] getWarsWarIdKillmails($warId, $datasource, $page, $userAgent, $xUserAgent)

List kills for a war

Return a list of kills related to a war --- Alternate route: /dev/wars/{war_id}/killmails/ Alternate route: /legacy/wars/{war_id}/killmails/ Alternate route: /v1/wars/{war_id}/killmails/ --- This route is cached for up to 3600 seconds

Example

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

$apiInstance = new nullx27\ESI\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()
);
$warId = 56; // int | A valid war ID
$datasource = "tranquility"; // string | The server name you would like data from
$page = 1; // int | Which page of results to return
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

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

Parameters

Name Type Description Notes
warId int A valid war ID
datasource string The server name you would like data from [optional] [default to tranquility]
page int Which page of results to return [optional] [default to 1]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent string Client identifier, takes precedence over User-Agent [optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\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]