Skip to content

Latest commit

 

History

History
131 lines (96 loc) · 5.86 KB

SearchApi.md

File metadata and controls

131 lines (96 loc) · 5.86 KB

Swagger\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

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

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
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\SearchApi(new \Http\Adapter\Guzzle6\Client());
$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
$datasource = "tranquility"; // string | The server name you would like data from
$language = "en-us"; // string | Language to use in the response
$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
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdSearch($categories, $character_id, $search, $datasource, $language, $strict, $token, $user_agent, $x_user_agent);
    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
datasource string The server name you would like data from [optional] [default to tranquility]
language string Language to use in the response [optional] [default to en-us]
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]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [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]

getSearch

\Swagger\Client\Model\GetSearchOk getSearch($categories, $search, $datasource, $language, $strict, $user_agent, $x_user_agent)

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 Swagger\Client\Api\SearchApi(new \Http\Adapter\Guzzle6\Client());
$categories = array("categories_example"); // string[] | Type of entities to search for
$search = "search_example"; // string | The string to search on
$datasource = "tranquility"; // string | The server name you would like data from
$language = "en-us"; // string | Language to use in the response
$strict = false; // bool | Whether the search should be a strict match
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getSearch($categories, $search, $datasource, $language, $strict, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->getSearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
categories string[] Type of entities to search for
search string The string to search on
datasource string The server name you would like data from [optional] [default to tranquility]
language string Language to use in the response [optional] [default to en-us]
strict bool Whether the search should be a strict match [optional] [default to false]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetSearchOk

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]