Skip to content

Latest commit

 

History

History
283 lines (200 loc) · 11.3 KB

BookmarksApi.md

File metadata and controls

283 lines (200 loc) · 11.3 KB
Raw

Swagger\Client\Eve\BookmarksApi

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

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

getCharactersCharacterIdBookmarks()

getCharactersCharacterIdBookmarks($character_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdBookmarks200Ok[]

List bookmarks

A list of your character's personal bookmarks --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\BookmarksApi(
    // 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
);
$character_id = 56; // int | An EVE character ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdBookmarks($character_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookmarksApi->getCharactersCharacterIdBookmarks: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page int 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

\Swagger\Client\Eve\Model\GetCharactersCharacterIdBookmarks200Ok[]

Authorization

evesso

HTTP request headers

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

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

getCharactersCharacterIdBookmarksFolders()

getCharactersCharacterIdBookmarksFolders($character_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdBookmarksFolders200Ok[]

List bookmark folders

A list of your character's personal bookmark folders --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\BookmarksApi(
    // 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
);
$character_id = 56; // int | An EVE character ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdBookmarksFolders($character_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookmarksApi->getCharactersCharacterIdBookmarksFolders: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page int 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

\Swagger\Client\Eve\Model\GetCharactersCharacterIdBookmarksFolders200Ok[]

Authorization

evesso

HTTP request headers

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

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

getCorporationsCorporationIdBookmarks()

getCorporationsCorporationIdBookmarks($corporation_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCorporationsCorporationIdBookmarks200Ok[]

List corporation bookmarks

A list of your corporation's bookmarks --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\BookmarksApi(
    // 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
);
$corporation_id = 56; // int | An EVE corporation ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCorporationsCorporationIdBookmarks($corporation_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookmarksApi->getCorporationsCorporationIdBookmarks: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
corporation_id int An EVE corporation ID
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page int 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

\Swagger\Client\Eve\Model\GetCorporationsCorporationIdBookmarks200Ok[]

Authorization

evesso

HTTP request headers

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

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

getCorporationsCorporationIdBookmarksFolders()

getCorporationsCorporationIdBookmarksFolders($corporation_id, $datasource, $if_none_match, $page, $token): \Swagger\Client\Eve\Model\GetCorporationsCorporationIdBookmarksFolders200Ok[]

List corporation bookmark folders

A list of your corporation's bookmark folders --- This route is cached for up to 3600 seconds

Example

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


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


$apiInstance = new Swagger\Client\Eve\Api\BookmarksApi(
    // 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
);
$corporation_id = 56; // int | An EVE corporation ID
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$page = 1; // int | Which page of results to return
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCorporationsCorporationIdBookmarksFolders($corporation_id, $datasource, $if_none_match, $page, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookmarksApi->getCorporationsCorporationIdBookmarksFolders: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
corporation_id int An EVE corporation ID
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
page int 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

\Swagger\Client\Eve\Model\GetCorporationsCorporationIdBookmarksFolders200Ok[]

Authorization

evesso

HTTP request headers

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

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