Skip to content

Latest commit

 

History

History
242 lines (179 loc) · 10.8 KB

PlanetaryInteractionApi.md

File metadata and controls

242 lines (179 loc) · 10.8 KB
Raw

PlanetaryInteractionApi

All URIs are relative to https://esi.evetech.net

Method HTTP request Description
getCharactersCharacterIdPlanets GET /v1/characters/{character_id}/planets/ Get colonies
getCharactersCharacterIdPlanetsPlanetId GET /v3/characters/{character_id}/planets/{planet_id}/ Get colony layout
getCorporationsCorporationIdCustomsOffices GET /v1/corporations/{corporation_id}/customs_offices/ List corporation customs offices
getUniverseSchematicsSchematicId GET /v1/universe/schematics/{schematic_id}/ Get schematic information

getCharactersCharacterIdPlanets

List<GetCharactersCharacterIdPlanets200Ok> getCharactersCharacterIdPlanets(characterId, datasource, ifNoneMatch, token)

Get colonies

Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.PlanetaryInteractionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

PlanetaryInteractionApi apiInstance = new PlanetaryInteractionApi();
Integer characterId = 56; // Integer | An EVE character ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    List<GetCharactersCharacterIdPlanets200Ok> result = apiInstance.getCharactersCharacterIdPlanets(characterId, datasource, ifNoneMatch, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PlanetaryInteractionApi#getCharactersCharacterIdPlanets");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
characterId Integer An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

List<GetCharactersCharacterIdPlanets200Ok>

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdPlanetsPlanetId

GetCharactersCharacterIdPlanetsPlanetIdOk getCharactersCharacterIdPlanetsPlanetId(characterId, planetId, datasource, ifNoneMatch, token)

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 will not update until this criteria is met. --- This route is cached for up to 600 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.PlanetaryInteractionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

PlanetaryInteractionApi apiInstance = new PlanetaryInteractionApi();
Integer characterId = 56; // Integer | An EVE character ID
Integer planetId = 56; // Integer | Planet id of the target planet
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    GetCharactersCharacterIdPlanetsPlanetIdOk result = apiInstance.getCharactersCharacterIdPlanetsPlanetId(characterId, planetId, datasource, ifNoneMatch, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PlanetaryInteractionApi#getCharactersCharacterIdPlanetsPlanetId");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
characterId Integer An EVE character ID
planetId Integer Planet id of the target planet
datasource String The server name you would like data from [optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token String Access token to use if unable to set a header [optional]

Return type

GetCharactersCharacterIdPlanetsPlanetIdOk

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdCustomsOffices

List<GetCorporationsCorporationIdCustomsOffices200Ok> getCorporationsCorporationIdCustomsOffices(corporationId, datasource, ifNoneMatch, page, token)

List corporation customs offices

List customs offices owned by a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.PlanetaryInteractionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

PlanetaryInteractionApi apiInstance = new PlanetaryInteractionApi();
Integer corporationId = 56; // Integer | An EVE corporation ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
Integer page = 1; // Integer | Which page of results to return
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    List<GetCorporationsCorporationIdCustomsOffices200Ok> result = apiInstance.getCorporationsCorporationIdCustomsOffices(corporationId, datasource, ifNoneMatch, page, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PlanetaryInteractionApi#getCorporationsCorporationIdCustomsOffices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
corporationId Integer An EVE corporation ID
datasource String The server name you would like data from [optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page Integer Which page of results to return [optional] [default to 1]
token String Access token to use if unable to set a header [optional]

Return type

List<GetCorporationsCorporationIdCustomsOffices200Ok>

Authorization

evesso

HTTP request headers

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

getUniverseSchematicsSchematicId

GetUniverseSchematicsSchematicIdOk getUniverseSchematicsSchematicId(schematicId, datasource, ifNoneMatch)

Get schematic information

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

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.api.PlanetaryInteractionApi;


PlanetaryInteractionApi apiInstance = new PlanetaryInteractionApi();
Integer schematicId = 56; // Integer | A PI schematic ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
try {
    GetUniverseSchematicsSchematicIdOk result = apiInstance.getUniverseSchematicsSchematicId(schematicId, datasource, ifNoneMatch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PlanetaryInteractionApi#getUniverseSchematicsSchematicId");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
schematicId Integer A PI schematic ID
datasource String The server name you would like data from [optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]

Return type

GetUniverseSchematicsSchematicIdOk

Authorization

No authorization required

HTTP request headers

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