Skip to content

Latest commit

 

History

History
197 lines (145 loc) · 8.99 KB

FittingsApi.md

File metadata and controls

197 lines (145 loc) · 8.99 KB
Raw

nullx27\ESI\FittingsApi

All URIs are relative to https://esi.tech.ccp.is/latest

Method HTTP request Description
deleteCharactersCharacterIdFittingsFittingId DELETE /characters/{character_id}/fittings/{fitting_id}/ Delete fitting
getCharactersCharacterIdFittings GET /characters/{character_id}/fittings/ Get fittings
postCharactersCharacterIdFittings POST /characters/{character_id}/fittings/ Create fitting

deleteCharactersCharacterIdFittingsFittingId

deleteCharactersCharacterIdFittingsFittingId($characterId, $fittingId, $datasource, $token, $userAgent, $xUserAgent)

Delete fitting

Delete a fitting from a character --- Alternate route: /dev/characters/{character_id}/fittings/{fitting_id}/ Alternate route: /legacy/characters/{character_id}/fittings/{fitting_id}/ Alternate route: /v1/characters/{character_id}/fittings/{fitting_id}/

Example

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

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

$apiInstance = new nullx27\ESI\Api\FittingsApi(
    // 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
);
$characterId = 56; // int | An EVE character ID
$fittingId = 56; // int | ID for a fitting of this character
$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
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $apiInstance->deleteCharactersCharacterIdFittingsFittingId($characterId, $fittingId, $datasource, $token, $userAgent, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling FittingsApi->deleteCharactersCharacterIdFittingsFittingId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
characterId int An EVE character ID
fittingId int ID for a fitting of this character
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]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent string Client identifier, takes precedence over User-Agent [optional]

Return type

void (empty response body)

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]

getCharactersCharacterIdFittings

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdFittings200Ok[] getCharactersCharacterIdFittings($characterId, $datasource, $token, $userAgent, $xUserAgent)

Get fittings

Return fittings of a character --- Alternate route: /dev/characters/{character_id}/fittings/ Alternate route: /legacy/characters/{character_id}/fittings/ Alternate route: /v1/characters/{character_id}/fittings/ --- This route is cached for up to 300 seconds

Example

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

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

$apiInstance = new nullx27\ESI\Api\FittingsApi(
    // 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
);
$characterId = 56; // int | An EVE character ID
$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
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getCharactersCharacterIdFittings($characterId, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FittingsApi->getCharactersCharacterIdFittings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
characterId int An EVE character 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]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent string Client identifier, takes precedence over User-Agent [optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdFittings200Ok[]

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]

postCharactersCharacterIdFittings

\nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdFittingsCreated postCharactersCharacterIdFittings($characterId, $datasource, $fitting, $token, $userAgent, $xUserAgent)

Create fitting

Save a new fitting for a character --- Alternate route: /dev/characters/{character_id}/fittings/ Alternate route: /legacy/characters/{character_id}/fittings/ Alternate route: /v1/characters/{character_id}/fittings/

Example

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

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

$apiInstance = new nullx27\ESI\Api\FittingsApi(
    // 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
);
$characterId = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$fitting = new \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdFittingsFitting(); // \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdFittingsFitting | Details about the new fitting
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->postCharactersCharacterIdFittings($characterId, $datasource, $fitting, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FittingsApi->postCharactersCharacterIdFittings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
characterId int An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
fitting \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdFittingsFitting Details about the new fitting [optional]
token string Access token to use if unable to set a header [optional]
userAgent string Client identifier, takes precedence over headers [optional]
xUserAgent string Client identifier, takes precedence over User-Agent [optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdFittingsCreated

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]