Tkhamez\Eve\API\UserInterfaceApi

All URIs are relative to https://esi.evetech.net, except if the operation defines another base path.

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($add_to_beginning, $clear_other_waypoints, $destination_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant)

Set Autopilot Waypoint

Set a solar system as autopilot waypoint

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Tkhamez\Eve\API\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tkhamez\Eve\API\Api\UserInterfaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$add_to_beginning = false; // bool
$clear_other_waypoints = false; // bool
$destination_id = 56; // int
$accept_language = 'en'; // string | The language to use for the response.
$if_none_match = 'if_none_match_example'; // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag.
$x_compatibility_date = '2025-12-16'; // string | The compatibility date for the request.
$x_tenant = ; // string | The tenant ID for the request.

try {
    $apiInstance->postUiAutopilotWaypoint($add_to_beginning, $clear_other_waypoints, $destination_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant);
} catch (Exception $e) {
    echo 'Exception when calling UserInterfaceApi->postUiAutopilotWaypoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
add_to_beginning	bool		[default to false]
clear_other_waypoints	bool		[default to false]
destination_id	int
accept_language	string	The language to use for the response.	[optional] [default to 'en']
if_none_match	string	The ETag of the previous request. A 304 will be returned if this matches the current ETag.	[optional]
x_compatibility_date	string	The compatibility date for the request.	[optional] [default to '2025-12-16']
x_tenant	string	The tenant ID for the request.	[optional] [default to 'tranquility']

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postUiOpenwindowContract()`

postUiOpenwindowContract($contract_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant)

Open Contract Window

Open the contract window inside the client

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Tkhamez\Eve\API\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tkhamez\Eve\API\Api\UserInterfaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$contract_id = 56; // int
$accept_language = 'en'; // string | The language to use for the response.
$if_none_match = 'if_none_match_example'; // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag.
$x_compatibility_date = '2025-12-16'; // string | The compatibility date for the request.
$x_tenant = ; // string | The tenant ID for the request.

try {
    $apiInstance->postUiOpenwindowContract($contract_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant);
} catch (Exception $e) {
    echo 'Exception when calling UserInterfaceApi->postUiOpenwindowContract: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contract_id	int
accept_language	string	The language to use for the response.	[optional] [default to 'en']
if_none_match	string	The ETag of the previous request. A 304 will be returned if this matches the current ETag.	[optional]
x_compatibility_date	string	The compatibility date for the request.	[optional] [default to '2025-12-16']
x_tenant	string	The tenant ID for the request.	[optional] [default to 'tranquility']

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postUiOpenwindowInformation()`

postUiOpenwindowInformation($target_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant)

Open Information Window

Open the information window for a character, corporation or alliance inside the client

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Tkhamez\Eve\API\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tkhamez\Eve\API\Api\UserInterfaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$target_id = 56; // int
$accept_language = 'en'; // string | The language to use for the response.
$if_none_match = 'if_none_match_example'; // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag.
$x_compatibility_date = '2025-12-16'; // string | The compatibility date for the request.
$x_tenant = ; // string | The tenant ID for the request.

try {
    $apiInstance->postUiOpenwindowInformation($target_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant);
} catch (Exception $e) {
    echo 'Exception when calling UserInterfaceApi->postUiOpenwindowInformation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
target_id	int
accept_language	string	The language to use for the response.	[optional] [default to 'en']
if_none_match	string	The ETag of the previous request. A 304 will be returned if this matches the current ETag.	[optional]
x_compatibility_date	string	The compatibility date for the request.	[optional] [default to '2025-12-16']
x_tenant	string	The tenant ID for the request.	[optional] [default to 'tranquility']

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postUiOpenwindowMarketdetails()`

postUiOpenwindowMarketdetails($type_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant)

Open Market Details

Open the market details window for a specific typeID inside the client

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Tkhamez\Eve\API\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tkhamez\Eve\API\Api\UserInterfaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$type_id = 56; // int
$accept_language = 'en'; // string | The language to use for the response.
$if_none_match = 'if_none_match_example'; // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag.
$x_compatibility_date = '2025-12-16'; // string | The compatibility date for the request.
$x_tenant = ; // string | The tenant ID for the request.

try {
    $apiInstance->postUiOpenwindowMarketdetails($type_id, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant);
} catch (Exception $e) {
    echo 'Exception when calling UserInterfaceApi->postUiOpenwindowMarketdetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
type_id	int
accept_language	string	The language to use for the response.	[optional] [default to 'en']
if_none_match	string	The ETag of the previous request. A 304 will be returned if this matches the current ETag.	[optional]
x_compatibility_date	string	The compatibility date for the request.	[optional] [default to '2025-12-16']
x_tenant	string	The tenant ID for the request.	[optional] [default to 'tranquility']

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postUiOpenwindowNewmail()`

postUiOpenwindowNewmail($post_ui_openwindow_newmail_request, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant)

Open New Mail Window

Open the New Mail window, according to settings from the request if applicable

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Tkhamez\Eve\API\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Tkhamez\Eve\API\Api\UserInterfaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$post_ui_openwindow_newmail_request = new \Tkhamez\Eve\API\Model\PostUiOpenwindowNewmailRequest(); // \Tkhamez\Eve\API\Model\PostUiOpenwindowNewmailRequest
$accept_language = 'en'; // string | The language to use for the response.
$if_none_match = 'if_none_match_example'; // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag.
$x_compatibility_date = '2025-12-16'; // string | The compatibility date for the request.
$x_tenant = ; // string | The tenant ID for the request.

try {
    $apiInstance->postUiOpenwindowNewmail($post_ui_openwindow_newmail_request, $accept_language, $if_none_match, $x_compatibility_date, $x_tenant);
} catch (Exception $e) {
    echo 'Exception when calling UserInterfaceApi->postUiOpenwindowNewmail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
post_ui_openwindow_newmail_request	\Tkhamez\Eve\API\Model\PostUiOpenwindowNewmailRequest
accept_language	string	The language to use for the response.	[optional] [default to 'en']
if_none_match	string	The ETag of the previous request. A 304 will be returned if this matches the current ETag.	[optional]
x_compatibility_date	string	The compatibility date for the request.	[optional] [default to '2025-12-16']
x_tenant	string	The tenant ID for the request.	[optional] [default to 'tranquility']

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tkhamez\Eve\API\UserInterfaceApi

`postUiAutopilotWaypoint()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postUiOpenwindowContract()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postUiOpenwindowInformation()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postUiOpenwindowMarketdetails()`

Example

Parameters

Return type

Authorization

HTTP request headers

`postUiOpenwindowNewmail()`

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

UserInterfaceApi.md

Latest commit

History

UserInterfaceApi.md

File metadata and controls

Tkhamez\Eve\API\UserInterfaceApi

postUiAutopilotWaypoint()

Example

Parameters

Return type

Authorization

HTTP request headers

postUiOpenwindowContract()

Example

Parameters

Return type

Authorization

HTTP request headers

postUiOpenwindowInformation()

Example

Parameters

Return type

Authorization

HTTP request headers

postUiOpenwindowMarketdetails()

Example

Parameters

Return type

Authorization

HTTP request headers

postUiOpenwindowNewmail()

Example

Parameters

Return type

Authorization

HTTP request headers

`postUiAutopilotWaypoint()`

`postUiOpenwindowContract()`

`postUiOpenwindowInformation()`

`postUiOpenwindowMarketdetails()`

`postUiOpenwindowNewmail()`