Skip to content

Latest commit

 

History

History
513 lines (449 loc) · 12.5 KB

docs.md

File metadata and controls

513 lines (449 loc) · 12.5 KB
Raw

API Documentation

REST API Endpoints

Users

All user actions require for an Authorization Token to be set.

GET /api/users/1

request:

curl -XGET localhost:3000/api/users/1 -H "Authorization:Token token=lanebreach"

response:

{"id":2,"first_name":null,"last_name":null,"email":"[email protected]","token":"hmm","handle":"sda","created_at":"2019-06-21T07:21:49.247Z","updated_at":"2019-06-21T07:21:49.247Z"}

POST /api/users

request:

curl -XPOST localhost:3000/api/users -d '{"user": {"email": "[email protected]"}}' -H 'Content-Type: application/json' -H "Authorization:Token token=lanebreach"

response:

{"id":2,"first_name":null,"last_name":null,"email":"[email protected]","token":"hmm","handle":"sda","created_at":"2019-06-21T07:21:49.247Z","updated_at":"2019-06-21T07:21:49.247Z"}

PUT /api/users/1

request:

curl -XPUT localhost:3000/api/users/1 -d '{"user": {"email": "[email protected]"}}' -H 'Content-Type: application/json' -H "Authorization:Token token=lanebreach"

response:

{"id":2,"first_name":null,"last_name":null,"email":"[email protected]","token":"hmm","handle":"sda","created_at":"2019-06-21T07:21:49.247Z","updated_at":"2019-06-21T07:21:49.247Z"}

Case Requests

All case request actions require for an Authorization Token to be set.

GET /api/case_requests

request:

curl -XGET localhost:3000/api/case_requests/counts?days_back=0 -H "Authorization:Token token=lanebreach"

response:

[{"user_id":2,"user_handle":null,"case_request_count":5},{"user_id":1,"user_handle":"sda","case_request_count":1}]

POST /api/case_requests

request:

curl -XPOST localhost:3000/api/case_requests -d '{"case_request": {"user_id": 2}}' -H 'Content-Type: application/json' -H "Authorization:Token token=lanebreach"

response:

{"id":3,"user_id":2,"meta":null,"created_at":"2019-06-21T19:30:23.837Z","updated_at":"2019-06-21T19:30:23.837Z"}

Bikeway Networks

GET /api/bikeway_networks

request:

curl -XGET https://lane-breach.herokuapp.com/api/bikeway_networks?lat=37.74675537&long=-122.4587284

response:

{
  "id": 648,
  "barrier": null,
  "biap": "NO",
  "buffered": "NO",
  "cnn": "7992201.0",
  "contraflow": "NO",
  "date_creat": null,
  "time_creat": null,
  "created_us": null,
  "dir": null,
  "direct": "2W",
  "double": "1.0",
  "facility_t": "CLASS II",
  "from_st": "WOODSIDE AV",
  "fy": "0.0",
  "globalid": "{BB75CA5B-E5CC-4D8A-86B6-F8FB936A34F1}",
  "greenwave": "NO",
  "install_mo": null,
  "install_yr": "2010.0",
  "date_last_": "2017-10-18",
  "time_last_": "15:54:08.000",
  "last_edite": "JENWONG",
  "length": "0.01",
  "notes": null,
  "number": "65",
  "objectid": "4056.0",
  "qtr": "0.0",
  "raised": "NO",
  "shape_len": "35.624799522670095",
  "sharrow": "0.0",
  "sm_sweeper": "NO",
  "street": null,
  "streetname": "LAGUNA HONDA BLVD",
  "surface_tr": null,
  "symbology": "BIKE LANE",
  "to_st": "MERCED AV",
  "update_mo": null,
  "update_yr": "0.0",
  "geom": "MULTILINESTRING ((-122.458728517664 37.746755430012, -122.458661449047 37.746673365426))",
  "dist": 0.00506722
}

request:

curl -XGET https://lane-breach.herokuapp.com/api/bikeway_networks?lat=-122.4587284&long=37.74675537

response:

null

GET /api/bikeway_networks/ID

request:

curl -XGET https://lane-breach.herokuapp.com/api/bikeway_networks/4150

response:

