Skip to content

Latest commit

 

History

History
726 lines (519 loc) · 33.4 KB

CharacterApi.md

File metadata and controls

726 lines (519 loc) · 33.4 KB

Swagger\Client\CharacterApi

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

Method HTTP request Description
getCharactersCharacterId GET /characters/{character_id}/ Get character's public information
getCharactersCharacterIdAgentsResearch GET /characters/{character_id}/agents_research/ Get agents research
getCharactersCharacterIdBlueprints GET /characters/{character_id}/blueprints/ Get blueprints
getCharactersCharacterIdChatChannels GET /characters/{character_id}/chat_channels/ Get chat channels
getCharactersCharacterIdCorporationhistory GET /characters/{character_id}/corporationhistory/ Get corporation history
getCharactersCharacterIdFatigue GET /characters/{character_id}/fatigue/ Get jump fatigue
getCharactersCharacterIdMedals GET /characters/{character_id}/medals/ Get medals
getCharactersCharacterIdPortrait GET /characters/{character_id}/portrait/ Get character portraits
getCharactersCharacterIdRoles GET /characters/{character_id}/roles/ Get character corporation roles
getCharactersCharacterIdStandings GET /characters/{character_id}/standings/ Get standings
getCharactersNames GET /characters/names/ Get character names
postCharactersAffiliation POST /characters/affiliation/ Character affiliation
postCharactersCharacterIdCspa POST /characters/{character_id}/cspa/ Calculate a CSPA charge cost

getCharactersCharacterId

\Swagger\Client\Model\GetCharactersCharacterIdOk getCharactersCharacterId($character_id, $datasource, $user_agent, $x_user_agent)

Get character's public information

