esi

v0.1.1

esi v0.1.1 ESI.API.War

Summary

Types

killmails_opt()
killmails_opts()

Options for War.killmails/2

wars_opt()
wars_opts()

Options for War.wars/1

Functions

killmails(war_id, opts \\ [])

Return a list of kills related to a war

war(war_id)

Return details about a war

wars(opts \\ [])

Return a list of wars

Types

killmails_opt() 
killmails_opt() :: {:page, nil | integer}
killmails_opts() 
killmails_opts() :: [killmails_opt]

Options for War.killmails/2.

  • :page (DEFAULT: 1) — Which page of results to return
wars_opt() 
wars_opt() :: {:max_war_id, nil | integer}
wars_opts() 
wars_opts() :: [wars_opt]

Options for War.wars/1.

  • :max_war_id — Only return wars with ID smaller than this.

Functions

killmails(war_id, opts \\ []) 
killmails(war_id :: integer, opts :: killmails_opts) :: ESI.Request.t

Return a list of kills related to a war.

Response Example

A list of killmail IDs and hashes:

[%{"killmail_hash" => "8eef5e8fb6b88fe3407c489df33822b2e3b57a5e",
   "killmail_id" => 2},
 %{"killmail_hash" => "b41ccb498ece33d64019f64c0db392aa3aa701fb",
   "killmail_id" => 1}]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_wars_war_id_killmails
  • path — /wars/{war_id}/killmails/

View on ESI Site

war(war_id) 
war(war_id :: integer) :: ESI.Request.t

Return details about a war.

Response Example

Details about a war:

%{"aggressor" => %{"corporation_id" => 986665792, "isk_destroyed" => 0,
    "ships_killed" => 0}, "declared" => "2004-05-22T05:20:00Z",
  "defender" => %{"corporation_id" => 1001562011, "isk_destroyed" => 0,
    "ships_killed" => 0}, "id" => 1941, "mutual" => false,
  "open_for_allies" => false}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_wars_war_id
  • path — /wars/{war_id}/

View on ESI Site

wars(opts \\ []) 
wars(opts :: wars_opts) :: ESI.Request.t

Return a list of wars.

Response Example

A list of war IDs, in decending order by war_id.:

[3, 2, 1]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_wars
  • path — /wars/

View on ESI Site