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

     1  # \LocationApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetCharactersCharacterIdLocation**](LocationApi.md#GetCharactersCharacterIdLocation) | **Get** /v1/characters/{character_id}/location/ | Get character location
     8  [**GetCharactersCharacterIdOnline**](LocationApi.md#GetCharactersCharacterIdOnline) | **Get** /v2/characters/{character_id}/online/ | Get character online
     9  [**GetCharactersCharacterIdShip**](LocationApi.md#GetCharactersCharacterIdShip) | **Get** /v1/characters/{character_id}/ship/ | Get current ship
    10  
    11  
    12  # **GetCharactersCharacterIdLocation**
    13  > GetCharactersCharacterIdLocationOk GetCharactersCharacterIdLocation(ctx, characterId, optional)
    14  Get character location
    15  
    16  Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable  ---  This route is cached for up to 5 seconds
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    23    **characterId** | **int32**| An EVE character ID | 
    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   **characterId** | **int32**| An EVE character ID | 
    32   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    33   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    34   **token** | **string**| Access token to use if unable to set a header | 
    35  
    36  ### Return type
    37  
    38  [**GetCharactersCharacterIdLocationOk**](get_characters_character_id_location_ok.md)
    39  
    40  ### Authorization
    41  
    42  [evesso](../README.md#evesso)
    43  
    44  ### HTTP request headers
    45  
    46   - **Content-Type**: application/json
    47   - **Accept**: application/json
    48  
    49  [[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)
    50  
    51  # **GetCharactersCharacterIdOnline**
    52  > GetCharactersCharacterIdOnlineOk GetCharactersCharacterIdOnline(ctx, characterId, optional)
    53  Get character online
    54  
    55  Checks if the character is currently online  ---  This route is cached for up to 60 seconds
    56  
    57  ### Required Parameters
    58  
    59  Name | Type | Description  | Notes
    60  ------------- | ------------- | ------------- | -------------
    61   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    62    **characterId** | **int32**| An EVE character ID | 
    63   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    64  
    65  ### Optional Parameters
    66  Optional parameters are passed through a map[string]interface{}.
    67  
    68  Name | Type | Description  | Notes
    69  ------------- | ------------- | ------------- | -------------
    70   **characterId** | **int32**| An EVE character ID | 
    71   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    72   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    73   **token** | **string**| Access token to use if unable to set a header | 
    74  
    75  ### Return type
    76  
    77  [**GetCharactersCharacterIdOnlineOk**](get_characters_character_id_online_ok.md)
    78  
    79  ### Authorization
    80  
    81  [evesso](../README.md#evesso)
    82  
    83  ### HTTP request headers
    84  
    85   - **Content-Type**: application/json
    86   - **Accept**: application/json
    87  
    88  [[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)
    89  
    90  # **GetCharactersCharacterIdShip**
    91  > GetCharactersCharacterIdShipOk GetCharactersCharacterIdShip(ctx, characterId, optional)
    92  Get current ship
    93  
    94  Get the current ship type, name and id  ---  This route is cached for up to 5 seconds
    95  
    96  ### Required Parameters
    97  
    98  Name | Type | Description  | Notes
    99  ------------- | ------------- | ------------- | -------------
   100   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   101    **characterId** | **int32**| An EVE character ID | 
   102   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   103  
   104  ### Optional Parameters
   105  Optional parameters are passed through a map[string]interface{}.
   106  
   107  Name | Type | Description  | Notes
   108  ------------- | ------------- | ------------- | -------------
   109   **characterId** | **int32**| An EVE character ID | 
   110   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   111   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
   112   **token** | **string**| Access token to use if unable to set a header | 
   113  
   114  ### Return type
   115  
   116  [**GetCharactersCharacterIdShipOk**](get_characters_character_id_ship_ok.md)
   117  
   118  ### Authorization
   119  
   120  [evesso](../README.md#evesso)
   121  
   122  ### HTTP request headers
   123  
   124   - **Content-Type**: application/json
   125   - **Accept**: application/json
   126  
   127  [[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)
   128