class ESI::CharacterApi
Attributes
Public Class Methods
# File lib/esi-client-bvv/api/character_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get character's public information Public information about a character — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetCharactersCharacterIdOk]
# File lib/esi-client-bvv/api/character_api.rb, line 30 def get_characters_character_id(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_with_http_info(character_id, opts) return data end
Get agents research Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdAgentsResearch200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 99 def get_characters_character_id_agents_research(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_agents_research_with_http_info(character_id, opts) return data end
Get agents research Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdAgentsResearch200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdAgentsResearch200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 112 def get_characters_character_id_agents_research_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_agents_research ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_agents_research" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_agents_research, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/agents_research/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdAgentsResearch200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_agents_research\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get blueprints Return a list of blueprints the character owns — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [Integer] :page Which page of results to return (default to 1) @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdBlueprints200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 171 def get_characters_character_id_blueprints(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_blueprints_with_http_info(character_id, opts) return data end
Get blueprints Return a list of blueprints the character owns — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [Integer] :page Which page of results to return @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdBlueprints200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdBlueprints200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 185 def get_characters_character_id_blueprints_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_blueprints ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_blueprints" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_blueprints, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CharacterApi.get_characters_character_id_blueprints, must be greater than or equal to 1.' end # resource path local_var_path = "/v2/characters/{character_id}/blueprints/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdBlueprints200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_blueprints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get corporation history Get a list of all the corporations a character has been a member of — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<GetCharactersCharacterIdCorporationhistory200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 247 def get_characters_character_id_corporationhistory(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_corporationhistory_with_http_info(character_id, opts) return data end
Get corporation history Get a list of all the corporations a character has been a member of — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(Array<GetCharactersCharacterIdCorporationhistory200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdCorporationhistory200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 259 def get_characters_character_id_corporationhistory_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_corporationhistory ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_corporationhistory" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_corporationhistory, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/corporationhistory/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdCorporationhistory200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_corporationhistory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get jump fatigue Return a character's jump activation and fatigue information — This route is cached for up to 300 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [GetCharactersCharacterIdFatigueOk]
# File lib/esi-client-bvv/api/character_api.rb, line 316 def get_characters_character_id_fatigue(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_fatigue_with_http_info(character_id, opts) return data end
Get jump fatigue Return a character's jump activation and fatigue information — This route is cached for up to 300 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(GetCharactersCharacterIdFatigueOk
, Fixnum, Hash)>] GetCharactersCharacterIdFatigueOk
data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 329 def get_characters_character_id_fatigue_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_fatigue ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_fatigue" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_fatigue, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/fatigue/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCharactersCharacterIdFatigueOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_fatigue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get medals Return a list of medals the character has — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdMedals200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 387 def get_characters_character_id_medals(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_medals_with_http_info(character_id, opts) return data end
Get medals Return a list of medals the character has — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdMedals200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdMedals200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 400 def get_characters_character_id_medals_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_medals ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_medals" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_medals, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/medals/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdMedals200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_medals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character notifications Return character notifications — This route is cached for up to 600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdNotifications200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 458 def get_characters_character_id_notifications(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_notifications_with_http_info(character_id, opts) return data end
Get new contact notifications Return notifications about having been added to someone's contact list — This route is cached for up to 600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdNotificationsContacts200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 529 def get_characters_character_id_notifications_contacts(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_notifications_contacts_with_http_info(character_id, opts) return data end
Get new contact notifications Return notifications about having been added to someone's contact list — This route is cached for up to 600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdNotificationsContacts200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdNotificationsContacts200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 542 def get_characters_character_id_notifications_contacts_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_notifications_contacts ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_notifications_contacts" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_notifications_contacts, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/notifications/contacts/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdNotificationsContacts200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_notifications_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character notifications Return character notifications — This route is cached for up to 600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdNotifications200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdNotifications200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 471 def get_characters_character_id_notifications_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_notifications ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_notifications" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_notifications, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v4/characters/{character_id}/notifications/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdNotifications200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character portraits Get portrait urls for a character — This route expires daily at 11:05 @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetCharactersCharacterIdPortraitOk]
# File lib/esi-client-bvv/api/character_api.rb, line 599 def get_characters_character_id_portrait(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_portrait_with_http_info(character_id, opts) return data end
Get character portraits Get portrait urls for a character — This route expires daily at 11:05 @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetCharactersCharacterIdPortraitOk
, Fixnum, Hash)>] GetCharactersCharacterIdPortraitOk
data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 611 def get_characters_character_id_portrait_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_portrait ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_portrait" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_portrait, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v2/characters/{character_id}/portrait/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCharactersCharacterIdPortraitOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_portrait\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character corporation roles Returns a character's corporation roles — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [GetCharactersCharacterIdRolesOk]
# File lib/esi-client-bvv/api/character_api.rb, line 668 def get_characters_character_id_roles(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_roles_with_http_info(character_id, opts) return data end
Get character corporation roles Returns a character's corporation roles — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(GetCharactersCharacterIdRolesOk
, Fixnum, Hash)>] GetCharactersCharacterIdRolesOk
data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 681 def get_characters_character_id_roles_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_roles ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_roles" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_roles, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v2/characters/{character_id}/roles/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCharactersCharacterIdRolesOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get standings Return character standings from agents, NPC corporations, and factions — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdStandings200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 739 def get_characters_character_id_standings(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_standings_with_http_info(character_id, opts) return data end
Get standings Return character standings from agents, NPC corporations, and factions — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdStandings200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdStandings200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 752 def get_characters_character_id_standings_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_standings ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_standings" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_standings, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/standings/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdStandings200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_standings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Yearly aggregate stats Returns aggregate yearly stats for a character — This route is cached for up to 86400 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdStats200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 810 def get_characters_character_id_stats(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_stats_with_http_info(character_id, opts) return data end
Yearly aggregate stats Returns aggregate yearly stats for a character — This route is cached for up to 86400 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdStats200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdStats200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 823 def get_characters_character_id_stats_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_stats ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_stats" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_stats, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v2/characters/{character_id}/stats/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdStats200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character corporation titles Returns a character's titles — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<GetCharactersCharacterIdTitles200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 881 def get_characters_character_id_titles(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_titles_with_http_info(character_id, opts) return data end
Get character corporation titles Returns a character's titles — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(Array<GetCharactersCharacterIdTitles200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdTitles200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 894 def get_characters_character_id_titles_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_titles ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_titles" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_titles, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/{character_id}/titles/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdTitles200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_titles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character's public information Public information about a character — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetCharactersCharacterIdOk
, Fixnum, Hash)>] GetCharactersCharacterIdOk
data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 42 def get_characters_character_id_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v4/characters/{character_id}/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCharactersCharacterIdOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — This route is cached for up to 3600 seconds @param characters The character IDs to fetch affiliations for. All characters must exist, or none will be returned @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @return [Array<PostCharactersAffiliation200Ok>]
# File lib/esi-client-bvv/api/character_api.rb, line 950 def post_characters_affiliation(characters, opts = {}) data, _status_code, _headers = post_characters_affiliation_with_http_info(characters, opts) return data end
Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — This route is cached for up to 3600 seconds @param characters The character IDs to fetch affiliations for. All characters must exist, or none will be returned @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @return [Array<(Array<PostCharactersAffiliation200Ok>, Fixnum, Hash)>] Array<PostCharactersAffiliation200Ok> data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 961 def post_characters_affiliation_with_http_info(characters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.post_characters_affiliation ..." end # verify the required parameter 'characters' is set if @api_client.config.client_side_validation && characters.nil? fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_affiliation" end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v1/characters/affiliation/" # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(characters) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<PostCharactersAffiliation200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#post_characters_affiliation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost — @param character_id An EVE character ID @param characters The target characters to calculate the charge for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @return [Float]
# File lib/esi-client-bvv/api/character_api.rb, line 1013 def post_characters_character_id_cspa(character_id, characters, opts = {}) data, _status_code, _headers = post_characters_character_id_cspa_with_http_info(character_id, characters, opts) return data end
Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost — @param character_id An EVE character ID @param characters The target characters to calculate the charge for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
# File lib/esi-client-bvv/api/character_api.rb, line 1026 def post_characters_character_id_cspa_with_http_info(character_id, characters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CharacterApi.post_characters_character_id_cspa ..." end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.post_characters_character_id_cspa" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.post_characters_character_id_cspa, must be greater than or equal to 1.' end # verify the required parameter 'characters' is set if @api_client.config.client_side_validation && characters.nil? fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_character_id_cspa" end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/v4/characters/{character_id}/cspa/".sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(characters) auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Float') if @api_client.config.debugging @api_client.config.logger.debug "API called: CharacterApi#post_characters_character_id_cspa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end