amiel/smarttrips_api_spec.md

Last active December 18, 2015 03:29

Star (0) You must be signed in to star a gist
Fork (1) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/amiel/5718462.js"></script>
Save amiel/5718462 to your computer and use it in GitHub Desktop.

Download ZIP

SmartTrips API spec draft

Raw

smarttrips_api_spec.md

API Spec

`POST /api/employers/trips`

requires HTTP Basic authorization

Attributes

user_email -- users email required
trip_mode -- trip mode identifier required (see trip_mode options below)
trip_purpose -- trip purpose identifier optional (see trip_purpose options below)
trip_distance -- trip distance in miles required

`trip_mode` options

walk
bike
bus
rideshare

`trip_purpose` options

work - default
errands
leisure
school

Example request

curl --data "[email protected]&trip_mode=walk&trip_purpose=work&trip_distance=2.3" \
  -u 1f3a284920d579e01deafc80ca1911bbc0cfb000:c0334cbd11b78dcac2439bfe938055bc07a7092f \
  https://whatcomsmarttrips.org/api/employers/trips

Author

amiel commented Jun 6, 2013

Ok, I've updated the spec as per your suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

amiel/smarttrips_api_spec.md

API Spec

POST /api/employers/trips

Attributes

trip_mode options

trip_purpose options

Example request

amiel commented Jun 6, 2013

Uh oh!

`POST /api/employers/trips`

`trip_mode` options

`trip_purpose` options