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

     1  # \CalendarApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetCharactersCharacterIdCalendar**](CalendarApi.md#GetCharactersCharacterIdCalendar) | **Get** /v1/characters/{character_id}/calendar/ | List calendar event summaries
     8  [**GetCharactersCharacterIdCalendarEventId**](CalendarApi.md#GetCharactersCharacterIdCalendarEventId) | **Get** /v3/characters/{character_id}/calendar/{event_id}/ | Get an event
     9  [**GetCharactersCharacterIdCalendarEventIdAttendees**](CalendarApi.md#GetCharactersCharacterIdCalendarEventIdAttendees) | **Get** /v1/characters/{character_id}/calendar/{event_id}/attendees/ | Get attendees
    10  [**PutCharactersCharacterIdCalendarEventId**](CalendarApi.md#PutCharactersCharacterIdCalendarEventId) | **Put** /v3/characters/{character_id}/calendar/{event_id}/ | Respond to an event
    11  
    12  
    13  # **GetCharactersCharacterIdCalendar**
    14  > []GetCharactersCharacterIdCalendar200Ok GetCharactersCharacterIdCalendar(ctx, characterId, optional)
    15  List calendar event summaries
    16  
    17  Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event  ---  This route is cached for up to 5 seconds
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    24    **characterId** | **int32**| An EVE character ID | 
    25   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    26  
    27  ### Optional Parameters
    28  Optional parameters are passed through a map[string]interface{}.
    29  
    30  Name | Type | Description  | Notes
    31  ------------- | ------------- | ------------- | -------------
    32   **characterId** | **int32**| An EVE character ID | 
    33   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    34   **fromEvent** | **int32**| The event ID to retrieve events from | 
    35   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    36   **token** | **string**| Access token to use if unable to set a header | 
    37  
    38  ### Return type
    39  
    40  [**[]GetCharactersCharacterIdCalendar200Ok**](get_characters_character_id_calendar_200_ok.md)
    41  
    42  ### Authorization
    43  
    44  [evesso](../README.md#evesso)
    45  
    46  ### HTTP request headers
    47  
    48   - **Content-Type**: application/json
    49   - **Accept**: application/json
    50  
    51  [[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)
    52  
    53  # **GetCharactersCharacterIdCalendarEventId**
    54  > GetCharactersCharacterIdCalendarEventIdOk GetCharactersCharacterIdCalendarEventId(ctx, characterId, eventId, optional)
    55  Get an event
    56  
    57  Get all the information for a specific event  ---  This route is cached for up to 5 seconds
    58  
    59  ### Required Parameters
    60  
    61  Name | Type | Description  | Notes
    62  ------------- | ------------- | ------------- | -------------
    63   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    64    **characterId** | **int32**| An EVE character ID | 
    65    **eventId** | **int32**| The id of the event requested | 
    66   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    67  
    68  ### Optional Parameters
    69  Optional parameters are passed through a map[string]interface{}.
    70  
    71  Name | Type | Description  | Notes
    72  ------------- | ------------- | ------------- | -------------
    73   **characterId** | **int32**| An EVE character ID | 
    74   **eventId** | **int32**| The id of the event requested | 
    75   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    76   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    77   **token** | **string**| Access token to use if unable to set a header | 
    78  
    79  ### Return type
    80  
    81  [**GetCharactersCharacterIdCalendarEventIdOk**](get_characters_character_id_calendar_event_id_ok.md)
    82  
    83  ### Authorization
    84  
    85  [evesso](../README.md#evesso)
    86  
    87  ### HTTP request headers
    88  
    89   - **Content-Type**: application/json
    90   - **Accept**: application/json
    91  
    92  [[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)
    93  
    94  # **GetCharactersCharacterIdCalendarEventIdAttendees**
    95  > []GetCharactersCharacterIdCalendarEventIdAttendees200Ok GetCharactersCharacterIdCalendarEventIdAttendees(ctx, characterId, eventId, optional)
    96  Get attendees
    97  
    98  Get all invited attendees for a given event  ---  This route is cached for up to 600 seconds
    99  
   100  ### Required Parameters
   101  
   102  Name | Type | Description  | Notes
   103  ------------- | ------------- | ------------- | -------------
   104   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   105    **characterId** | **int32**| An EVE character ID | 
   106    **eventId** | **int32**| The id of the event requested | 
   107   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   108  
   109  ### Optional Parameters
   110  Optional parameters are passed through a map[string]interface{}.
   111  
   112  Name | Type | Description  | Notes
   113  ------------- | ------------- | ------------- | -------------
   114   **characterId** | **int32**| An EVE character ID | 
   115   **eventId** | **int32**| The id of the event requested | 
   116   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   117   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
   118   **token** | **string**| Access token to use if unable to set a header | 
   119  
   120  ### Return type
   121  
   122  [**[]GetCharactersCharacterIdCalendarEventIdAttendees200Ok**](get_characters_character_id_calendar_event_id_attendees_200_ok.md)
   123  
   124  ### Authorization
   125  
   126  [evesso](../README.md#evesso)
   127  
   128  ### HTTP request headers
   129  
   130   - **Content-Type**: application/json
   131   - **Accept**: application/json
   132  
   133  [[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)
   134  
   135  # **PutCharactersCharacterIdCalendarEventId**
   136  > PutCharactersCharacterIdCalendarEventId(ctx, characterId, eventId, response, optional)
   137  Respond to an event
   138  
   139  Set your response status to an event  ---  This route is cached for up to 5 seconds
   140  
   141  ### Required Parameters
   142  
   143  Name | Type | Description  | Notes
   144  ------------- | ------------- | ------------- | -------------
   145   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   146    **characterId** | **int32**| An EVE character ID | 
   147    **eventId** | **int32**| The ID of the event requested | 
   148    **response** | [**PutCharactersCharacterIdCalendarEventIdResponse**](PutCharactersCharacterIdCalendarEventIdResponse.md)| The response value to set, overriding current value | 
   149   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   150  
   151  ### Optional Parameters
   152  Optional parameters are passed through a map[string]interface{}.
   153  
   154  Name | Type | Description  | Notes
   155  ------------- | ------------- | ------------- | -------------
   156   **characterId** | **int32**| An EVE character ID | 
   157   **eventId** | **int32**| The ID of the event requested | 
   158   **response** | [**PutCharactersCharacterIdCalendarEventIdResponse**](PutCharactersCharacterIdCalendarEventIdResponse.md)| The response value to set, overriding current value | 
   159   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   160   **token** | **string**| Access token to use if unable to set a header | 
   161  
   162  ### Return type
   163  
   164   (empty response body)
   165  
   166  ### Authorization
   167  
   168  [evesso](../README.md#evesso)
   169  
   170  ### HTTP request headers
   171  
   172   - **Content-Type**: application/json
   173   - **Accept**: application/json
   174  
   175  [[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)
   176