Skip to content

Latest commit

 

History

History
228 lines (164 loc) · 8.77 KB

DogmaApi.md

File metadata and controls

228 lines (164 loc) · 8.77 KB
Raw

nullx27\ESI\DogmaApi

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

Method HTTP request Description
getDogmaAttributes GET /dogma/attributes/ Get attributes
getDogmaAttributesAttributeId GET /dogma/attributes/{attribute_id}/ Get attribute information
getDogmaEffects GET /dogma/effects/ Get effects
getDogmaEffectsEffectId GET /dogma/effects/{effect_id}/ Get effect information

getDogmaAttributes

int[] getDogmaAttributes($datasource, $userAgent, $xUserAgent)

Get attributes

Get a list of dogma attribute ids --- Alternate route: /dev/dogma/attributes/ Alternate route: /legacy/dogma/attributes/ Alternate route: /v1/dogma/attributes/ --- This route expires daily at 11:05

Example

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

$apiInstance = new nullx27\ESI\Api\DogmaApi(
    // 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()
);
$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->getDogmaAttributes($datasource, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaAttributes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
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

int[]

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]

getDogmaAttributesAttributeId

\nullx27\ESI\nullx27\ESI\Models\GetDogmaAttributesAttributeIdOk getDogmaAttributesAttributeId($attributeId, $datasource, $userAgent, $xUserAgent)

Get attribute information

Get information on a dogma attribute --- Alternate route: /dev/dogma/attributes/{attribute_id}/ Alternate route: /legacy/dogma/attributes/{attribute_id}/ Alternate route: /v1/dogma/attributes/{attribute_id}/ --- This route expires daily at 11:05

Example

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

$apiInstance = new nullx27\ESI\Api\DogmaApi(
    // 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()
);
$attributeId = 56; // int | A dogma attribute 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->getDogmaAttributesAttributeId($attributeId, $datasource, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaAttributesAttributeId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
attributeId int A dogma attribute 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\GetDogmaAttributesAttributeIdOk

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]

getDogmaEffects

int[] getDogmaEffects($datasource, $userAgent, $xUserAgent)

Get effects

Get a list of dogma effect ids --- Alternate route: /dev/dogma/effects/ Alternate route: /legacy/dogma/effects/ Alternate route: /v1/dogma/effects/ --- This route expires daily at 11:05

Example

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

$apiInstance = new nullx27\ESI\Api\DogmaApi(
    // 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()
);
$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->getDogmaEffects($datasource, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaEffects: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
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

int[]

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]

getDogmaEffectsEffectId

\nullx27\ESI\nullx27\ESI\Models\GetDogmaEffectsEffectIdOk getDogmaEffectsEffectId($effectId, $datasource, $userAgent, $xUserAgent)

Get effect information

Get information on a dogma effect --- Alternate route: /dev/dogma/effects/{effect_id}/ Alternate route: /v2/dogma/effects/{effect_id}/ --- This route expires daily at 11:05

Example

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

$apiInstance = new nullx27\ESI\Api\DogmaApi(
    // 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()
);
$effectId = 56; // int | A dogma effect 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->getDogmaEffectsEffectId($effectId, $datasource, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaEffectsEffectId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
effectId int A dogma effect 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\GetDogmaEffectsEffectIdOk

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]