Mobile Interface and API

Functional specification

  • create a default "FieldNote" data layer (formerly "record type")
    • this will be one of the data layer "templates" that we talked about last year -- ie, a pre-canned set of fields for defining a record type, like "Interview", etc
  • the mobile app will only be able to create records of type FieldNote
  • FieldNote will be: location, image set (1 or more, up to some reasonable cap, lets say 5?), audio set (same limitation), text note
  • UPDATE: FieldNote will be: title, location, image (0 or 1), audio (0 or 1), and text note

API

  • register: user enters username, password, email, gets new account created, send them a confirmation email that includes a link to their profile page
    • Not doing this for now. Need to revisit this: this will need to return a session id that then gets passed back in every subsequent API call
  • list projects: for 1 given user (for now ... later will want to list projects for many [all?] users) [does not require username/pw]
  • create a project: specify a title and description, also requires username/pw
  • ??? list layers for a given project
  • make a field note: specify a project id and all the fields of a FN, saves this FN to the project, if this project has been setup in advance and wasn't previously configured to include FieldNotes, add that data layer first.
  • list data points: given a lat,lon and some distance D return all data points in that radius. For each, return an id, project id, title, a thumbnail and short text
    • instead of a distance D, it may make sense to say like "give me the 10 data points closets to me" (or, whatever number is manageable).
    • this would be data points spanning across all projects and data layers
    • should also be able to filter by user