kinlane
8/27/2018 - 3:44 AM

san-francisco-511-openapi

san-francisco-511-openapi

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "San Francisco 511",
    "description": "Open511 aims to create simple, uniform and resource driven APIs that can be easily used by consumers to retrieve data from 511.org. Using the new API is designed to be as simple as possible, and is available to all. Users of the API are required to obtain access tokens and must send those tokens as part of their request."
  },
  "host": "api.511.org",
  "basePath": "/transit",
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/operators": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Operatorators API",
        "operationId": "OperatorsGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/VehicleMonitoring": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Vehicle Monitoring API",
        "operationId": "VehicleMonitoringGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "agency",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "stopCode",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/stopPlaces": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Stop Places API",
        "operationId": "StopPlacesGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "operator_id",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/GeneralAnnouncements": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 General Announcements API",
        "operationId": "GeneralAnnouncementsGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/stoptimetable": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Stop Timetable API",
        "operationId": "StoptimetableGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "MonitoringRef",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          },
          {
            "name": "OperatorRef",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/StopMonitoring": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Stop Monitoring API",
        "operationId": "StopMonitoringGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "agency",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "stopCode",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/stops": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Stops API",
        "operationId": "StopsGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "operator_id",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/patterns": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Transit Patterns API",
        "operationId": "PatternsGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "operator_id",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "pattern_id",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    },
    "/lines": {
      "get": {
        "description": "",
        "summary": "San Francisco 511 Transit Lines API",
        "operationId": "LinesGet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "operator_id",
            "in": "query",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "security": []
      }
    }
  }
}