Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 3.41 KB

README.md

File metadata and controls

90 lines (63 loc) · 3.41 KB
Raw

Trolley Tracker

A Code for Fort Lauderdale project that updates and pushes city trolley location in real time. Built on Node, Express, and MongoDB.

Concept

Trolley Tracker stores geospatial and speed information for a public city trolley.

Get Trolley Locations

Method: GET. Returns the 10 most recent trolley data events. Returns data with the bustime property descending with a limit set for the most recent results.

http://trolley-tracker.herokuapp.com/api/trolleys

Query parameters:

Parameter Description Type Default Value Required
limit The number of results returned number 10 No
deviceid The deviceId of the instrument on the trolly that collected the data mixed null Yes

Response structure:

  • type (string) - Type of data set
  • features (object) - A collection of trolley data objects
    • type (string) - Feature type
    • geometry (string) - Geospatial data container
      • type (string) - Type of geospatial data
      • coordinates (array) [longitude, latitude]
    • properties (object) Misc data container
      • lat (number) Latitude
      • lon (number) Longitude
      • bustime (date) Datetime object in UTC
      • speed (number) Trolley speed
      • deviceid (mixed) Id of data collection device
  • metadata
    • status (string) - Either 'success' or 'error'
    • message (string) - Description of error response

Examples

Returns the latest trolley event object

http://trolley-tracker.herokuapp.com/api/trolleys?limit=1

Returns only the latest 10 entries from deviceid 1

http://trolley-tracker.herokuapp.com/api/trolleys?deviceid=1

Returns the latest 20 entries from deviceid 4

http://trolley-tracker.herokuapp.com/api/trolleys?limit=20&deviceid=4

Post Trolley Location

Method: POST. Accepts query parameters.

http://trolley-tracker.herokuapp.com/api/trolleys/post?lon=-80.148749&lat=26.203733&speed=40&deviceid=4

Query parameters:

Parameter Description Type Default Value Required
lon Longitude number null Yes
lat Latitude number null Yes
speed Speed of trolley number null Yes
deviceid Id of device mixed null Yes

Response structure:

Same as GET index.

Example

http://trolley-tracker.herokuapp.com/api/trolleys/post?lon=-80.148749&lat=26.203733&speed=40&deviceid=trolley-4

Delete Trolley Database

Method: DELETE. Requires a predefined token that is stored on the server in the config file as a parameter in production.

http://trolley-tracker.herokuapp.com/api/trolleys/delete?token=delete-all-the-things

In production on a Heroku server, at https://dashboard.heroku.com/apps/{my-app}/settings add a config var DELETE_TOKEN to a secret string. Or, in a command line interface with a Heroku app initiated, type heroku config:set DELETE_TOKEN=my-super-duper-secret-delete-token.

Query parameters:

Parameter Description Type Default Value Required
token The secret token to authenticate the delete request string null Yes

###Example http://trolley-tracker.herokuapp.com/api/trolleys/delete?token=my-super-duper-secret-delete-token

Response structure:

  • metadata
    • status (string) - Either 'success' or 'error'
    • message (string) - Description of error response