Schema V4 Basecamps - gregmalcolm/ed-materializer GitHub Wiki

Basecamps can optionally be added to worlds and be referenced by Surveys (using basecamp_id). They provide some details about the locations of surveys and the kind of terrain at the start point. More useful to scientific prospectors.

Full Listing URL

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

This will show all basecamps for the world of id 1588. See (Worlds)[Schema---V4---Basecamps] for a full catalog of worlds.

Import details

Currently basecamps are imported from the "Monster" Distant Worlds spreadsheet Surveys page.

Index Filters

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

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

• page
• world_id
• name
• updater
• creator
• updated_before
• updated_after

(when accessing through Worlds nested url you are of course filtering on world too)

Sorting

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

?sort=created_at&direction=desc

Notes / Updates

• This route can be nested out from the worlds route
• Site Surveys can be nested out from this unnested version of this route
• Application users (EDDiscovery) must submit a "user" root level param so we can discern if the request is legal for updates or deletes.
• Dropping "Tree view" support for now. It may come back as param option later.
• Using JSON API schema now (http://jsonapi.org/)