github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/esi/docs/SearchApi.md (about)

     1  # \SearchApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetCharactersCharacterIdSearch**](SearchApi.md#GetCharactersCharacterIdSearch) | **Get** /v3/characters/{character_id}/search/ | Search on a string
     8  
     9  
    10  # **GetCharactersCharacterIdSearch**
    11  > GetCharactersCharacterIdSearchOk GetCharactersCharacterIdSearch(ctx, categories, characterId, search, optional)
    12  Search on a string
    13  
    14  Search for entities that match a given sub-string.  ---  This route is cached for up to 3600 seconds
    15  
    16  ### Required Parameters
    17  
    18  Name | Type | Description  | Notes
    19  ------------- | ------------- | ------------- | -------------
    20   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    21    **categories** | [**[]string**](string.md)| Type of entities to search for | 
    22    **characterId** | **int32**| An EVE character ID | 
    23    **search** | **string**| The string to search on | 
    24   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    25  
    26  ### Optional Parameters
    27  Optional parameters are passed through a map[string]interface{}.
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31   **categories** | [**[]string**](string.md)| Type of entities to search for | 
    32   **characterId** | **int32**| An EVE character ID | 
    33   **search** | **string**| The string to search on | 
    34   **acceptLanguage** | **string**| Language to use in the response | [default to en]
    35   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    36   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    37   **language** | **string**| Language to use in the response, takes precedence over Accept-Language | [default to en]
    38   **strict** | **bool**| Whether the search should be a strict match | [default to false]
    39   **token** | **string**| Access token to use if unable to set a header | 
    40  
    41  ### Return type
    42  
    43  [**GetCharactersCharacterIdSearchOk**](get_characters_character_id_search_ok.md)
    44  
    45  ### Authorization
    46  
    47  [evesso](../README.md#evesso)
    48  
    49  ### HTTP request headers
    50  
    51   - **Content-Type**: application/json
    52   - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    55