Skip to content

WarsApi.md

Latest commit

 

History

History
168 lines (117 loc) · 5.25 KB

WarsApi.md

File metadata and controls

168 lines (117 loc) · 5.25 KB

EveSwaggerInterface.WarsApi

All URIs are relative to https://esi.evetech.net/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

['Number'] getWars(opts)

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.WarsApi();

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'maxWarId': 56 // Number | Only return wars with ID smaller than this
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getWars(opts, callback);

Parameters

Name Type Description Notes
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
maxWarId Number Only return wars with ID smaller than this [optional]

Return type

['Number']

Authorization

No authorization required

HTTP request headers

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

getWarsWarId

GetWarsWarIdOk getWarsWarId(warId, opts)

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.WarsApi();

var warId = 56; // Number | ID for a war

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getWarsWarId(warId, opts, callback);

Parameters

Name Type Description Notes
warId Number ID for a war
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

GetWarsWarIdOk

Authorization

No authorization required

HTTP request headers

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

getWarsWarIdKillmails

[GetWarsWarIdKillmails200Ok] getWarsWarIdKillmails(warId, opts)

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

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.WarsApi();

var warId = 56; // Number | A valid war ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getWarsWarIdKillmails(warId, opts, callback);

Parameters

Name Type Description Notes
warId Number A valid war ID
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page Number Which page of results to return [optional] [default to 1]

Return type

[GetWarsWarIdKillmails200Ok]

Authorization

No authorization required

HTTP request headers

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