SmartTrips API spec draft

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

1. Think the URL should include employers since they're authenticating to log trips for other users; otherwise it'll be confusing if we add an individual API
2. Would like to make trip_purpose option and default it to work (since 99% of API requests will be work. Maybe 100%. Maybe more.)

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