Skip to content

PlanetaryInteractionApi.md

Latest commit

 

History

History
244 lines (172 loc) · 9.63 KB

PlanetaryInteractionApi.md

File metadata and controls

244 lines (172 loc) · 9.63 KB

EveSwaggerInterface.PlanetaryInteractionApi

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

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

getCharactersCharacterIdPlanets

[GetCharactersCharacterIdPlanets200Ok] getCharactersCharacterIdPlanets(characterId, opts)

Get colonies

Returns a list of all planetary colonies owned by a character. --- Alternate route: /dev/characters/{character_id}/planets/ Alternate route: /legacy/characters/{character_id}/planets/ Alternate route: /v1/characters/{character_id}/planets/ --- This route is cached for up to 600 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.PlanetaryInteractionApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdPlanets(characterId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility]
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

[GetCharactersCharacterIdPlanets200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdPlanetsPlanetId

GetCharactersCharacterIdPlanetsPlanetIdOk getCharactersCharacterIdPlanetsPlanetId(characterIdplanetId, opts)

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. --- Alternate route: /dev/characters/{character_id}/planets/{planet_id}/ Alternate route: /v3/characters/{character_id}/planets/{planet_id}/

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.PlanetaryInteractionApi();

var characterId = 56; // Number | An EVE character ID

var planetId = 56; // Number | Planet id of the target planet

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdPlanetsPlanetId(characterIdplanetId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
planetId Number Planet id of the target planet
datasource String The server name you would like data from [optional] [default to tranquility]
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

[GetCorporationsCorporationIdCustomsOffices200Ok] getCorporationsCorporationIdCustomsOffices(corporationId, opts)

List corporation customs offices

List customs offices owned by a corporation --- Alternate route: /dev/corporations/{corporation_id}/customs_offices/ Alternate route: /legacy/corporations/{corporation_id}/customs_offices/ Alternate route: /v1/corporations/{corporation_id}/customs_offices/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.PlanetaryInteractionApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdCustomsOffices(corporationId, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch String ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page Number 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

[GetCorporationsCorporationIdCustomsOffices200Ok]

Authorization

evesso

HTTP request headers

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

getUniverseSchematicsSchematicId

GetUniverseSchematicsSchematicIdOk getUniverseSchematicsSchematicId(schematicId, opts)

Get schematic information

Get information on a planetary factory schematic --- Alternate route: /dev/universe/schematics/{schematic_id}/ Alternate route: /legacy/universe/schematics/{schematic_id}/ Alternate route: /v1/universe/schematics/{schematic_id}/ --- This route is cached for up to 3600 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');

var apiInstance = new EveSwaggerInterface.PlanetaryInteractionApi();

var schematicId = 56; // Number | A PI schematic ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUniverseSchematicsSchematicId(schematicId, opts, callback);

Parameters

Name Type Description Notes
schematicId Number A PI schematic ID
datasource String The server name you would like data from [optional] [default to tranquility]
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