EveESI.Api.Sovereignty (EveESI v1.0.0)

View Source

API calls for all endpoints tagged Sovereignty.

Summary

Functions

get_sovereignty_campaigns(connection, opts \\ [])

List sovereignty campaigns Shows sovereignty data for campaigns. --- Alternate route: /dev/sovereignty/campaigns/ Alternate route: /legacy/sovereignty/campaigns/ Alternate route: /v1/sovereignty/campaigns/ --- This route is cached for up to 5 seconds

get_sovereignty_map(connection, opts \\ [])

List sovereignty of systems Shows sovereignty information for solar systems --- Alternate route: /dev/sovereignty/map/ Alternate route: /legacy/sovereignty/map/ Alternate route: /v1/sovereignty/map/ --- This route is cached for up to 3600 seconds

get_sovereignty_structures(connection, opts \\ [])

List sovereignty structures Shows sovereignty data for structures. --- Alternate route: /dev/sovereignty/structures/ Alternate route: /legacy/sovereignty/structures/ Alternate route: /v1/sovereignty/structures/ --- This route is cached for up to 120 seconds

Functions

get_sovereignty_campaigns(connection, opts \\ [])

@spec get_sovereignty_campaigns(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, [EveESI.Model.GetSovereigntyCampaigns200Ok.t()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List sovereignty campaigns Shows sovereignty data for campaigns. --- Alternate route: /dev/sovereignty/campaigns/ Alternate route: /legacy/sovereignty/campaigns/ Alternate route: /v1/sovereignty/campaigns/ --- This route is cached for up to 5 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns

  • {:ok, [%GetSovereigntyCampaigns200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_sovereignty_map(connection, opts \\ [])

@spec get_sovereignty_map(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, [EveESI.Model.GetSovereigntyMap200Ok.t()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List sovereignty of systems Shows sovereignty information for solar systems --- Alternate route: /dev/sovereignty/map/ Alternate route: /legacy/sovereignty/map/ Alternate route: /v1/sovereignty/map/ --- This route is cached for up to 3600 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns

  • {:ok, [%GetSovereigntyMap200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_sovereignty_structures(connection, opts \\ [])

@spec get_sovereignty_structures(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, [EveESI.Model.GetSovereigntyStructures200Ok.t()]}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

List sovereignty structures Shows sovereignty data for structures. --- Alternate route: /dev/sovereignty/structures/ Alternate route: /legacy/sovereignty/structures/ Alternate route: /v1/sovereignty/structures/ --- This route is cached for up to 120 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :datasource (String.t): The server name you would like data from
    • :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns

  • {:ok, [%GetSovereigntyStructures200Ok{}, ...]} on success
  • {:error, Tesla.Env.t} on failure