Skip to content

Latest commit

 

History

History
126 lines (91 loc) · 5.65 KB

LoyaltyApi.md

File metadata and controls

126 lines (91 loc) · 5.65 KB

nullx27\ESI\LoyaltyApi

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

Method HTTP request Description
getCharactersCharacterIdLoyaltyPoints GET /characters/{character_id}/loyalty/points/ Get loyalty points
getLoyaltyStoresCorporationIdOffers GET /loyalty/stores/{corporation_id}/offers/ List loyalty store offers

getCharactersCharacterIdLoyaltyPoints

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdLoyaltyPoints200Ok[] getCharactersCharacterIdLoyaltyPoints($characterId, $datasource, $token, $userAgent, $xUserAgent)

Get loyalty points

Return a list of loyalty points for all corporations the character has worked for --- Alternate route: /dev/characters/{character_id}/loyalty/points/ Alternate route: /legacy/characters/{character_id}/loyalty/points/ Alternate route: /v1/characters/{character_id}/loyalty/points/ --- 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 = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\LoyaltyApi(
    // 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->getCharactersCharacterIdLoyaltyPoints($characterId, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyApi->getCharactersCharacterIdLoyaltyPoints: ', $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\GetCharactersCharacterIdLoyaltyPoints200Ok[]

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]

getLoyaltyStoresCorporationIdOffers

\nullx27\ESI\nullx27\ESI\Models\GetLoyaltyStoresCorporationIdOffers200Ok[] getLoyaltyStoresCorporationIdOffers($corporationId, $datasource, $userAgent, $xUserAgent)

List loyalty store offers

Return a list of offers from a specific corporation's loyalty store --- Alternate route: /dev/loyalty/stores/{corporation_id}/offers/ Alternate route: /legacy/loyalty/stores/{corporation_id}/offers/ Alternate route: /v1/loyalty/stores/{corporation_id}/offers/ --- This route expires daily at 11:05

Example

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

$apiInstance = new nullx27\ESI\Api\LoyaltyApi(
    // 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()
);
$corporationId = 56; // int | An EVE corporation ID
$datasource = "tranquility"; // string | The server name you would like data from
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

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

Parameters

Name Type Description Notes
corporationId int An EVE corporation ID
datasource string The server name you would like data from [optional] [default to tranquility]
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\GetLoyaltyStoresCorporationIdOffers200Ok[]

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]