ESI::CalendarApi

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

Method	HTTP request	Description
get_characters_character_id_calendar	GET /v1/characters/character_id/calendar/	List calendar event summaries
get_characters_character_id_calendar_event_id	GET /v3/characters/character_id/calendar/event_id/	Get an event
get_characters_character_id_calendar_event_id_attendees	GET /v1/characters/character_id/calendar/event_id/attendees/	Get attendees
put_characters_character_id_calendar_event_id	PUT /v3/characters/character_id/calendar/event_id/	Respond to an event

get_characters_character_id_calendar

Array<GetCharactersCharacterIdCalendar200Ok> get_characters_character_id_calendar(character_id, 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 --- This route is cached for up to 5 seconds

Example

# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
  # Configure OAuth2 access token for authorization: evesso
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ESI::CalendarApi.new

character_id = 56 # Integer | An EVE character ID

opts = { 
  datasource: "tranquility", # String | The server name you would like data from
  from_event: 56, # Integer | 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
}

begin
  #List calendar event summaries
  result = api_instance.get_characters_character_id_calendar(character_id, opts)
  p result
rescue ESI::ApiError => e
  puts "Exception when calling CalendarApi->get_characters_character_id_calendar: #{e}"
end

Parameters

Name	Type	Description	Notes
character_id	Integer	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
from_event	Integer	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

Array<GetCharactersCharacterIdCalendar200Ok>

Authorization

evesso

HTTP request headers

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

get_characters_character_id_calendar_event_id

GetCharactersCharacterIdCalendarEventIdOk get_characters_character_id_calendar_event_id(character_idevent_id, opts)

Get an event

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

Example

# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
  # Configure OAuth2 access token for authorization: evesso
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ESI::CalendarApi.new

character_id = 56 # Integer | An EVE character ID

event_id = 56 # Integer | The id of the event requested

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

begin
  #Get an event
  result = api_instance.get_characters_character_id_calendar_event_id(character_idevent_id, opts)
  p result
rescue ESI::ApiError => e
  puts "Exception when calling CalendarApi->get_characters_character_id_calendar_event_id: #{e}"
end

Parameters

Name	Type	Description	Notes
character_id	Integer	An EVE character ID
event_id	Integer	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

GetCharactersCharacterIdCalendarEventIdOk

Authorization

evesso

HTTP request headers

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

get_characters_character_id_calendar_event_id_attendees

Array<GetCharactersCharacterIdCalendarEventIdAttendees200Ok> get_characters_character_id_calendar_event_id_attendees(character_idevent_id, opts)

Get attendees

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

Example

# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
  # Configure OAuth2 access token for authorization: evesso
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ESI::CalendarApi.new

character_id = 56 # Integer | An EVE character ID

event_id = 56 # Integer | The id of the event requested

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

begin
  #Get attendees
  result = api_instance.get_characters_character_id_calendar_event_id_attendees(character_idevent_id, opts)
  p result
rescue ESI::ApiError => e
  puts "Exception when calling CalendarApi->get_characters_character_id_calendar_event_id_attendees: #{e}"
end

Parameters

Name	Type	Description	Notes
character_id	Integer	An EVE character ID
event_id	Integer	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

Array<GetCharactersCharacterIdCalendarEventIdAttendees200Ok>

Authorization

evesso

HTTP request headers

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

put_characters_character_id_calendar_event_id

put_characters_character_id_calendar_event_id(character_idevent_id, response, opts)

Respond to an event

Set your response status to an event ---

Example

# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
  # Configure OAuth2 access token for authorization: evesso
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ESI::CalendarApi.new

character_id = 56 # Integer | An EVE character ID

event_id = 56 # Integer | The ID of the event requested

response = ESI::PutCharactersCharacterIdCalendarEventIdResponse.new # PutCharactersCharacterIdCalendarEventIdResponse | The response value to set, overriding current value

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
}

begin
  #Respond to an event
  api_instance.put_characters_character_id_calendar_event_id(character_idevent_id, response, opts)
rescue ESI::ApiError => e
  puts "Exception when calling CalendarApi->put_characters_character_id_calendar_event_id: #{e}"
end

Parameters

Name	Type	Description	Notes
character_id	Integer	An EVE character ID
event_id	Integer	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

nil (empty response body)

Authorization

evesso

HTTP request headers

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