Skip to content

Latest commit

 

History

History
282 lines (199 loc) · 11.4 KB

CalendarApi.md

File metadata and controls

282 lines (199 loc) · 11.4 KB
Raw

Swagger\Client\Eve\CalendarApi

All URIs are relative to https://esi.evetech.net, except if the operation defines another base path.

Method HTTP request Description
getCharactersCharacterIdCalendar() GET /v1/characters/{character_id}/calendar/ List calendar event summaries
getCharactersCharacterIdCalendarEventId() GET /v3/characters/{character_id}/calendar/{event_id}/ Get an event
getCharactersCharacterIdCalendarEventIdAttendees() GET /v1/characters/{character_id}/calendar/{event_id}/attendees/ Get attendees
putCharactersCharacterIdCalendarEventId() PUT /v3/characters/{character_id}/calendar/{event_id}/ Respond to an event

getCharactersCharacterIdCalendar()

getCharactersCharacterIdCalendar($character_id, $datasource, $from_event, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendar200Ok[]

List calendar event summaries

Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event --- This route is cached for up to 5 seconds

Example

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


// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Eve\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Eve\Api\CalendarApi(
    // 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 | An EVE character ID
$datasource = 'tranquility'; // string | The server name you would like data from
$from_event = 56; // int | The event ID to retrieve events from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdCalendar($character_id, $datasource, $from_event, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CalendarApi->getCharactersCharacterIdCalendar: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
datasource string The server name you would like data from [optional] [default to 'tranquility']
from_event int The event ID to retrieve events from [optional]
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendar200Ok[]

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]

getCharactersCharacterIdCalendarEventId()

getCharactersCharacterIdCalendarEventId($character_id, $event_id, $datasource, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendarEventIdOk

Get an event

Get all the information for a specific event --- This route is cached for up to 5 seconds

Example

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


// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Eve\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Eve\Api\CalendarApi(
    // 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 | An EVE character ID
$event_id = 56; // int | The id of the event requested
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdCalendarEventId($character_id, $event_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CalendarApi->getCharactersCharacterIdCalendarEventId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
event_id int The id of the event requested
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendarEventIdOk

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]

getCharactersCharacterIdCalendarEventIdAttendees()

getCharactersCharacterIdCalendarEventIdAttendees($character_id, $event_id, $datasource, $if_none_match, $token): \Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendarEventIdAttendees200Ok[]

Get attendees

Get all invited attendees for a given event --- This route is cached for up to 600 seconds

Example

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


// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Eve\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Eve\Api\CalendarApi(
    // 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 | An EVE character ID
$event_id = 56; // int | The id of the event requested
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag
$token = 'token_example'; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdCalendarEventIdAttendees($character_id, $event_id, $datasource, $if_none_match, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CalendarApi->getCharactersCharacterIdCalendarEventIdAttendees: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
event_id int The id of the event requested
datasource string The server name you would like data from [optional] [default to 'tranquility']
if_none_match string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Eve\Model\GetCharactersCharacterIdCalendarEventIdAttendees200Ok[]

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]

putCharactersCharacterIdCalendarEventId()

putCharactersCharacterIdCalendarEventId($character_id, $event_id, $response, $datasource, $token)

Respond to an event

Set your response status to an event --- This route is cached for up to 5 seconds

Example

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


// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Eve\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Eve\Api\CalendarApi(
    // 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 | An EVE character ID
$event_id = 56; // int | The ID of the event requested
$response = new \Swagger\Client\Eve\Model\PutCharactersCharacterIdCalendarEventIdResponse(); // \Swagger\Client\Eve\Model\PutCharactersCharacterIdCalendarEventIdResponse | The response value to set, overriding current value
$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

try {
    $apiInstance->putCharactersCharacterIdCalendarEventId($character_id, $event_id, $response, $datasource, $token);
} catch (Exception $e) {
    echo 'Exception when calling CalendarApi->putCharactersCharacterIdCalendarEventId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
character_id int An EVE character ID
event_id int The ID of the event requested
response \Swagger\Client\Eve\Model\PutCharactersCharacterIdCalendarEventIdResponse The response value to set, overriding current value
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]

Return type

void (empty response body)

Authorization

evesso

HTTP request headers

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

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