Brave\NeucoreApi\ApplicationCharactersApi

All URIs are relative to https://localhost/api, except if the operation defines another base path.

Method	HTTP request	Description
characterListV1()	POST /app/v1/character-list	Returns all known characters from the parameter list.
charactersBulkV1()	POST /app/v1/characters	Returns all characters from multiple player accounts identified by character IDs.
charactersV1()	GET /app/v1/characters/{characterId}	Returns all characters of the player account to which the character ID belongs.
corporationCharactersV1()	GET /app/v1/corp-characters/{corporationId}	Returns a list of all known characters from the corporation.
corporationPlayersV1()	GET /app/v1/corp-players/{corporationId}	Returns a list of all players that have a character in the corporation.
incomingCharactersV1()	GET /app/v1/incoming-characters/{characterId}	Returns all characters that were moved from another account to the player account to which the ID belongs.
mainV1()	GET /app/v1/main/{cid}	Returns the main character of the player account to which the character ID belongs.
mainV2()	GET /app/v2/main/{cid}	Returns the main character of the player account to which the character ID belongs.
playerCharactersV1()	GET /app/v1/player-chars/{playerId}	Returns all characters from the player account.
playerV1()	GET /app/v1/player/{characterId}	Returns the player account to which the character ID belongs.
playerWithCharactersV1()	GET /app/v1/player-with-characters/{characterId}	Returns the player account to which the character ID belongs with all characters.
playersV1()	POST /app/v1/players	Returns player accounts identified by character IDs. Can contain the same player several times.
removedCharactersV1()	GET /app/v1/removed-characters/{characterId}	Returns all characters that were removed from the player account to which the character ID belongs.

`characterListV1()`

characterListV1($request_body): \Brave\NeucoreApi\Model\Character[]

Returns all known characters from the parameter list.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$request_body = array(56); // int[] | Array with EVE character IDs.

try {
    $result = $apiInstance->characterListV1($request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->characterListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	int[]	Array with EVE character IDs.

Return type

\Brave\NeucoreApi\Model\Character[]

Authorization

BearerAuth

HTTP request headers

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

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

`charactersBulkV1()`

charactersBulkV1($request_body): int[][]

Returns all characters from multiple player accounts identified by character IDs.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$request_body = array(56); // int[] | EVE character IDs array.

try {
    $result = $apiInstance->charactersBulkV1($request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->charactersBulkV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	int[]	EVE character IDs array.

Return type

int[][]

Authorization

BearerAuth

HTTP request headers

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

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

`charactersV1()`

charactersV1($character_id): \Brave\NeucoreApi\Model\Character[]

Returns all characters of the player account to which the character ID belongs.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE character ID.

try {
    $result = $apiInstance->charactersV1($character_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->charactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\Character[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`corporationCharactersV1()`

corporationCharactersV1($corporation_id): \Brave\NeucoreApi\Model\Character[]

Returns a list of all known characters from the corporation.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE corporation ID.

try {
    $result = $apiInstance->corporationCharactersV1($corporation_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->corporationCharactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
corporation_id	int	EVE corporation ID.

Return type

\Brave\NeucoreApi\Model\Character[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`corporationPlayersV1()`

corporationPlayersV1($corporation_id): \Brave\NeucoreApi\Model\Player[]

Returns a list of all players that have a character in the corporation.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE corporation ID.

try {
    $result = $apiInstance->corporationPlayersV1($corporation_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->corporationPlayersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
corporation_id	int	EVE corporation ID.

Return type

\Brave\NeucoreApi\Model\Player[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`incomingCharactersV1()`

incomingCharactersV1($character_id): \Brave\NeucoreApi\Model\RemovedCharacter[]

Returns all characters that were moved from another account to the player account to which the ID belongs.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE character ID.

try {
    $result = $apiInstance->incomingCharactersV1($character_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->incomingCharactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\RemovedCharacter[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`mainV1()`

mainV1($cid): \Brave\NeucoreApi\Model\Character

Returns the main character of the player account to which the character ID belongs.

Needs role: app-chars.
It is possible that an account has no main character.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$cid = 56; // int | EVE character ID.

try {
    $result = $apiInstance->mainV1($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->mainV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cid	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\Character

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`mainV2()`

mainV2($cid): \Brave\NeucoreApi\Model\Character

Returns the main character of the player account to which the character ID belongs.

Needs role: app-chars.
It is possible that an account has no main character.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$cid = 56; // int | EVE character ID.

try {
    $result = $apiInstance->mainV2($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->mainV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cid	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\Character

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`playerCharactersV1()`

playerCharactersV1($player_id): \Brave\NeucoreApi\Model\Character[]

Returns all characters from the player account.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$player_id = 56; // int | Player ID.

try {
    $result = $apiInstance->playerCharactersV1($player_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->playerCharactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
player_id	int	Player ID.

Return type

\Brave\NeucoreApi\Model\Character[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`playerV1()`

playerV1($character_id): \Brave\NeucoreApi\Model\Player

Returns the player account to which the character ID belongs.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE character ID.

try {
    $result = $apiInstance->playerV1($character_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->playerV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\Player

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`playerWithCharactersV1()`

playerWithCharactersV1($character_id): \Brave\NeucoreApi\Model\Player

Returns the player account to which the character ID belongs with all characters.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE character ID.

try {
    $result = $apiInstance->playerWithCharactersV1($character_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->playerWithCharactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\Player

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`playersV1()`

playersV1($request_body): \Brave\NeucoreApi\Model\PlayerWithCharcterId[]

Returns player accounts identified by character IDs. Can contain the same player several times.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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
);
$request_body = array(56); // int[] | EVE character IDs array.

try {
    $result = $apiInstance->playersV1($request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->playersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	int[]	EVE character IDs array.

Return type

\Brave\NeucoreApi\Model\PlayerWithCharcterId[]

Authorization

BearerAuth

HTTP request headers

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

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

`removedCharactersV1()`

removedCharactersV1($character_id): \Brave\NeucoreApi\Model\RemovedCharacter[]

Returns all characters that were removed from the player account to which the character ID belongs.

Needs role: app-chars.

Example

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


// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationCharactersApi(
    // 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 | EVE character ID.

try {
    $result = $apiInstance->removedCharactersV1($character_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationCharactersApi->removedCharactersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
character_id	int	EVE character ID.

Return type

\Brave\NeucoreApi\Model\RemovedCharacter[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

ApplicationCharactersApi.md

Latest commit

History

ApplicationCharactersApi.md

File metadata and controls

Brave\NeucoreApi\ApplicationCharactersApi

characterListV1()

Example

Parameters

Return type

Authorization

HTTP request headers

charactersBulkV1()

Example

Parameters

Return type

Authorization

HTTP request headers

charactersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

corporationCharactersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

corporationPlayersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

incomingCharactersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

mainV1()

Example

Parameters

Return type

Authorization

HTTP request headers

mainV2()

Example

Parameters

Return type

Authorization

HTTP request headers

playerCharactersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

playerV1()

Example

Parameters

Return type

Authorization

HTTP request headers

playerWithCharactersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

playersV1()

Example

Parameters

Return type

Authorization

HTTP request headers

removedCharactersV1()

`characterListV1()`

`charactersBulkV1()`

`charactersV1()`

`corporationCharactersV1()`

`corporationPlayersV1()`

`incomingCharactersV1()`

`mainV1()`

`mainV2()`

`playerCharactersV1()`

`playerV1()`

`playerWithCharactersV1()`

`playersV1()`

`removedCharactersV1()`