Public information about a character --- Alternate route: /v4/characters/{character_id}/ Alternate route: /dev/characters/{character_id}/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterId($character_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterId: ', $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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdOk

Authorization

No authorization required

HTTP request headers

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

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

getCharactersCharacterIdAgentsResearch

\Swagger\Client\Model\GetCharactersCharacterIdAgentsResearch200Ok[] getCharactersCharacterIdAgentsResearch($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get agents research

Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) --- Alternate route: /v1/characters/{character_id}/agents_research/ Alternate route: /legacy/characters/{character_id}/agents_research/ Alternate route: /dev/characters/{character_id}/agents_research/ --- This route is cached for up to 3600 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdAgentsResearch($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdAgentsResearch: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdAgentsResearch200Ok[]

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]

getCharactersCharacterIdBlueprints

\Swagger\Client\Model\GetCharactersCharacterIdBlueprints200Ok[] getCharactersCharacterIdBlueprints($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get blueprints

Return a list of blueprints the character has --- Alternate route: /v1/characters/{character_id}/blueprints/ Alternate route: /legacy/characters/{character_id}/blueprints/ Alternate route: /dev/characters/{character_id}/blueprints/ --- This route is cached for up to 3600 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdBlueprints($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdBlueprints: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdBlueprints200Ok[]

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]

getCharactersCharacterIdChatChannels

\Swagger\Client\Model\GetCharactersCharacterIdChatChannels200Ok[] getCharactersCharacterIdChatChannels($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get chat channels

Return chat channels that a character is the owner or an operator of --- Alternate route: /v1/characters/{character_id}/chat_channels/ Alternate route: /legacy/characters/{character_id}/chat_channels/ Alternate route: /dev/characters/{character_id}/chat_channels/ --- This route is cached for up to 300 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdChatChannels($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdChatChannels: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdChatChannels200Ok[]

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]

getCharactersCharacterIdCorporationhistory

\Swagger\Client\Model\GetCharactersCharacterIdCorporationhistory200Ok[] getCharactersCharacterIdCorporationhistory($character_id, $datasource, $user_agent, $x_user_agent)

Get corporation history

Get a list of all the corporations a character has been a member of --- Alternate route: /v1/characters/{character_id}/corporationhistory/ Alternate route: /legacy/characters/{character_id}/corporationhistory/ Alternate route: /dev/characters/{character_id}/corporationhistory/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdCorporationhistory($character_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdCorporationhistory: ', $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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdCorporationhistory200Ok[]

Authorization

No authorization required

HTTP request headers

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

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

getCharactersCharacterIdFatigue

\Swagger\Client\Model\GetCharactersCharacterIdFatigueOk getCharactersCharacterIdFatigue($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get jump fatigue

Return a character's jump activation and fatigue information --- Alternate route: /v1/characters/{character_id}/fatigue/ Alternate route: /legacy/characters/{character_id}/fatigue/ Alternate route: /dev/characters/{character_id}/fatigue/ --- This route is cached for up to 300 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdFatigue($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdFatigue: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdFatigueOk

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]

getCharactersCharacterIdMedals

\Swagger\Client\Model\GetCharactersCharacterIdMedals200Ok[] getCharactersCharacterIdMedals($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get medals

Return a list of medals the character has --- Alternate route: /v1/characters/{character_id}/medals/ Alternate route: /legacy/characters/{character_id}/medals/ Alternate route: /dev/characters/{character_id}/medals/ --- This route is cached for up to 3600 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdMedals($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdMedals: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdMedals200Ok[]

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]

getCharactersCharacterIdPortrait

\Swagger\Client\Model\GetCharactersCharacterIdPortraitOk getCharactersCharacterIdPortrait($character_id, $datasource, $user_agent, $x_user_agent)

Get character portraits

Get portrait urls for a character --- Alternate route: /v2/characters/{character_id}/portrait/ Alternate route: /dev/characters/{character_id}/portrait/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdPortrait($character_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdPortrait: ', $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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdPortraitOk

Authorization

No authorization required

HTTP request headers

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

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

getCharactersCharacterIdRoles

string[] getCharactersCharacterIdRoles($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get character corporation roles

Returns a character's corporation roles --- Alternate route: /v1/characters/{character_id}/roles/ Alternate route: /legacy/characters/{character_id}/roles/ Alternate route: /dev/characters/{character_id}/roles/ --- This route is cached for up to 3600 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdRoles($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdRoles: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

string[]

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]

getCharactersCharacterIdStandings

\Swagger\Client\Model\GetCharactersCharacterIdStandings200Ok[] getCharactersCharacterIdStandings($character_id, $datasource, $token, $user_agent, $x_user_agent)

Get standings

Return character standings from agents, NPC corporations, and factions --- Alternate route: /v1/characters/{character_id}/standings/ Alternate route: /legacy/characters/{character_id}/standings/ Alternate route: /dev/characters/{character_id}/standings/ --- This route is cached for up to 3600 seconds

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdStandings($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersCharacterIdStandings: ', $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]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdStandings200Ok[]

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]

getCharactersNames

\Swagger\Client\Model\GetCharactersNames200Ok[] getCharactersNames($character_ids, $datasource, $user_agent, $x_user_agent)

Get character names

Resolve a set of character IDs to character names --- Alternate route: /v1/characters/names/ Alternate route: /legacy/characters/names/ Alternate route: /dev/characters/names/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_ids = array(56); // int[] | A comma separated list of character IDs
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersNames($character_ids, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->getCharactersNames: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_ids int[] A comma separated list of character IDs
datasource string The server name you would like data from [optional] [default to tranquility]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersNames200Ok[]

Authorization

No authorization required

HTTP request headers

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

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

postCharactersAffiliation

\Swagger\Client\Model\PostCharactersAffiliation200Ok[] postCharactersAffiliation($characters, $datasource, $user_agent, $x_user_agent)

Character affiliation

Bulk lookup of character IDs to corporation, alliance and faction --- Alternate route: /v1/characters/affiliation/ Alternate route: /legacy/characters/affiliation/ Alternate route: /dev/characters/affiliation/ --- This route is cached for up to 3600 seconds

Example

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$characters = array(new \Swagger\Client\Model\int[]()); // int[] | The character IDs to fetch affiliations for
$datasource = "tranquility"; // string | The server name you would like data from
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->postCharactersAffiliation($characters, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->postCharactersAffiliation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
characters int[] The character IDs to fetch affiliations for
datasource string The server name you would like data from [optional] [default to tranquility]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\PostCharactersAffiliation200Ok[]

Authorization

No authorization required

HTTP request headers

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

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

postCharactersCharacterIdCspa

\Swagger\Client\Model\PostCharactersCharacterIdCspaCreated postCharactersCharacterIdCspa($character_id, $characters, $datasource, $token, $user_agent, $x_user_agent)

Calculate a CSPA charge cost

Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost --- Alternate route: /v3/characters/{character_id}/cspa/ Alternate route: /legacy/characters/{character_id}/cspa/ Alternate route: /dev/characters/{character_id}/cspa/

Example

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

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

$api_instance = new Swagger\Client\Api\CharacterApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$characters = new \Swagger\Client\Model\PostCharactersCharacterIdCspaCharacters(); // \Swagger\Client\Model\PostCharactersCharacterIdCspaCharacters | The target characters to calculate the charge for
$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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->postCharactersCharacterIdCspa($character_id, $characters, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CharacterApi->postCharactersCharacterIdCspa: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_id int An EVE character ID
characters \Swagger\Client\Model\PostCharactersCharacterIdCspaCharacters The target characters to calculate the charge for
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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\PostCharactersCharacterIdCspaCreated

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]