Skip to content
Greg Malcolm edited this page Jun 23, 2016 · 2 revisions

http://api.edmaterializer.com/api/v4/systems/

With filtering:

http://api.edmaterializer.com/api/v4/systems/?system=HIP%2098020

Currently systems are imported from the "Monster" Distant Worlds spreadsheet's Systems page. At some point we will want to pull this data from EDSM but it'll do for now. Consumers of this app may be better off pulling from EDSM directly in the mean time.

Only one record is kept per star, the record is shared by commanders. The last commander to update is the "updater" field. If it's imported from the monster spread sheet it'll be "DW Spreadsheet"

Delete requests will only be accepted when received from the original creator.

Filters

Add filters on the GET "index" round as querystring params in the url:

(eg http://example.com/things/?filter1=a&filter2=b)

  • page
  • system
  • updater
  • creator
  • updated_before
  • updated_after

Sorting

Use sort (column name) and direction (asc or desc). Eg:

?sort=created_at&direction=desc

Notes / Updates

  • Application users (EDDiscovery) must submit a "user" root level param so we can descern if the request is legal for updates or deletes.
  • The GET "show" action will give a full tree of data including world, star, surveys and basecamps. We're not currently giving all this data for the GET "index" action to keep excess queries to a minimum.
  • tags can be used to note other details such as Expedition waypoints. Could be useful for extending search functionality.
  • Using JSON API schema now (http://jsonapi.org/)