chicago-divvy-bike-rental-platform

This is REST API for the Chicago Divvy Bike Rental platform using the Divvy API and the provided trip data.

Local Install

npm install --save

Security Tokens

The Authorization for APIs is provided using 20 character token based mechanism. The following security tokens should be used when calling APIs

Environment	Token
Dev	jjn1qwgxgca3mwr839nx
QA	jjn1qwgxgca3mwr839nx

Dependencies

CLI
- CLI is Command Line Interface otherwise known as Command Prompt, Powershell, Git Bash, Git Shell, Git Terminal
Node.js
- Install Node version v12.14.1
  - Visit official website and "Install" (not "Download")
- Verify
  - Open CLI
  - Run node -v
  - Expect a version number
Dev local setup
- Install
  - Open CLI as Administrator
  - Change directory to the web site root
  - Run npm --save i
- Verify
  - Open CLI
  - Run npm start

Commands

To run the server navigate into the directory and use,

node main.js

OR

npm start

Usage

There are 3 endpoints:

stations
trips
riders

stations:

This endpoint takes station_id as input and returns the information for one station given a station id

curl -X GET \
  'http://localhost:3000/stations?station_id=a3a6d371-a135-11e9-9cda-0a87ae2ba916' \
  -H 'authorization: jjn1qwgxgca3mwr839nx' \

In the above curl call the station_id provided is 5, the endpoint will return with the response below,

{
    "statusCode": 200,
    "records": [
        {
            "lon": -87.627716,
            "rental_methods": [
                "CREDITCARD",
                "TRANSITCARD",
                "KEY"
            ],
            "lat": 41.874053,
            "eightd_station_services": [],
            "electric_bike_surcharge_waiver": false,
            "station_type": "classic",
            "short_name": "SL-007",
            "capacity": 23,
            "name": "State St & Harrison St",
            "eightd_has_key_dispenser": false,
            "external_id": "a3a37e26-a135-11e9-9cda-0a87ae2ba916",
            "rental_uris": {
                "android": "https://chi.lft.to/lastmile_qr_scan",
                "ios": "https://chi.lft.to/lastmile_qr_scan"
            },
            "has_kiosk": true,
            "station_id": "a3a6d371-a135-11e9-9cda-0a87ae2ba916"
        }
    ]
}

trips:

Given one or more stations, return the number of riders in the following age groups, [0-20,21-30,31-40,41-50,51+, unknown], who ended their trip at that station for a given day.

curl -X GET \
  'http://localhost:3000/trips?stations=89%2C90%2C91%2C92%2C93%2C94&date=4%2F3%2F2019' \
  -H 'authorization: jjn1qwgxgca3mwr839nx' \

In the above curl call the query string contains station_ids provided comma separated and a date string in MM/DD/YYYY format, the endpoint will return with the response below,

{
    "statusCode": 200,
    "records": {
        "0-20": 0,
        "21-30": 28,
        "31-40": 7,
        "41-50": 4,
        "51+": 11,
        "unknown": 0
    }
}

riders:

This endpoint given one or more stations, return the last 20 trips that ended at each station for a single day(given day)

curl -X GET \
  'http://localhost:3000/trips?stations=92%2C93%2C94&date=4%2F3%2F2019' \
  -H 'authorization: jjn1qwgxgca3mwr839nx' \