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

     1  # \PlanetaryInteractionApi
     2  
     3  All URIs are relative to *https://esi.evetech.net*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetCharactersCharacterIdPlanets**](PlanetaryInteractionApi.md#GetCharactersCharacterIdPlanets) | **Get** /v1/characters/{character_id}/planets/ | Get colonies
     8  [**GetCharactersCharacterIdPlanetsPlanetId**](PlanetaryInteractionApi.md#GetCharactersCharacterIdPlanetsPlanetId) | **Get** /v3/characters/{character_id}/planets/{planet_id}/ | Get colony layout
     9  [**GetCorporationsCorporationIdCustomsOffices**](PlanetaryInteractionApi.md#GetCorporationsCorporationIdCustomsOffices) | **Get** /v1/corporations/{corporation_id}/customs_offices/ | List corporation customs offices
    10  [**GetUniverseSchematicsSchematicId**](PlanetaryInteractionApi.md#GetUniverseSchematicsSchematicId) | **Get** /v1/universe/schematics/{schematic_id}/ | Get schematic information
    11  
    12  
    13  # **GetCharactersCharacterIdPlanets**
    14  > []GetCharactersCharacterIdPlanets200Ok GetCharactersCharacterIdPlanets(ctx, characterId, optional)
    15  Get colonies
    16  
    17  Returns a list of all planetary colonies owned by a character.  ---  This route is cached for up to 600 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   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
    35   **token** | **string**| Access token to use if unable to set a header | 
    36  
    37  ### Return type
    38  
    39  [**[]GetCharactersCharacterIdPlanets200Ok**](get_characters_character_id_planets_200_ok.md)
    40  
    41  ### Authorization
    42  
    43  [evesso](../README.md#evesso)
    44  
    45  ### HTTP request headers
    46  
    47   - **Content-Type**: application/json
    48   - **Accept**: application/json
    49  
    50  [[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)
    51  
    52  # **GetCharactersCharacterIdPlanetsPlanetId**
    53  > GetCharactersCharacterIdPlanetsPlanetIdOk GetCharactersCharacterIdPlanetsPlanetId(ctx, characterId, planetId, optional)
    54  Get colony layout
    55  
    56  Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.  --- 
    57  
    58  ### Required Parameters
    59  
    60  Name | Type | Description  | Notes
    61  ------------- | ------------- | ------------- | -------------
    62   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
    63    **characterId** | **int32**| An EVE character ID | 
    64    **planetId** | **int32**| Planet id of the target planet | 
    65   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
    66  
    67  ### Optional Parameters
    68  Optional parameters are passed through a map[string]interface{}.
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72   **characterId** | **int32**| An EVE character ID | 
    73   **planetId** | **int32**| Planet id of the target planet | 
    74   **datasource** | **string**| The server name you would like data from | [default to tranquility]
    75   **token** | **string**| Access token to use if unable to set a header | 
    76  
    77  ### Return type
    78  
    79  [**GetCharactersCharacterIdPlanetsPlanetIdOk**](get_characters_character_id_planets_planet_id_ok.md)
    80  
    81  ### Authorization
    82  
    83  [evesso](../README.md#evesso)
    84  
    85  ### HTTP request headers
    86  
    87   - **Content-Type**: application/json
    88   - **Accept**: application/json
    89  
    90  [[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)
    91  
    92  # **GetCorporationsCorporationIdCustomsOffices**
    93  > []GetCorporationsCorporationIdCustomsOffices200Ok GetCorporationsCorporationIdCustomsOffices(ctx, corporationId, optional)
    94  List corporation customs offices
    95  
    96  List customs offices owned by a corporation  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Director
    97  
    98  ### Required Parameters
    99  
   100  Name | Type | Description  | Notes
   101  ------------- | ------------- | ------------- | -------------
   102   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   103    **corporationId** | **int32**| An EVE corporation ID | 
   104   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   105  
   106  ### Optional Parameters
   107  Optional parameters are passed through a map[string]interface{}.
   108  
   109  Name | Type | Description  | Notes
   110  ------------- | ------------- | ------------- | -------------
   111   **corporationId** | **int32**| An EVE corporation ID | 
   112   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   113   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
   114   **page** | **int32**| Which page of results to return | [default to 1]
   115   **token** | **string**| Access token to use if unable to set a header | 
   116  
   117  ### Return type
   118  
   119  [**[]GetCorporationsCorporationIdCustomsOffices200Ok**](get_corporations_corporation_id_customs_offices_200_ok.md)
   120  
   121  ### Authorization
   122  
   123  [evesso](../README.md#evesso)
   124  
   125  ### HTTP request headers
   126  
   127   - **Content-Type**: application/json
   128   - **Accept**: application/json
   129  
   130  [[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)
   131  
   132  # **GetUniverseSchematicsSchematicId**
   133  > GetUniverseSchematicsSchematicIdOk GetUniverseSchematicsSchematicId(ctx, schematicId, optional)
   134  Get schematic information
   135  
   136  Get information on a planetary factory schematic  ---  This route is cached for up to 3600 seconds
   137  
   138  ### Required Parameters
   139  
   140  Name | Type | Description  | Notes
   141  ------------- | ------------- | ------------- | -------------
   142   **ctx** | **context.Context** | pass through context (authentication, logging, tracing)
   143    **schematicId** | **int32**| A PI schematic ID | 
   144   **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
   145  
   146  ### Optional Parameters
   147  Optional parameters are passed through a map[string]interface{}.
   148  
   149  Name | Type | Description  | Notes
   150  ------------- | ------------- | ------------- | -------------
   151   **schematicId** | **int32**| A PI schematic ID | 
   152   **datasource** | **string**| The server name you would like data from | [default to tranquility]
   153   **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 
   154  
   155  ### Return type
   156  
   157  [**GetUniverseSchematicsSchematicIdOk**](get_universe_schematics_schematic_id_ok.md)
   158  
   159  ### Authorization
   160  
   161  No authorization required
   162  
   163  ### HTTP request headers
   164  
   165   - **Content-Type**: application/json
   166   - **Accept**: application/json
   167  
   168  [[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)
   169