Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

Create API call to access the data in JSON/GeoJSON/XML format by passing in things like bounding box, start and end time, Jam fields, Alert types, etc. #20

Open
schnuerle opened this issue Mar 12, 2018 · 2 comments
Assignees
Labels
In Progress Currently being worked on Phase 3 API API calls to get data out in chunks for integrations v3.0

Comments

@schnuerle
Copy link
Contributor

schnuerle commented Mar 12, 2018

  • Allows easy access to chunks of data from the DB
  • Proof of concept limited for use of Interactive Map
  • Good to get developer buy-in, service integrations

Technical: HTTP endpoint would return GeoJSON file from DB. Parameters include start date/time, end date/time, lat/lon bounding box, Waze categories (Jam types, Alert types, Irregularities).

Examples:

List of reports
https://endpoint.com/api/waze/reports?startdate=2018-02-17&enddate=2018-02-19&starttime=1600&endtime=1800&minlat=37.9971&maxlat=38.38051&minlon=-85.948441&maxlon=-85.4051&jams=2,3,4&alerttypes=ACCIDENT_MAJOR,JAM_STAND_STILL_TRAFFIC,HAZARD_ON_SHOULDER_CAR_STOPPED&irregularity=0&roadtypes=3,5,8,9&streetname=&delay=&speed=&length=&format=json

Detailed data on a single report
https://endpoint.com/api/waze/reportdetail?reportid=FB6E701F-E8A6-3667-BC5A-434A593E5C76&format=json

Geodata (line or point) on a single report
https://endpoint.com/api/waze/segmentgeo?reportid=FB6E701F-E8A6-3667-BC5A-434A593E5C76&format=json

@schnuerle schnuerle created this issue from a note in Phase 3 - API Creation (Read-Only API RDS Access) Mar 12, 2018
@schnuerle schnuerle added the Phase 3 API API calls to get data out in chunks for integrations label Mar 13, 2018
@schnuerle
Copy link
Contributor Author

We've started work defining how to create the API endpoints and some of the details.

Going with Node.js for the Lambda functions connected to the API Gateway.

Here is the Google Doc with details. If you'd like edit access, let me know. Or you can leave comments in the doc, or comments here.

https://docs.google.com/document/d/1cBxnD_J3w6YTmYsVTlWfzbvPLaQW6vfDfQF_o1X6ECA/

@schnuerle schnuerle added the In Progress Currently being worked on label May 16, 2018
@schnuerle
Copy link
Contributor Author

Follow the API coding process here: https://github.com/igNew/WazeCCPProcessor/commits/feature/basic-api

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
In Progress Currently being worked on Phase 3 API API calls to get data out in chunks for integrations v3.0
Projects
Phase 3 - API Creation
Read-Only API RDS Access
Development

No branches or pull requests

2 participants