ESI\Client\SearchApi
All URIs are relative to https://esi.tech.ccp.is/latest
Method | HTTP request | Description |
---|---|---|
getCharactersCharacterIdSearch | GET /characters/{character_id}/search/ | Search on a string |
getSearch | GET /search/ | Search on a string |
getCharactersCharacterIdSearch
\ESI\Client\Model\GetCharactersCharacterIdSearchOk getCharactersCharacterIdSearch($character_id, $search, $categories, $language, $strict, $datasource)
Search on a string
Search for entities that match a given sub-string. --- Alternate route: /v2/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
ESI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new ESI\Client\Api\SearchApi();
$character_id = 56; // int | An EVE character ID
$search = "search_example"; // string | The string to search on
$categories = array("categories_example"); // string[] | Type of entities to search for
$language = "en-us"; // string | Search locale
$strict = false; // bool | Whether the search should be a strict match
$datasource = "tranquility"; // string | The server name you would like data from
try {
$result = $api_instance->getCharactersCharacterIdSearch($character_id, $search, $categories, $language, $strict, $datasource);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SearchApi->getCharactersCharacterIdSearch: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
character_id | int | An EVE character ID | |
search | string | The string to search on | |
categories | string[] | Type of entities to search for | |
language | string | Search locale | [optional] [default to en-us] |
strict | bool | Whether the search should be a strict match | [optional] [default to false] |
datasource | string | The server name you would like data from | [optional] [default to tranquility] |
Return type
\ESI\Client\Model\GetCharactersCharacterIdSearchOk
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getSearch
\ESI\Client\Model\GetSearchOk getSearch($search, $categories, $language, $strict, $datasource)
Search on a string
Search for entities that match a given sub-string. --- Alternate route: /v1/search/
Alternate route: /legacy/search/
--- This route is cached for up to 3600 seconds
Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new ESI\Client\Api\SearchApi();
$search = "search_example"; // string | The string to search on
$categories = array("categories_example"); // string[] | Type of entities to search for
$language = "en-us"; // string | Search locale
$strict = false; // bool | Whether the search should be a strict match
$datasource = "tranquility"; // string | The server name you would like data from
try {
$result = $api_instance->getSearch($search, $categories, $language, $strict, $datasource);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SearchApi->getSearch: ', $e->getMessage(), PHP_EOL;
}
?>
Parameters
Name | Type | Description | Notes |
---|---|---|---|
search | string | The string to search on | |
categories | string[] | Type of entities to search for | |
language | string | Search locale | [optional] [default to en-us] |
strict | bool | Whether the search should be a strict match | [optional] [default to false] |
datasource | string | The server name you would like data from | [optional] [default to tranquility] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]