{
  "id": 648,
  "barrier": null,
  "biap": "NO",
  "buffered": "NO",
  "cnn": "7992201.0",
  "contraflow": "NO",
  "date_creat": null,
  "time_creat": null,
  "created_us": null,
  "dir": null,
  "direct": "2W",
  "double": "1.0",
  "facility_t": "CLASS II",
  "from_st": "WOODSIDE AV",
  "fy": "0.0",
  "globalid": "{BB75CA5B-E5CC-4D8A-86B6-F8FB936A34F1}",
  "greenwave": "NO",
  "install_mo": null,
  "install_yr": "2010.0",
  "date_last_": "2017-10-18",
  "time_last_": "15:54:08.000",
  "last_edite": "JENWONG",
  "length": "0.01",
  "notes": null,
  "number": "65",
  "objectid": "4056.0",
  "qtr": "0.0",
  "raised": "NO",
  "shape_len": "35.624799522670095",
  "sharrow": "0.0",
  "sm_sweeper": "NO",
  "street": null,
  "streetname": "LAGUNA HONDA BLVD",
  "surface_tr": null,
  "symbology": "BIKE LANE",
  "to_st": "MERCED AV",
  "update_mo": null,
  "update_yr": "0.0",
  "geom": "MULTILINESTRING ((-122.458728517664 37.746755430012, -122.458661449047 37.746673365426))",
  "dist": 0.00506722
}

SF 311 Cases

GET /api/sf311_cases

request:

curl -XGET https://lane-breach.herokuapp.com/api/sf311_cases?start_time=2018-6-15&end_time=2018-6-17

page and per_page query string parameters can also be specified for paging through the result set. The default page size is 30 items.

response:

{
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "total_pages": 12,
    "total_count": 354,
    "items_per_page": 30
  },
  "data": [
    {
      "id": 375,
      "service_request_id": 9875356,
      "requested_datetime": "2018-12-01T00:51:00.000Z",
      "closed_date": "2018-12-01T00:53:38.000Z",
      "updated_datetime": "2018-12-01T00:53:38.000Z",
      "status_description": "Closed",
      "status_notes": "The report has been logged and will help the City collect data on double parking and bike lane violations to determine target areas and future enforcement efforts. Thank you.",
      "agency_responsible": "Parking Enforcement Dispatch Queue",
      "service_name": "Parking Enforcement",
      "service_subtype": "Blocking_Bicycle_Lane",
      "service_details": "White - Toyota Camry - NA",
      "address": "1842 LAKE ST, SAN FRANCISCO, CA, 94121",
      "supervisor_district": 2,
      "neighborhoods_sffind_boundaries": "Lake Street",
      "police_district": "RICHMOND",
      "lat": 37.78612137,
      "long": -122.47961426,
      "source": "Phone",
      "media_url": null,
      "meta_data": {
        "bikeway_network_id": 4277
      }
    },
    ...
  ]
}

POST /api/sf311_cases

request:

curl -XPOST https://lane-breach.herokuapp.com/api/sf311_cases -H "Content-Type: application/json" -d
  '{
    "sf311_case": {
      "address": "326 14TH ST, SAN FRANCISCO, CA, 94103",
      "agency_responsible": "Parking Enforcement Review Queue",
      "lat": "37.76826",
      "long": "-122.4205",
      "neighborhoods_sffind_boundaries": "Mission",
      "police_district": "MISSION",
      "requested_datetime": "2018-07-11T16:41:59.000",
      "service_details": "Cream - Shitty new 2000s model vw bug - 6ncv876",
      "service_subtype": "Blocking_Bicycle_Lane",
      "source": "Mobile/Open311",
      }
    }'

response:

TBD

SF MTA Ridership Counts

GET /api/sf_mta_ridership_counts

request:

curl -XGET https://lane-breach.herokuapp.com/api/sf_mta_ridership_counts?year_of_collection_time=2016&day=weekday&order_by=total_bike_count

Supported query string parameters include year_of_collection_time, month_of_collection_time, hour_of_collection_time, total_bike_count, counter_location and days. See the example API response for the expected value types for these parameters.

When an order_by parameter is specified, a sort_order (asc or desc) can also be included.

response:

{
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "total_pages": 1800,
    "total_count": 54000,
    "items_per_page": 30
  },
  "data": [
    {
      "counter_location": "17th St East of Hoff St",
      "days": "WEEKDAY",
      "hour_of_collection_time": 10,
      "month_of_collection_time": "February",
      "year_of_collection_time": 2016,
      "total_bike_count": 998
    },
    {
      "counter_location": "Polk St South of Sutter St",
      "days": "WEEKDAY",
      "hour_of_collection_time": 20,
      "month_of_collection_time": "February",
      "year_of_collection_time": 2016,
      "total_bike_count": 998
    },
    ...
  ]
}

