Skip to content

BookmarksApi.md

Latest commit

 

History

History
256 lines (184 loc) · 10.3 KB

BookmarksApi.md

File metadata and controls

256 lines (184 loc) · 10.3 KB

EveSwaggerInterface.BookmarksApi

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

Method HTTP request Description
getCharactersCharacterIdBookmarks GET /characters/{character_id}/bookmarks/ List bookmarks
getCharactersCharacterIdBookmarksFolders GET /characters/{character_id}/bookmarks/folders/ List bookmark folders
getCorporationsCorporationIdBookmarks GET /corporations/{corporation_id}/bookmarks/ List corporation bookmarks
getCorporationsCorporationIdBookmarksFolders GET /corporations/{corporation_id}/bookmarks/folders/ List corporation bookmark folders

getCharactersCharacterIdBookmarks

[GetCharactersCharacterIdBookmarks200Ok] getCharactersCharacterIdBookmarks(characterId, opts)

List bookmarks

A list of your character's personal bookmarks --- Alternate route: /dev/characters/{character_id}/bookmarks/ Alternate route: /v2/characters/{character_id}/bookmarks/ --- 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.BookmarksApi();

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

[GetCharactersCharacterIdBookmarks200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdBookmarksFolders

[GetCharactersCharacterIdBookmarksFolders200Ok] getCharactersCharacterIdBookmarksFolders(characterId, opts)

List bookmark folders

A list of your character's personal bookmark folders --- Alternate route: /dev/characters/{character_id}/bookmarks/folders/ Alternate route: /v2/characters/{character_id}/bookmarks/folders/ --- 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.BookmarksApi();

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

[GetCharactersCharacterIdBookmarksFolders200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdBookmarks

[GetCorporationsCorporationIdBookmarks200Ok] getCorporationsCorporationIdBookmarks(corporationId, opts)

List corporation bookmarks

A list of your corporation's bookmarks --- Alternate route: /dev/corporations/{corporation_id}/bookmarks/ Alternate route: /legacy/corporations/{corporation_id}/bookmarks/ Alternate route: /v1/corporations/{corporation_id}/bookmarks/ --- 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.BookmarksApi();

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

[GetCorporationsCorporationIdBookmarks200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdBookmarksFolders

[GetCorporationsCorporationIdBookmarksFolders200Ok] getCorporationsCorporationIdBookmarksFolders(corporationId, opts)

List corporation bookmark folders

A list of your corporation's bookmark folders --- Alternate route: /dev/corporations/{corporation_id}/bookmarks/folders/ Alternate route: /legacy/corporations/{corporation_id}/bookmarks/folders/ Alternate route: /v1/corporations/{corporation_id}/bookmarks/folders/ --- 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.BookmarksApi();

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

[GetCorporationsCorporationIdBookmarksFolders200Ok]

Authorization

evesso

HTTP request headers

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