Skip to content

Latest commit

 

History

History
684 lines (461 loc) · 19.3 KB

ApplicationGroupsApi.md

File metadata and controls

684 lines (461 loc) · 19.3 KB

Brave\NeucoreApi\ApplicationGroupsApi

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

Method HTTP request Description
allianceGroupsBulkV1() POST /app/v1/alliance-groups Return groups of multiple alliances.
allianceGroupsV1() GET /app/v1/alliance-groups/{aid} Return groups of the alliance.
allianceGroupsV2() GET /app/v2/alliance-groups/{aid} Return groups of the alliance.
corpGroupsBulkV1() POST /app/v1/corp-groups Return groups of multiple corporations.
corpGroupsV1() GET /app/v1/corp-groups/{cid} Return groups of the corporation.
corpGroupsV2() GET /app/v2/corp-groups/{cid} Return groups of the corporation.
groupMembersV1() GET /app/v1/group-members/{groupId} Returns the main character IDs from all group members.
groupsBulkV1() POST /app/v1/groups Return groups of multiple players, identified by one of their character IDs.
groupsV1() GET /app/v1/groups/{cid} Return groups of the character's player account.
groupsV2() GET /app/v2/groups/{cid} Return groups of the character's player account.
groupsWithFallbackV1() GET /app/v1/groups-with-fallback Returns groups from the character's account, if available, or the corporation and alliance.

allianceGroupsBulkV1()

allianceGroupsBulkV1($request_body): \Brave\NeucoreApi\Model\Alliance[]

Return groups of multiple alliances.

Needs role: app-groups.
Returns only groups that have been added to the app as well. Skips alliances that are not found in the local database.

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\ApplicationGroupsApi(
    // 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 alliance IDs array.

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

Parameters

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

Return type

\Brave\NeucoreApi\Model\Alliance[]

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]

allianceGroupsV1()

allianceGroupsV1($aid): \Brave\NeucoreApi\Model\Group[]

Return groups of the alliance.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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
);
$aid = 56; // int | EVE alliance ID.

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

Parameters

Name Type Description Notes
aid int EVE alliance ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

allianceGroupsV2()

allianceGroupsV2($aid): \Brave\NeucoreApi\Model\Group[]

Return groups of the alliance.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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
);
$aid = 56; // int | EVE alliance ID.

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

Parameters

Name Type Description Notes
aid int EVE alliance ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

corpGroupsBulkV1()

corpGroupsBulkV1($request_body): \Brave\NeucoreApi\Model\Corporation[]

Return groups of multiple corporations.

Needs role: app-groups.
Returns only groups that have been added to the app as well. Skips corporations that are not found in the local database.

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\ApplicationGroupsApi(
    // 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 corporation IDs array.

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

Parameters

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

Return type

\Brave\NeucoreApi\Model\Corporation[]

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]

corpGroupsV1()

corpGroupsV1($cid): \Brave\NeucoreApi\Model\Group[]

Return groups of the corporation.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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 corporation ID.

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

Parameters

Name Type Description Notes
cid int EVE corporation ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

corpGroupsV2()

corpGroupsV2($cid): \Brave\NeucoreApi\Model\Group[]

Return groups of the corporation.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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 corporation ID.

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

Parameters

Name Type Description Notes
cid int EVE corporation ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

groupMembersV1()

groupMembersV1($group_id, $corporation): int[]

Returns the main character IDs from all group members.

Needs role: app-groups.

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\ApplicationGroupsApi(
    // 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
);
$group_id = 56; // int | Group ID.
$corporation = 56; // int | Limit to characters that are a member of this corporation.

try {
    $result = $apiInstance->groupMembersV1($group_id, $corporation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationGroupsApi->groupMembersV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
group_id int Group ID.
corporation int Limit to characters that are a member of this corporation. [optional]

Return type

int[]

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]

groupsBulkV1()

groupsBulkV1($request_body): \Brave\NeucoreApi\Model\CharacterGroups[]

Return groups of multiple players, identified by one of their character IDs.

Needs role: app-groups.
Returns only groups that have been added to the app as well. Skips characters that are not found in the local database.

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\ApplicationGroupsApi(
    // 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->groupsBulkV1($request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationGroupsApi->groupsBulkV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\Brave\NeucoreApi\Model\CharacterGroups[]

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]

groupsV1()

groupsV1($cid): \Brave\NeucoreApi\Model\Group[]

Return groups of the character's player account.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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->groupsV1($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationGroupsApi->groupsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
cid int EVE character ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

groupsV2()

groupsV2($cid): \Brave\NeucoreApi\Model\Group[]

Return groups of the character's player account.

Needs role: app-groups.
Returns only groups that have been added to the app as well.

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\ApplicationGroupsApi(
    // 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->groupsV2($cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationGroupsApi->groupsV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
cid int EVE character ID.

Return type

\Brave\NeucoreApi\Model\Group[]

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]

groupsWithFallbackV1()

groupsWithFallbackV1($character, $corporation, $alliance): \Brave\NeucoreApi\Model\Group[]

Returns groups from the character's account, if available, or the corporation and alliance.

Needs role: app-groups.
Returns only groups that have been added to the app as well.
It is not checked if character, corporation and alliance match.

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\ApplicationGroupsApi(
    // 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 = 56; // int | EVE character ID.
$corporation = 56; // int | EVE corporation ID.
$alliance = 56; // int | EVE alliance ID.

try {
    $result = $apiInstance->groupsWithFallbackV1($character, $corporation, $alliance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationGroupsApi->groupsWithFallbackV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character int EVE character ID.
corporation int EVE corporation ID.
alliance int EVE alliance ID. [optional]

Return type

\Brave\NeucoreApi\Model\Group[]

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]