Skip to content

UserInterfaceApi.md

Latest commit

 

History

History
304 lines (213 loc) · 10.2 KB

UserInterfaceApi.md

File metadata and controls

304 lines (213 loc) · 10.2 KB

EveSwaggerInterface.UserInterfaceApi

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

Method HTTP request Description
postUiAutopilotWaypoint POST /ui/autopilot/waypoint/ Set Autopilot Waypoint
postUiOpenwindowContract POST /ui/openwindow/contract/ Open Contract Window
postUiOpenwindowInformation POST /ui/openwindow/information/ Open Information Window
postUiOpenwindowMarketdetails POST /ui/openwindow/marketdetails/ Open Market Details
postUiOpenwindowNewmail POST /ui/openwindow/newmail/ Open New Mail Window

postUiAutopilotWaypoint

postUiAutopilotWaypoint(addToBeginning, clearOtherWaypoints, destinationId, opts)

Set Autopilot Waypoint

Set a solar system as autopilot waypoint --- Alternate route: /dev/ui/autopilot/waypoint/ Alternate route: /legacy/ui/autopilot/waypoint/ Alternate route: /v2/ui/autopilot/waypoint/

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

var addToBeginning = false; // Boolean | Whether this solar system should be added to the beginning of all waypoints

var clearOtherWaypoints = false; // Boolean | Whether clean other waypoints beforing adding this one

var destinationId = 789; // Number | The destination to travel to, can be solar system, station or structure's id

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.');
  }
};
apiInstance.postUiAutopilotWaypoint(addToBeginning, clearOtherWaypoints, destinationId, opts, callback);

Parameters

Name Type Description Notes
addToBeginning Boolean Whether this solar system should be added to the beginning of all waypoints [default to false]
clearOtherWaypoints Boolean Whether clean other waypoints beforing adding this one [default to false]
destinationId Number The destination to travel to, can be solar system, station or structure's id
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

null (empty response body)

Authorization

evesso

HTTP request headers

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

postUiOpenwindowContract

postUiOpenwindowContract(contractId, opts)

Open Contract Window

Open the contract window inside the client --- Alternate route: /dev/ui/openwindow/contract/ Alternate route: /legacy/ui/openwindow/contract/ Alternate route: /v1/ui/openwindow/contract/

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

var contractId = 56; // Number | The contract to open

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.');
  }
};
apiInstance.postUiOpenwindowContract(contractId, opts, callback);

Parameters

Name Type Description Notes
contractId Number The contract to open
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

null (empty response body)

Authorization

evesso

HTTP request headers

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

postUiOpenwindowInformation

postUiOpenwindowInformation(targetId, opts)

Open Information Window

Open the information window for a character, corporation or alliance inside the client --- Alternate route: /dev/ui/openwindow/information/ Alternate route: /legacy/ui/openwindow/information/ Alternate route: /v1/ui/openwindow/information/

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

var targetId = 56; // Number | The target to open

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.');
  }
};
apiInstance.postUiOpenwindowInformation(targetId, opts, callback);

Parameters

Name Type Description Notes
targetId Number The target to open
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

null (empty response body)

Authorization

evesso

HTTP request headers

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

postUiOpenwindowMarketdetails

postUiOpenwindowMarketdetails(typeId, opts)

Open Market Details

Open the market details window for a specific typeID inside the client --- Alternate route: /dev/ui/openwindow/marketdetails/ Alternate route: /legacy/ui/openwindow/marketdetails/ Alternate route: /v1/ui/openwindow/marketdetails/

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

var typeId = 56; // Number | The item type to open in market window

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.');
  }
};
apiInstance.postUiOpenwindowMarketdetails(typeId, opts, callback);

Parameters

Name Type Description Notes
typeId Number The item type to open in market window
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

null (empty response body)

Authorization

evesso

HTTP request headers

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

postUiOpenwindowNewmail

postUiOpenwindowNewmail(newMail, opts)

Open New Mail Window

Open the New Mail window, according to settings from the request if applicable --- Alternate route: /dev/ui/openwindow/newmail/ Alternate route: /legacy/ui/openwindow/newmail/ Alternate route: /v1/ui/openwindow/newmail/

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

var newMail = new EveSwaggerInterface.PostUiOpenwindowNewmailNewMail(); // PostUiOpenwindowNewmailNewMail | The details of mail to create

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.');
  }
};
apiInstance.postUiOpenwindowNewmail(newMail, opts, callback);

Parameters

Name Type Description Notes
newMail PostUiOpenwindowNewmailNewMail The details of mail to create
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

null (empty response body)

Authorization

evesso

HTTP request headers

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