GraphQL API Endpoints

If you haven't used GraphQL before, be sure to skim through the documentation so you can hit the ground running.

The simplest way to run and test GraphQL queries is to use the GraphiQL interface. We'd normally rernder the GraphiQL console in browser, but this is an API-only application; instead, you can use the Electron based graphiql-app wrapper for running queries.

Bikeway Networks

Retreiving the nearest bikeway network

request:

{
  nearest_bikeway_network(lat: 37.74675537, long: -122.4587284) {
    install_yr
    symbology
    streetname
  }
}

response:

{
  "data": {
    "nearest_bikeway_network": [
      {
        "install_yr": 2010,
        "symbology": "BIKE LANE",
        "streetname": "LAGUNA HONDA BLVD"
      }
    ]
  }
}

SF 311 Cases

Fetch the first 5 cases that took place between April and October 2018

request:

{
  sf311_cases_connection(start_time: "2018-4-1", end_time: "2018-10-22", first: 5) {
    totalCount
    
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
    
    edges {
      node {
        service_request_id
        address
        requested_datetime

        sf311_case_metadatum {
          bikeway_network_id
        }
      }
    }	
  }
}

response:

{
  "data": {
    "sf311_cases_connection": {
      "totalCount": 32,
      "pageInfo": {
        "startCursor": "MQ==",
        "endCursor": "NQ==",
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "edges": [
        {
          "node": {
            "service_request_id": "9144235",
            "address": "Intersection of JOHN F KENNEDY DR and TRANSVERSE DR",
            "requested_datetime": "2018-06-16T06:55:38Z",
            "sf311_case_metadatum": {
              "bikeway_network_id": 2660
            }
          }
        },
        {
          "node": {
            "service_request_id": "9145772",
            "address": "2927 FOLSOM ST, SAN FRANCISCO, CA, 94110",
            "requested_datetime": "2018-06-16T15:14:02Z",
            "sf311_case_metadatum": {
              "bikeway_network_id": 741
            }
          }
        },
        {
          "node": {
            "service_request_id": "9514241",
            "address": "1710 MARKET ST, SAN FRANCISCO, CA, 94102",
            "requested_datetime": "2018-09-08T17:21:19Z",
            "sf311_case_metadatum": {
              "bikeway_network_id": 3384
            }
          }
        },
        {
          "node": {
            "service_request_id": "9692741",
            "address": "45 11TH ST, SAN FRANCISCO, CA, 94103",
            "requested_datetime": "2018-10-19T08:36:36Z",
            "sf311_case_metadatum": {
              "bikeway_network_id": 1132
            }
          }
        },
        {
          "node": {
            "service_request_id": "9692999",
            "address": "1810 CESAR CHAVEZ ST, SAN FRANCISCO, CA, 94124",
            "requested_datetime": "2018-10-19T09:12:00Z",
            "sf311_case_metadatum": {
              "bikeway_network_id": 1563
            }
          }
        }
      ]
    }
  }
}

SF MTA Ridership Counts

Fetch the location, bike count year and month of the top 3 ridership count records

request:

{
  sf_mta_ridership_counts_connection(order_by: total_bike_count, first: 3) {
    totalCount
    
    edges {
      node {
        total_bike_count
        counter_location
        year_of_collection_time
        month_of_collection_time        
      }
    }	
  }
}

response:

{
  "data": {
    "sf_mta_ridership_counts_connection": {
      "totalCount": 108816,
      "edges": [
        {
          "node": {
            "total_bike_count": 998,
            "counter_location": "17th St East of Hoff St",
            "year_of_collection_time": 2016,
            "month_of_collection_time": "February"
          }
        },
        {
          "node": {
            "total_bike_count": 998,
            "counter_location": "JFK West of Conservatory Dr. West",
            "year_of_collection_time": 2017,
            "month_of_collection_time": "June"
          }
        },
        {
          "node": {
            "total_bike_count": 998,
            "counter_location": "Marina Bike Path East of Baker St.",
            "year_of_collection_time": 2017,
            "month_of_collection_time": "October"
          }
        }
      ]
    }
  }
}

See the documentation on paging and connections for more details.