net.troja.eve.esi.api

Class WarsApi

java.lang.Object

net.troja.eve.esi.api.WarsApi

public class WarsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WarsApi()
WarsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<Integer>	getWars(String datasource, Integer maxWarId, String userAgent, String xUserAgent) List wars Return a list of wars --- Alternate route: `/v1/wars/` Alternate route: `/legacy/wars/` Alternate route: `/dev/wars/` --- This route is cached for up to 3600 seconds
WarResponse	getWarsWarId(Integer warId, String datasource, String userAgent, String xUserAgent) Get war information Return details about a war --- Alternate route: `/v1/wars/{war_id}/` Alternate route: `/legacy/wars/{war_id}/` Alternate route: `/dev/wars/{war_id}/` --- This route is cached for up to 3600 seconds
List<WarKillmailsResponse>	getWarsWarIdKillmails(Integer warId, String datasource, Integer page, String userAgent, String xUserAgent) List kills for a war Return a list of kills related to a war --- Alternate route: `/v1/wars/{war_id}/killmails/` Alternate route: `/legacy/wars/{war_id}/killmails/` Alternate route: `/dev/wars/{war_id}/killmails/` --- This route is cached for up to 3600 seconds
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WarsApi

public WarsApi()

WarsApi

public WarsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getWars

public List<Integer> getWars(String datasource,
                             Integer maxWarId,
                             String userAgent,
                             String xUserAgent)
                      throws ApiException

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

Parameters:

datasource - The server name you would like data from (optional, default to tranquility)

maxWarId - Only return wars with ID smaller than this. (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

List

Throws:

ApiException - if fails to make API call

getWarsWarId

public WarResponse getWarsWarId(Integer warId,
                                String datasource,
                                String userAgent,
                                String xUserAgent)
                         throws ApiException

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

Parameters:

warId - ID for a war (required)

datasource - The server name you would like data from (optional, default to tranquility)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

WarResponse

Throws:

ApiException - if fails to make API call

getWarsWarIdKillmails

public List<WarKillmailsResponse> getWarsWarIdKillmails(Integer warId,
                                                        String datasource,
                                                        Integer page,
                                                        String userAgent,
                                                        String xUserAgent)
                                                 throws ApiException

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

Parameters:

warId - A valid war ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

page - Which page to query, starting at 1, 2000 killmails per page. (optional, default to 1)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

List

Throws:

ApiException - if fails to make API call