net.troja.eve.esi.api

Class PlanetaryInteractionApi

java.lang.Object

net.troja.eve.esi.api.PlanetaryInteractionApi

public class PlanetaryInteractionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PlanetaryInteractionApi()
PlanetaryInteractionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<CharacterPlanetsResponse>	getCharactersCharacterIdPlanets(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1
CharacterPlanetResponse	getCharactersCharacterIdPlanetsPlanetId(Integer characterId, Integer planetId, String datasource, String token, String userAgent, String xUserAgent) Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes.
PlanetFactorySchematicResponse	getUniverseSchematicsSchematicId(Integer schematicId, String datasource, String userAgent, String xUserAgent) Get schematic information Get information on a planetary factory schematic --- 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

PlanetaryInteractionApi

public PlanetaryInteractionApi()

PlanetaryInteractionApi

public PlanetaryInteractionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdPlanets

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

Get colonies Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - Character id of the target character (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:

List<CharacterPlanetsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdPlanetsPlanetId

public CharacterPlanetResponse getCharactersCharacterIdPlanetsPlanetId(Integer characterId,
                                                                       Integer planetId,
                                                                       String datasource,
                                                                       String token,
                                                                       String userAgent,
                                                                       String xUserAgent)
                                                                throws ApiException

Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information on this endpoint will not update until this criteria is met. --- This route is cached for up to 600 seconds SSO Scope: esi-planets.manage_planets.v1

Parameters:

characterId - Character id of the target character (required)

planetId - Planet id of the target planet (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:

CharacterPlanetResponse

Throws:

ApiException - if fails to make API call

getUniverseSchematicsSchematicId

public PlanetFactorySchematicResponse getUniverseSchematicsSchematicId(Integer schematicId,
                                                                       String datasource,
                                                                       String userAgent,
                                                                       String xUserAgent)
                                                                throws ApiException

Get schematic information Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds

Parameters:

schematicId - A PI schematic 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:

PlanetFactorySchematicResponse

Throws:

ApiException - if fails to make API call