Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 7.41 KB

PlanetaryInteractionApi.md

File metadata and controls

169 lines (113 loc) · 7.41 KB

\PlanetaryInteractionApi

All URIs are relative to https://esi.evetech.net

Method HTTP request Description
GetCharactersCharacterIdPlanets Get /v1/characters/{character_id}/planets/ Get colonies
GetCharactersCharacterIdPlanetsPlanetId Get /v3/characters/{character_id}/planets/{planet_id}/ Get colony layout
GetCorporationsCorporationIdCustomsOffices Get /v1/corporations/{corporation_id}/customs_offices/ List corporation customs offices
GetUniverseSchematicsSchematicId Get /v1/universe/schematics/{schematic_id}/ Get schematic information

GetCharactersCharacterIdPlanets

[]GetCharactersCharacterIdPlanets200Ok GetCharactersCharacterIdPlanets(ctx, characterId, optional) Get colonies

Returns a list of all planetary colonies owned by a character. --- This route is cached for up to 600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header

Return type

[]GetCharactersCharacterIdPlanets200Ok

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdPlanetsPlanetId

GetCharactersCharacterIdPlanetsPlanetIdOk GetCharactersCharacterIdPlanetsPlanetId(ctx, characterId, planetId, optional) Get colony layout

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. ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
planetId int32 Planet id of the target planet
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
planetId int32 Planet id of the target planet
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header

Return type

GetCharactersCharacterIdPlanetsPlanetIdOk

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCorporationsCorporationIdCustomsOffices

[]GetCorporationsCorporationIdCustomsOffices200Ok GetCorporationsCorporationIdCustomsOffices(ctx, corporationId, optional) List corporation customs offices

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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
corporationId int32 An EVE corporation ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
corporationId int32 An EVE corporation ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
page int32 Which page of results to return [default to 1]
token string Access token to use if unable to set a header

Return type

[]GetCorporationsCorporationIdCustomsOffices200Ok

Authorization

evesso

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUniverseSchematicsSchematicId

GetUniverseSchematicsSchematicIdOk GetUniverseSchematicsSchematicId(ctx, schematicId, optional) Get schematic information

Get information on a planetary factory schematic --- This route is cached for up to 3600 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
schematicId int32 A PI schematic ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
schematicId int32 A PI schematic ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag

Return type

GetUniverseSchematicsSchematicIdOk

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]