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

     1  # \WarsApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetWars**](WarsApi.md#GetWars) | **Get** /v1/wars/ | List wars
     8  [**GetWarsWarId**](WarsApi.md#GetWarsWarId) | **Get** /v1/wars/{war_id}/ | Get war information
     9  [**GetWarsWarIdKillmails**](WarsApi.md#GetWarsWarIdKillmails) | **Get** /v1/wars/{war_id}/killmails/ | List kills for a war
    10  
    11  
    12  # **GetWars**
    13  > []int32 GetWars(ctx, optional)
    14  List wars
    15  
    16  Return a list of wars  ---  This route is cached for up to 3600 seconds
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    23   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a map[string]interface{}.
    27  
    28  Name | Type | Description  | Notes
    29  ------------- | ------------- | ------------- | -------------
    30   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    31   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    32   **maxWarId** | **int32**| Only return wars with ID smaller than this | 
    33  
    34  ### Return type
    35  
    36  **[]int32**
    37  
    38  ### Authorization
    39  
    40  No authorization required
    41  
    42  ### HTTP request headers
    43  
    44   - **Content-Type**: application/json
    45   - **Accept**: application/json
    46  
    47  [[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)
    48  
    49  # **GetWarsWarId**
    50  > GetWarsWarIdOk GetWarsWarId(ctx, warId, optional)
    51  Get war information
    52  
    53  Return details about a war  ---  This route is cached for up to 3600 seconds
    54  
    55  ### Required Parameters
    56  
    57  Name | Type | Description  | Notes
    58  ------------- | ------------- | ------------- | -------------
    59   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    60    **warId** | **int32**| ID for a war | 
    61   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    62  
    63  ### Optional Parameters
    64  Optional parameters are passed through a map[string]interface{}.
    65  
    66  Name | Type | Description  | Notes
    67  ------------- | ------------- | ------------- | -------------
    68   **warId** | **int32**| ID for a war | 
    69   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    70   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    71  
    72  ### Return type
    73  
    74  [**GetWarsWarIdOk**](get_wars_war_id_ok.md)
    75  
    76  ### Authorization
    77  
    78  No authorization required
    79  
    80  ### HTTP request headers
    81  
    82   - **Content-Type**: application/json
    83   - **Accept**: application/json
    84  
    85  [[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)
    86  
    87  # **GetWarsWarIdKillmails**
    88  > []GetWarsWarIdKillmails200Ok GetWarsWarIdKillmails(ctx, warId, optional)
    89  List kills for a war
    90  
    91  Return a list of kills related to a war  ---  This route is cached for up to 3600 seconds
    92  
    93  ### Required Parameters
    94  
    95  Name | Type | Description  | Notes
    96  ------------- | ------------- | ------------- | -------------
    97   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    98    **warId** | **int32**| A valid war ID | 
    99   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   100  
   101  ### Optional Parameters
   102  Optional parameters are passed through a map[string]interface{}.
   103  
   104  Name | Type | Description  | Notes
   105  ------------- | ------------- | ------------- | -------------
   106   **warId** | **int32**| A valid war ID | 
   107   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   108   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
   109   **page** | **int32**| Which page of results to return | [default to 1]
   110  
   111  ### Return type
   112  
   113  [**[]GetWarsWarIdKillmails200Ok**](get_wars_war_id_killmails_200_ok.md)
   114  
   115  ### Authorization
   116  
   117  No authorization required
   118  
   119  ### HTTP request headers
   120  
   121   - **Content-Type**: application/json
   122   - **Accept**: application/json
   123  
   124  [[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)
   125