Skip to content

LocationApi.md

Latest commit

 

History

History
188 lines (133 loc) · 7.25 KB

LocationApi.md

File metadata and controls

188 lines (133 loc) · 7.25 KB

EveSwaggerInterface.LocationApi

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

Method HTTP request Description
getCharactersCharacterIdLocation GET /characters/{character_id}/location/ Get character location
getCharactersCharacterIdOnline GET /characters/{character_id}/online/ Get character online
getCharactersCharacterIdShip GET /characters/{character_id}/ship/ Get current ship

getCharactersCharacterIdLocation

GetCharactersCharacterIdLocationOk getCharactersCharacterIdLocation(characterId, opts)

Get character location

Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable --- Alternate route: /dev/characters/{character_id}/location/ Alternate route: /legacy/characters/{character_id}/location/ Alternate route: /v1/characters/{character_id}/location/ Alternate route: /v2/characters/{character_id}/location/ --- This route is cached for up to 5 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.LocationApi();

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.getCharactersCharacterIdLocation(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

GetCharactersCharacterIdLocationOk

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdOnline

GetCharactersCharacterIdOnlineOk getCharactersCharacterIdOnline(characterId, opts)

Get character online

Checks if the character is currently online --- Alternate route: /dev/characters/{character_id}/online/ Alternate route: /v2/characters/{character_id}/online/ Alternate route: /v3/characters/{character_id}/online/ --- This route is cached for up to 60 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.LocationApi();

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.getCharactersCharacterIdOnline(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

GetCharactersCharacterIdOnlineOk

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdShip

GetCharactersCharacterIdShipOk getCharactersCharacterIdShip(characterId, opts)

Get current ship

Get the current ship type, name and id --- Alternate route: /dev/characters/{character_id}/ship/ Alternate route: /legacy/characters/{character_id}/ship/ Alternate route: /v1/characters/{character_id}/ship/ Alternate route: /v2/characters/{character_id}/ship/ --- This route is cached for up to 5 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.LocationApi();

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.getCharactersCharacterIdShip(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

GetCharactersCharacterIdShipOk

Authorization

evesso

HTTP request headers

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