Skip to content

DogmaApi.md

Latest commit

 

History

History
212 lines (148 loc) · 8.15 KB

DogmaApi.md

File metadata and controls

212 lines (148 loc) · 8.15 KB
Raw

Swagger\Client\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, $user_agent, $x_user_agent)

Get attributes

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

Example

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

$api_instance = new Swagger\Client\Api\DogmaApi(new \Http\Adapter\Guzzle6\Client());
$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->getDogmaAttributes($datasource, $user_agent, $x_user_agent);
    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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent 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

\Swagger\Client\Model\GetDogmaAttributesAttributeIdOk getDogmaAttributesAttributeId($attribute_id, $datasource, $user_agent, $x_user_agent)

Get attribute information

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

Example

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

$api_instance = new Swagger\Client\Api\DogmaApi(new \Http\Adapter\Guzzle6\Client());
$attribute_id = 56; // int | A dogma attribute 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->getDogmaAttributesAttributeId($attribute_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaAttributesAttributeId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
attribute_id int A dogma attribute 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\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, $user_agent, $x_user_agent)

Get effects

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

Example

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

$api_instance = new Swagger\Client\Api\DogmaApi(new \Http\Adapter\Guzzle6\Client());
$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->getDogmaEffects($datasource, $user_agent, $x_user_agent);
    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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent 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

\Swagger\Client\Model\GetDogmaEffectsEffectIdOk getDogmaEffectsEffectId($effect_id, $datasource, $user_agent, $x_user_agent)

Get effect information

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

Example

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

$api_instance = new Swagger\Client\Api\DogmaApi(new \Http\Adapter\Guzzle6\Client());
$effect_id = 56; // int | A dogma effect 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->getDogmaEffectsEffectId($effect_id, $datasource, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DogmaApi->getDogmaEffectsEffectId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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