Skip to content

CalendarApi.md

Latest commit

 

History

History
260 lines (184 loc) · 10.9 KB

CalendarApi.md

File metadata and controls

260 lines (184 loc) · 10.9 KB

EveSwaggerInterface.CalendarApi

All URIs are relative to https://esi.evetech.net/latest

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

getCharactersCharacterIdCalendar

[GetCharactersCharacterIdCalendar200Ok] getCharactersCharacterIdCalendar(characterId, opts)

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 --- Alternate route: /dev/characters/{character_id}/calendar/ Alternate route: /legacy/characters/{character_id}/calendar/ Alternate route: /v1/characters/{character_id}/calendar/ Alternate route: /v2/characters/{character_id}/calendar/ --- This route is cached for up to 5 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.CalendarApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'fromEvent': 56, // Number | The event ID to retrieve events from
  'ifNoneMatch': "ifNoneMatch_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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdCalendar(characterId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
datasource String The server name you would like data from [optional] [default to tranquility]
fromEvent Number The event ID to retrieve events from [optional]
ifNoneMatch 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

[GetCharactersCharacterIdCalendar200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdCalendarEventId

GetCharactersCharacterIdCalendarEventIdOk getCharactersCharacterIdCalendarEventId(characterIdeventId, opts)

Get an event

Get all the information for a specific event --- Alternate route: /dev/characters/{character_id}/calendar/{event_id}/ Alternate route: /legacy/characters/{character_id}/calendar/{event_id}/ Alternate route: /v3/characters/{character_id}/calendar/{event_id}/ Alternate route: /v4/characters/{character_id}/calendar/{event_id}/ --- This route is cached for up to 5 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.CalendarApi();

var characterId = 56; // Number | An EVE character ID

var eventId = 56; // Number | The id of the event requested

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdCalendarEventId(characterIdeventId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
eventId Number The id of the event requested
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch 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

GetCharactersCharacterIdCalendarEventIdOk

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdCalendarEventIdAttendees

[GetCharactersCharacterIdCalendarEventIdAttendees200Ok] getCharactersCharacterIdCalendarEventIdAttendees(characterIdeventId, opts)

Get attendees

Get all invited attendees for a given event --- Alternate route: /dev/characters/{character_id}/calendar/{event_id}/attendees/ Alternate route: /legacy/characters/{character_id}/calendar/{event_id}/attendees/ Alternate route: /v1/characters/{character_id}/calendar/{event_id}/attendees/ Alternate route: /v2/characters/{character_id}/calendar/{event_id}/attendees/ --- This route is cached for up to 600 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.CalendarApi();

var characterId = 56; // Number | An EVE character ID

var eventId = 56; // Number | The id of the event requested

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdCalendarEventIdAttendees(characterIdeventId, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
eventId Number The id of the event requested
datasource String The server name you would like data from [optional] [default to tranquility]
ifNoneMatch 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

[GetCharactersCharacterIdCalendarEventIdAttendees200Ok]

Authorization

evesso

HTTP request headers

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

putCharactersCharacterIdCalendarEventId

putCharactersCharacterIdCalendarEventId(characterIdeventId, response, opts)

Respond to an event

Set your response status to an event --- Alternate route: /dev/characters/{character_id}/calendar/{event_id}/ Alternate route: /legacy/characters/{character_id}/calendar/{event_id}/ Alternate route: /v3/characters/{character_id}/calendar/{event_id}/ Alternate route: /v4/characters/{character_id}/calendar/{event_id}/ --- This route is cached for up to 5 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.CalendarApi();

var characterId = 56; // Number | An EVE character ID

var eventId = 56; // Number | The ID of the event requested

var response = new EveSwaggerInterface.PutCharactersCharacterIdCalendarEventIdResponse(); // PutCharactersCharacterIdCalendarEventIdResponse | The response value to set, overriding current value

var opts = { 
  '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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.putCharactersCharacterIdCalendarEventId(characterIdeventId, response, opts, callback);

Parameters

Name Type Description Notes
characterId Number An EVE character ID
eventId Number The ID of the event requested
response 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

null (empty response body)

Authorization

evesso

HTTP request headers

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