ESI::WarsApi
All URIs are relative to https://esi.evetech.net
Method | HTTP request | Description |
---|---|---|
get_wars | GET /v1/wars/ | List wars |
get_wars_war_id | GET /v1/wars/war_id/ | Get war information |
get_wars_war_id_killmails | GET /v1/wars/war_id/killmails/ | List kills for a war |
get_wars
Array<Integer> get_wars(opts)
List wars
Return a list of wars --- This route is cached for up to 3600 seconds
Example
# load the gem
require 'esi-client-bvv'
api_instance = ESI::WarsApi.new
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
max_war_id: 56 # Integer | Only return wars with ID smaller than this
}
begin
#List wars
result = api_instance.get_wars(opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling WarsApi->get_wars: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
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] |
max_war_id | Integer | Only return wars with ID smaller than this | [optional] |
Return type
Array<Integer>
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_wars_war_id
GetWarsWarIdOk get_wars_war_id(war_id, opts)
Get war information
Return details about a war --- This route is cached for up to 3600 seconds
Example
# load the gem
require 'esi-client-bvv'
api_instance = ESI::WarsApi.new
war_id = 56 # Integer | ID for a war
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
}
begin
#Get war information
result = api_instance.get_wars_war_id(war_id, opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling WarsApi->get_wars_war_id: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
war_id | Integer | ID for a war | |
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] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_wars_war_id_killmails
Array<GetWarsWarIdKillmails200Ok> get_wars_war_id_killmails(war_id, opts)
List kills for a war
Return a list of kills related to a war --- This route is cached for up to 3600 seconds
Example
# load the gem
require 'esi-client-bvv'
api_instance = ESI::WarsApi.new
war_id = 56 # Integer | A valid war ID
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
page: 1, # Integer | Which page of results to return
}
begin
#List kills for a war
result = api_instance.get_wars_war_id_killmails(war_id, opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling WarsApi->get_wars_war_id_killmails: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
war_id | Integer | A valid war ID | |
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] |
page | Integer | Which page of results to return | [optional] [default to 1] |
Return type
Array<GetWarsWarIdKillmails200Ok>
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json