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<CharacterResearchAgentsResponse>	getCharactersCharacterIdAgentsResearch(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get agents research Return a list of agents research information for a character.
List<CharacterBlueprintsResponse>	getCharactersCharacterIdBlueprints(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get blueprints Return a list of blueprints the character has --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_blueprints.v1
List<CharacterChatChannelsResponse>	getCharactersCharacterIdChatChannels(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get chat channels Return chat channels that a character is the owner or an operator of --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_chat_channels.v1
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
CharacterFatigueResponse	getCharactersCharacterIdFatigue(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get jump fatigue Return a character's jump activation and fatigue information --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_fatigue.v1
List<CharacterMedalsResponse>	getCharactersCharacterIdMedals(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get medals Return a list of medals the character has --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_medals.v1
List<CharacterNotificationsResponse>	getCharactersCharacterIdNotifications(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get character notifications Return character notifications --- This route is cached for up to 1800 seconds SSO Scope: esi-characters.read_notifications.v1
List<NewContactNotificationsResponse>	getCharactersCharacterIdNotificationsContacts(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get new contact notifications Return notifications about having been added to someone's contact list --- This route is cached for up to 600 seconds SSO Scope: esi-characters.read_notifications.v1
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<String>	getCharactersCharacterIdRoles(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get character corporation roles Returns a character's corporation roles --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_corporation_roles.v1
List<CharacterStandingsResponse>	getCharactersCharacterIdStandings(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get standings Return character standings from agents, NPC corporations, and factions --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_standings.v1
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
List<CharacterAffiliationResponse>	postCharactersAffiliation(List<Integer> characters, String datasource, String userAgent, String xUserAgent) Character affiliation Bulk lookup of character IDs to corporation, alliance and faction --- 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

getCharactersCharacterIdAgentsResearch

public List<CharacterResearchAgentsResponse> getCharactersCharacterIdAgentsResearch(Integer characterId,
                                                                                    String datasource,
                                                                                    String token,
                                                                                    String userAgent,
                                                                                    String xUserAgent)
                                                                             throws ApiException

Get agents research Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) --- 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)

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterResearchAgentsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdBlueprints

public List<CharacterBlueprintsResponse> getCharactersCharacterIdBlueprints(Integer characterId,
                                                                            String datasource,
                                                                            String token,
                                                                            String userAgent,
                                                                            String xUserAgent)
                                                                     throws ApiException

Get blueprints Return a list of blueprints the character has --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_blueprints.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterBlueprintsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdChatChannels

public List<CharacterChatChannelsResponse> getCharactersCharacterIdChatChannels(Integer characterId,
                                                                                String datasource,
                                                                                String token,
                                                                                String userAgent,
                                                                                String xUserAgent)
                                                                         throws ApiException

Get chat channels Return chat channels that a character is the owner or an operator of --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_chat_channels.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterChatChannelsResponse>

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

getCharactersCharacterIdFatigue

public CharacterFatigueResponse getCharactersCharacterIdFatigue(Integer characterId,
                                                                String datasource,
                                                                String token,
                                                                String userAgent,
                                                                String xUserAgent)
                                                         throws ApiException

Get jump fatigue Return a character's jump activation and fatigue information --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_fatigue.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

CharacterFatigueResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMedals

public List<CharacterMedalsResponse> getCharactersCharacterIdMedals(Integer characterId,
                                                                    String datasource,
                                                                    String token,
                                                                    String userAgent,
                                                                    String xUserAgent)
                                                             throws ApiException

Get medals Return a list of medals the character has --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_medals.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterMedalsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdNotifications

public List<CharacterNotificationsResponse> getCharactersCharacterIdNotifications(Integer characterId,
                                                                                  String datasource,
                                                                                  String token,
                                                                                  String userAgent,
                                                                                  String xUserAgent)
                                                                           throws ApiException

Get character notifications Return character notifications --- This route is cached for up to 1800 seconds SSO Scope: esi-characters.read_notifications.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterNotificationsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdNotificationsContacts

public List<NewContactNotificationsResponse> getCharactersCharacterIdNotificationsContacts(Integer characterId,
                                                                                           String datasource,
                                                                                           String token,
                                                                                           String userAgent,
                                                                                           String xUserAgent)
                                                                                    throws ApiException

Get new contact notifications Return notifications about having been added to someone's contact list --- This route is cached for up to 600 seconds SSO Scope: esi-characters.read_notifications.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<NewContactNotificationsResponse>

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

getCharactersCharacterIdRoles

public List<String> getCharactersCharacterIdRoles(Integer characterId,
                                                  String datasource,
                                                  String token,
                                                  String userAgent,
                                                  String xUserAgent)
                                           throws ApiException

Get character corporation roles Returns a character's corporation roles --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_corporation_roles.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<String>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdStandings

public List<CharacterStandingsResponse> getCharactersCharacterIdStandings(Integer characterId,
                                                                          String datasource,
                                                                          String token,
                                                                          String userAgent,
                                                                          String xUserAgent)
                                                                   throws ApiException

Get standings Return character standings from agents, NPC corporations, and factions --- This route is cached for up to 3600 seconds SSO Scope: esi-characters.read_standings.v1

Parameters:

characterId - An EVE character ID (required)

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

token - Access token to use if unable to set a header (optional)

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

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

Returns:

List<CharacterStandingsResponse>

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

postCharactersAffiliation

public List<CharacterAffiliationResponse> postCharactersAffiliation(List<Integer> characters,
                                                                    String datasource,
                                                                    String userAgent,
                                                                    String xUserAgent)
                                                             throws ApiException

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction --- This route is cached for up to 3600 seconds

Parameters:

characters - The character IDs to fetch affiliations for. All characters must exist, or none will be returned. (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<CharacterAffiliationResponse>

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 unable to set 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