module ESI::Client::Search
ESI
search operations.
Public Instance Methods
Search
for entities that match a given sub-string.
This endpoint is cached for up to 3600 seconds.
This endpoint requires authorization (see {ESI::Client#authorize}).
@esi_scope esi-search.search_structures.v1
@esi_version dev @esi_version legacy @esi_version v3
@param character_id [Integer] An EVE character ID @param categories [Array] Type of entities to search for @param search [String] The string to search on @param strict [Boolean] Whether the search should be a strict match @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Search/get_characters_character_id_search
# File lib/esi/client/search.rb, line 35 def get_character_search(character_id:, categories:, search:, strict: nil, headers: {}, params: {}) params.merge!("categories" => categories, "search" => search, "strict" => strict) get("/characters/#{character_id}/search/", headers: headers, params: params) end
Search
for entities that match a given sub-string.
This endpoint is cached for up to 3600 seconds.
@esi_version dev @esi_version legacy @esi_version v2
@param categories [Array] Type of entities to search for @param search [String] The string to search on @param strict [Boolean] Whether the search should be a strict match @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Search/get_search
# File lib/esi/client/search.rb, line 62 def get_search(categories:, search:, strict: nil, headers: {}, params: {}) params.merge!("categories" => categories, "search" => search, "strict" => strict) get("/search/", headers: headers, params: params) end