-
Notifications
You must be signed in to change notification settings - Fork 0
Schema V4 Surveys
A full list of surveys. Each survey is owned by a commander and updated using the "commander" argument.
http://api.edmaterializer.com/api/v4/surveys?commander=Marlon%20Blake
This will show all Surveys for the worlds of id 1588. See (Worlds)[Schema---V4---Worlds] for a full catalog of worlds.
A Survey also creates a link to survey_id during updates for convenience. A basecamp can be associated with a survey via the basecamp_id
The concept of "resource" has been taken from the Monster spreadsheet. A resource type represents the type of rock the log is for. A surveyor can also opt AGGREGATED if they want to just store everything in one record disregarding rock types, or BINARY to just enter true or false values. Also worth noticing is there are 2 type ofs of Outcrops, a plain rocky kind that yields minor materials, and an outcrop with yellow coloration which yields higher grade metallic materials. Named "Outcrop 1" and "Outcrop 2" respectively.
The full list:
- Metallic Meteorite
- Mesosiderite
- Bronzite Chondrite
- Outcrop 1
- Outcrop 2
- AGGREGATED
- BINARY
Error flagging attributes can be changed by any commander, not just the owner of the survey. All 3 error flag fields must be set when flagging an error:
- error_flag (eg true or false)
- error_description (details about why the survey is considered erronoeus)
- error_updater (the name of the commander flagging the record).
When unflagging the record the description does not need to be set.
A (World Survey)[Schema---V4---World-Surveys] record is maintained for each world based on the combination of existing Survey records. Error Flagged Survey's are disregarded in this calculation.
Currently surveys are imported from the "Monster" Distant Worlds spreadsheet Logs page.
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
- basecamp_id
- resource
- commander
- updated_before
- updated_after
(when accessing through Worlds nested url you are of course filtering on World too)
Use sort (column name) and direction (asc or desc). Eg:
?sort=created_at&direction=desc
- Site Survey is now Survey. World Surveys are derived from a combination of World Survey data minus error flagged records.
- Using JSON API schema now (http://jsonapi.org/)