EveESI.Api.Location (EveESI v1.0.0)

View Source

API calls for all endpoints tagged Location.

Summary

Functions

get_characters_character_id_location(connection, character_id, opts \\ [])

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable --- Alternate route: /dev/characters/{character_id}/location/ Alternate route: /legacy/characters/{character_id}/location/ Alternate route: /v1/characters/{character_id}/location/ Alternate route: /v2/characters/{character_id}/location/ --- This route is cached for up to 5 seconds

get_characters_character_id_online(connection, character_id, opts \\ [])

Get character online Checks if the character is currently online --- Alternate route: /dev/characters/{character_id}/online/ Alternate route: /v2/characters/{character_id}/online/ Alternate route: /v3/characters/{character_id}/online/ --- This route is cached for up to 60 seconds

get_characters_character_id_ship(connection, character_id, opts \\ [])

Get current ship Get the current ship type, name and id --- Alternate route: /dev/characters/{character_id}/ship/ Alternate route: /legacy/characters/{character_id}/ship/ Alternate route: /v1/characters/{character_id}/ship/ Alternate route: /v2/characters/{character_id}/ship/ --- This route is cached for up to 5 seconds

Functions

get_characters_character_id_location(connection, character_id, opts \\ [])

@spec get_characters_character_id_location(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.GetCharactersCharacterIdLocationOk.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable --- Alternate route: /dev/characters/{character_id}/location/ Alternate route: /legacy/characters/{character_id}/location/ Alternate route: /v1/characters/{character_id}/location/ Alternate route: /v2/characters/{character_id}/location/ --- This route is cached for up to 5 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character 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
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, EveESI.Model.GetCharactersCharacterIdLocationOk.t} on success
  • {:error, Tesla.Env.t} on failure

get_characters_character_id_online(connection, character_id, opts \\ [])

@spec get_characters_character_id_online(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.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.GetCharactersCharacterIdOnlineOk.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Get character online Checks if the character is currently online --- Alternate route: /dev/characters/{character_id}/online/ Alternate route: /v2/characters/{character_id}/online/ Alternate route: /v3/characters/{character_id}/online/ --- This route is cached for up to 60 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character 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
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, EveESI.Model.GetCharactersCharacterIdOnlineOk.t} on success
  • {:error, Tesla.Env.t} on failure

get_characters_character_id_ship(connection, character_id, opts \\ [])

@spec get_characters_character_id_ship(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.GetCharactersCharacterIdShipOk.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Get current ship Get the current ship type, name and id --- Alternate route: /dev/characters/{character_id}/ship/ Alternate route: /legacy/characters/{character_id}/ship/ Alternate route: /v1/characters/{character_id}/ship/ Alternate route: /v2/characters/{character_id}/ship/ --- This route is cached for up to 5 seconds

Parameters

  • connection (EveESI.Connection): Connection to server
  • character_id (integer()): An EVE character 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
    • :token (String.t): Access token to use if unable to set a header

Returns

  • {:ok, EveESI.Model.GetCharactersCharacterIdShipOk.t} on success
  • {:error, Tesla.Env.t} on failure