EveESI.Api.Alliance (EveESI v1.0.0)

API calls for all endpoints tagged Alliance.

Summary

Functions

List all alliances List all active player alliances --- Alternate route: /dev/alliances/ Alternate route: /legacy/alliances/ Alternate route: /v1/alliances/ Alternate route: /v2/alliances/ --- This route is cached for up to 3600 seconds

get_alliances_alliance_id(connection, alliance_id, opts \\ [])

Get alliance information Public information about an alliance --- Alternate route: /dev/alliances/{alliance_id}/ Alternate route: /legacy/alliances/{alliance_id}/ Alternate route: /v3/alliances/{alliance_id}/ Alternate route: /v4/alliances/{alliance_id}/ --- This route is cached for up to 3600 seconds

get_alliances_alliance_id_corporations(connection, alliance_id, opts \\ [])

List alliance's corporations List all current member corporations of an alliance --- Alternate route: /dev/alliances/{alliance_id}/corporations/ Alternate route: /legacy/alliances/{alliance_id}/corporations/ Alternate route: /v1/alliances/{alliance_id}/corporations/ Alternate route: /v2/alliances/{alliance_id}/corporations/ --- This route is cached for up to 3600 seconds

get_alliances_alliance_id_icons(connection, alliance_id, opts \\ [])

Get alliance icon Get the icon urls for a alliance --- Alternate route: /legacy/alliances/{alliance_id}/icons/ Alternate route: /v1/alliances/{alliance_id}/icons/ --- This route expires daily at 11:05 --- Diff of the upcoming changes

Functions

get_alliances(connection, opts \\ [])

@spec get_alliances(
  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, [integer()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

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, [%Integer{}, ...]} on success
{:error, Tesla.Env.t} on failure

get_alliances_alliance_id(connection, alliance_id, opts \\ [])

@spec get_alliances_alliance_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.GetAlliancesAllianceIdOk.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GetAlliancesAllianceIdNotFound.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
alliance_id (integer()): An EVE alliance ID
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, EveESI.Model.GetAlliancesAllianceIdOk.t} on success
{:error, Tesla.Env.t} on failure

get_alliances_alliance_id_corporations(connection, alliance_id, opts \\ [])

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

Parameters

connection (EveESI.Connection): Connection to server
alliance_id (integer()): An EVE alliance ID
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, [%Integer{}, ...]} on success
{:error, Tesla.Env.t} on failure

get_alliances_alliance_id_icons(connection, alliance_id, opts \\ [])

@spec get_alliances_alliance_id_icons(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.GetAlliancesAllianceIdIconsNotFound.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GetAlliancesAllianceIdIconsOk.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
alliance_id (integer()): An EVE alliance ID
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, EveESI.Model.GetAlliancesAllianceIdIconsOk.t} on success
{:error, Tesla.Env.t} on failure