Skip to content

AssetsApi.md

Latest commit

 

History

History
376 lines (266 loc) · 14.7 KB

AssetsApi.md

File metadata and controls

376 lines (266 loc) · 14.7 KB

EveSwaggerInterface.AssetsApi

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

Method HTTP request Description
getCharactersCharacterIdAssets GET /characters/{character_id}/assets/ Get character assets
getCorporationsCorporationIdAssets GET /corporations/{corporation_id}/assets/ Get corporation assets
postCharactersCharacterIdAssetsLocations POST /characters/{character_id}/assets/locations/ Get character asset locations
postCharactersCharacterIdAssetsNames POST /characters/{character_id}/assets/names/ Get character asset names
postCorporationsCorporationIdAssetsLocations POST /corporations/{corporation_id}/assets/locations/ Get corporation asset locations
postCorporationsCorporationIdAssetsNames POST /corporations/{corporation_id}/assets/names/ Get corporation asset names

getCharactersCharacterIdAssets

[GetCharactersCharacterIdAssets200Ok] getCharactersCharacterIdAssets(characterId, opts)

Get character assets

Return a list of the characters assets --- Alternate route: /dev/characters/{character_id}/assets/ Alternate route: /v5/characters/{character_id}/assets/ --- This route is cached for up to 3600 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.AssetsApi();

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
  '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.getCharactersCharacterIdAssets(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]
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

[GetCharactersCharacterIdAssets200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdAssets

[GetCorporationsCorporationIdAssets200Ok] getCorporationsCorporationIdAssets(corporationId, opts)

Get corporation assets

Return a list of the corporation assets --- Alternate route: /dev/corporations/{corporation_id}/assets/ Alternate route: /v5/corporations/{corporation_id}/assets/ --- 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.AssetsApi();

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

[GetCorporationsCorporationIdAssets200Ok]

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdAssetsLocations

[PostCharactersCharacterIdAssetsLocations200Ok] postCharactersCharacterIdAssetsLocations(characterIditemIds, opts)

Get character asset locations

Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) --- Alternate route: /dev/characters/{character_id}/assets/locations/ Alternate route: /v2/characters/{character_id}/assets/locations/

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.AssetsApi();

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

var itemIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of item ids

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.postCharactersCharacterIdAssetsLocations(characterIditemIds, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
itemIds [Number] A list of item ids
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

[PostCharactersCharacterIdAssetsLocations200Ok]

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdAssetsNames

[PostCharactersCharacterIdAssetsNames200Ok] postCharactersCharacterIdAssetsNames(characterIditemIds, opts)

Get character asset names

Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. --- Alternate route: /dev/characters/{character_id}/assets/names/ Alternate route: /legacy/characters/{character_id}/assets/names/ Alternate route: /v1/characters/{character_id}/assets/names/

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.AssetsApi();

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

var itemIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of item ids

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.postCharactersCharacterIdAssetsNames(characterIditemIds, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
itemIds [Number] A list of item ids
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

[PostCharactersCharacterIdAssetsNames200Ok]

Authorization

evesso

HTTP request headers

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

postCorporationsCorporationIdAssetsLocations

[PostCorporationsCorporationIdAssetsLocations200Ok] postCorporationsCorporationIdAssetsLocations(corporationIditemIds, opts)

Get corporation asset locations

Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) --- Alternate route: /dev/corporations/{corporation_id}/assets/locations/ Alternate route: /v2/corporations/{corporation_id}/assets/locations/ --- 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.AssetsApi();

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

var itemIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of item ids

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.postCorporationsCorporationIdAssetsLocations(corporationIditemIds, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
itemIds [Number] A list of item ids
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

[PostCorporationsCorporationIdAssetsLocations200Ok]

Authorization

evesso

HTTP request headers

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

postCorporationsCorporationIdAssetsNames

[PostCorporationsCorporationIdAssetsNames200Ok] postCorporationsCorporationIdAssetsNames(corporationIditemIds, opts)

Get corporation asset names

Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships --- Alternate route: /dev/corporations/{corporation_id}/assets/names/ Alternate route: /legacy/corporations/{corporation_id}/assets/names/ Alternate route: /v1/corporations/{corporation_id}/assets/names/ --- 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.AssetsApi();

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

var itemIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of item ids

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.postCorporationsCorporationIdAssetsNames(corporationIditemIds, opts, callback);

Parameters

Name Type Description Notes
corporationId Number An EVE corporation ID
itemIds [Number] A list of item ids
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

[PostCorporationsCorporationIdAssetsNames200Ok]

Authorization

evesso

HTTP request headers

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