net.troja.eve.esi.api

Class CharacterApi

java.lang.Object

net.troja.eve.esi.api.CharacterApi

public class CharacterApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CharacterApi()
CharacterApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
CharacterResponse	getCharactersCharacterId(Integer characterId, String datasource, String userAgent, String xUserAgent) Get character's public information Public information about a character --- This route is cached for up to 3600 seconds
List<CharacterCorporationHistoryResponse>	getCharactersCharacterIdCorporationhistory(Integer characterId, String datasource, String userAgent, String xUserAgent) Get corporation history Get a list of all the corporations a character has been a member of --- This route is cached for up to 3600 seconds
CharacterPortraitResponse	getCharactersCharacterIdPortrait(Integer characterId, String datasource, String userAgent, String xUserAgent) Get character portraits Get portrait urls for a character --- This route is cached for up to 3600 seconds
List<CharacterNamesResponse>	getCharactersNames(List<Long> characterIds, String datasource, String userAgent, String xUserAgent) Get character names Resolve a set of character IDs to character names --- This route is cached for up to 3600 seconds
CspaCostResponse	postCharactersCharacterIdCspa(Integer characterId, CspaCharacters characters, String datasource, String token, String userAgent, String xUserAgent) Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost --- SSO Scope: esi-characters.read_contacts.v1
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterApi

public CharacterApi()

CharacterApi

public CharacterApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterId

public CharacterResponse getCharactersCharacterId(Integer characterId,
                                                  String datasource,
                                                  String userAgent,
                                                  String xUserAgent)
                                           throws ApiException

Get character's public information Public information about a character --- This route is cached for up to 3600 seconds

Parameters:

characterId - An EVE character ID (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:

CharacterResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdCorporationhistory

public List<CharacterCorporationHistoryResponse> getCharactersCharacterIdCorporationhistory(Integer characterId,
                                                                                            String datasource,
                                                                                            String userAgent,
                                                                                            String xUserAgent)
                                                                                     throws ApiException

Get corporation history Get a list of all the corporations a character has been a member of --- This route is cached for up to 3600 seconds

Parameters:

characterId - An EVE character ID (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:

List<CharacterCorporationHistoryResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdPortrait

public CharacterPortraitResponse getCharactersCharacterIdPortrait(Integer characterId,
                                                                  String datasource,
                                                                  String userAgent,
                                                                  String xUserAgent)
                                                           throws ApiException

Get character portraits Get portrait urls for a character --- This route is cached for up to 3600 seconds

Parameters:

characterId - An EVE character ID (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:

CharacterPortraitResponse

Throws:

ApiException - if fails to make API call

getCharactersNames

public List<CharacterNamesResponse> getCharactersNames(List<Long> characterIds,
                                                       String datasource,
                                                       String userAgent,
                                                       String xUserAgent)
                                                throws ApiException

Get character names Resolve a set of character IDs to character names --- This route is cached for up to 3600 seconds

Parameters:

characterIds - A comma separated list of character IDs (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:

List<CharacterNamesResponse>

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdCspa

public CspaCostResponse postCharactersCharacterIdCspa(Integer characterId,
                                                      CspaCharacters characters,
                                                      String datasource,
                                                      String token,
                                                      String userAgent,
                                                      String xUserAgent)
                                               throws ApiException

Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost --- SSO Scope: esi-characters.read_contacts.v1

Parameters:

characterId - An EVE character ID (required)

characters - The target characters to calculate the charge for (required)

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

token - Access token to use, if preferred over a header (optional)

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

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

Returns:

CspaCostResponse

Throws:

ApiException - if fails to make API call