Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.78 KB

SearchApi.md

File metadata and controls

77 lines (58 loc) · 3.78 KB
Raw

Swagger\Client\SearchApi

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

Method HTTP request Description
getCharactersCharacterIdSearch GET /characters/{character_id}/search/ Search on a string

getCharactersCharacterIdSearch

\Swagger\Client\Model\GetCharactersCharacterIdSearchOk getCharactersCharacterIdSearch($categories, $character_id, $search, $accept_language, $datasource, $if_none_match, $language, $strict, $token)

Search on a string

Search for entities that match a given sub-string. --- Alternate route: /dev/characters/{character_id}/search/ Alternate route: /legacy/characters/{character_id}/search/ Alternate route: /v3/characters/{character_id}/search/ --- This route is cached for up to 3600 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\SearchApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$categories = array("categories_example"); // string[] | Type of entities to search for
$character_id = 56; // int | An EVE character ID
$search = "search_example"; // string | The string to search on
$accept_language = "en"; // string | Language to use in the response
$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
$language = "en"; // string | Language to use in the response, takes precedence over Accept-Language
$strict = false; // bool | Whether the search should be a strict match
$token = "token_example"; // string | Access token to use if unable to set a header

try {
    $result = $apiInstance->getCharactersCharacterIdSearch($categories, $character_id, $search, $accept_language, $datasource, $if_none_match, $language, $strict, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->getCharactersCharacterIdSearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
categories string[] Type of entities to search for
character_id int An EVE character ID
search string The string to search on
accept_language string Language to use in the response [optional] [default to en]
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]
language string Language to use in the response, takes precedence over Accept-Language [optional] [default to en]
strict bool Whether the search should be a strict match [optional] [default to false]
token string Access token to use if unable to set a header [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdSearchOk

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]