oas.basic.v2.json

{
  "swagger": "2.0",
  "info": {
    "title": "MOTC Transport API V2",
    "description": "本平臺提供涵蓋全國尺度之公車、臺鐵、高鐵、捷運、航空、自行車等公共運輸旅運資料服務API，歡迎各產政學單位介接使用。\n                                                    <br><span class=swagger-description-indicatation>利用本平臺開放資料進行各項應用服務開發時，請考量不同特性使用者(如:性別/身心障礙/老幼等)的需求，並歡迎回饋寶貴意見。</span>\n                                                    <br><br>資料使用葵花寶典:[請點我](https://motc-ptx-api-documentation.gitbook.io/motc-ptx-api-documentation/)\n                                                    <br>資料服務開發實作參考手冊:[請點我](https://docs.google.com/viewer?url=https://github.com/ptxmotc/PTX_Web/blob/master/Swagger%E6%9C%8D%E5%8B%99%E8%AA%AA%E6%98%8E%E4%B8%8A%E5%82%B3%E5%8F%83%E8%80%83%E6%AA%94%E6%A1%88/%E5%85%AC%E5%85%B1%E9%81%8B%E8%BC%B8%E6%95%B4%E5%90%88%E8%B3%87%E8%A8%8A%E5%B9%B3%E5%8F%B0%E8%B3%87%E6%96%99%E6%9C%8D%E5%8B%99%E9%96%8B%E7%99%BC%E5%AF%A6%E4%BD%9C.pdf?raw=true)\n                                                    <br>API URI Convention文件說明:[請點我](https://docs.google.com/viewer?url=https://github.com/ptxmotc/PTX_Web/blob/master/Swagger%E6%9C%8D%E5%8B%99%E8%AA%AA%E6%98%8E%E4%B8%8A%E5%82%B3%E5%8F%83%E8%80%83%E6%AA%94%E6%A1%88/API_URI_Convention%E6%96%87%E4%BB%B6_v1.pdf?raw=true)",
    "version": "v2"
  },
  "host": "ptx.transportdata.tw",
  "basePath": "/MOTC",
  "schemes": [
    "https"
  ],
  "paths": {
    "/v2/Basic/Authority": {
      "get": {
        "tags": [
          "Common"
        ],
        "summary": "取得業管機關資料",
        "operationId": "BasicApi_Authority_2160",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "$select",
            "description": "挑選",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$filter",
            "description": "過濾",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$orderby",
            "description": "排序",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$top",
            "description": "取前幾筆",
            "type": "integer",
            "default": 30
          },
          {
            "in": "query",
            "name": "$skip",
            "description": "跳過前幾筆",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$format",
            "description": "指定來源格式",
            "required": true,
            "type": "string",
            "enum": [
              "JSON",
              "XML"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "title": "Array",
              "type": "array",
              "items": {
                "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.Authority"
              }
            }
          },
          "304": {
            "description": "服務端會在Response加上Last-Modified header，表示最近的更新時間。客戶端能利用此時間，於Request加上If-Modified-Since header，若沒有更新，服務端會回應304 StatusCode且空值Content"
          }
        }
      }
    },
    "/v2/Basic/Provider": {
      "get": {
        "tags": [
          "Common"
        ],
        "summary": "取得資料提供平台資料",
        "operationId": "BasicApi_Provider_2161",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "$select",
            "description": "挑選",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$filter",
            "description": "過濾",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$orderby",
            "description": "排序",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$top",
            "description": "取前幾筆",
            "type": "integer",
            "default": 30
          },
          {
            "in": "query",
            "name": "$skip",
            "description": "跳過前幾筆",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$format",
            "description": "指定來源格式",
            "required": true,
            "type": "string",
            "enum": [
              "JSON",
              "XML"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "title": "Array",
              "type": "array",
              "items": {
                "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.Provider"
              }
            }
          },
          "304": {
            "description": "服務端會在Response加上Last-Modified header，表示最近的更新時間。客戶端能利用此時間，於Request加上If-Modified-Since header，若沒有更新，服務端會回應304 StatusCode且空值Content"
          }
        }
      }
    },
    "/v2/Basic/Operator": {
      "get": {
        "tags": [
          "Common"
        ],
        "summary": "取得營運業者資料",
        "operationId": "BasicApi_Operator_2162",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "$select",
            "description": "挑選",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$filter",
            "description": "過濾",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$orderby",
            "description": "排序",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$top",
            "description": "取前幾筆",
            "type": "integer",
            "default": 30
          },
          {
            "in": "query",
            "name": "$skip",
            "description": "跳過前幾筆",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$format",
            "description": "指定來源格式",
            "required": true,
            "type": "string",
            "enum": [
              "JSON",
              "XML"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "title": "Array",
              "type": "array",
              "items": {
                "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.Operator"
              }
            }
          },
          "304": {
            "description": "服務端會在Response加上Last-Modified header，表示最近的更新時間。客戶端能利用此時間，於Request加上If-Modified-Since header，若沒有更新，服務端會回應304 StatusCode且空值Content"
          }
        }
      }
    },
    "/v2/PTX/Web/News": {
      "get": {
        "tags": [
          "Common"
        ],
        "summary": "取得PTX官網最新消息資料",
        "operationId": "WebSiteApi_News_2163",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "$select",
            "description": "挑選",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$filter",
            "description": "過濾",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$orderby",
            "description": "排序",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$top",
            "description": "取前幾筆",
            "type": "integer",
            "default": 30
          },
          {
            "in": "query",
            "name": "$skip",
            "description": "跳過前幾筆",
            "type": "string"
          },
          {
            "in": "query",
            "name": "$count",
            "description": "查詢數量",
            "type": "boolean",
            "enum": [
              true,
              false
            ]
          },
          {
            "in": "query",
            "name": "$format",
            "description": "指定來源格式",
            "required": true,
            "type": "string",
            "enum": [
              "JSON",
              "XML"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "$ref": "#/definitions/PTX.API.Basic.Model.V2.BasicWrapper[PTX.Service.DTO.Shared.Specification.V2.Base.News]"
            }
          },
          "304": {
            "description": "服務端會在Response加上Last-Modified header，表示最近的更新時間。客戶端能利用此時間，於Request加上If-Modified-Since header，若沒有更新，服務端會回應304 StatusCode且空值Content"
          }
        }
      }
    }
  },
  "definitions": {
    "PTX.API.Basic.Model.V2.BasicWrapper[PTX.Service.DTO.Shared.Specification.V2.Base.News]": {
      "title": "NewsList",
      "required": [
        "Newses",
        "UpdateInterval",
        "UpdateTime"
      ],
      "type": "object",
      "properties": {
        "UpdateTime": {
          "format": "date-time",
          "title": "DateTime",
          "description": "更新日期時間",
          "type": "string"
        },
        "UpdateInterval": {
          "format": "int32",
          "title": "Int32",
          "description": "資料更新週期(秒)",
          "type": "integer"
        },
        "Newses": {
          "title": "Array",
          "description": "資料(陣列)",
          "type": "array",
          "items": {
            "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.News"
          },
          "xml": {
            "name": "List`1"
          }
        },
        "Count": {
          "format": "int64",
          "type": "integer"
        }
      },
      "xml": {
        "name": "BasicWrapperOfNews",
        "namespace": "https://ptx.transportdata.tw/standard/schema/"
      }
    },
    "PTX.Service.DTO.Shared.Specification.V2.Base.Authority": {
      "title": "Authority",
      "description": "業管機關資料型別",
      "required": [
        "AuthorityCode",
        "AuthorityID",
        "AuthorityName",
        "UpdateTime"
      ],
      "type": "object",
      "properties": {
        "AuthorityID": {
          "title": "String",
          "description": "業管機關代碼",
          "type": "string",
          "xml": {
            "name": "AuthorityID"
          }
        },
        "AuthorityName": {
          "title": "NameType",
          "description": "業管機關名稱",
          "allOf": [
            {
              "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
            }
          ],
          "xml": {
            "name": "NameType"
          }
        },
        "AuthorityPhone": {
          "title": "String",
          "description": "業管機關連絡電話",
          "type": "string",
          "xml": {
            "name": "AuthorityPhone"
          }
        },
        "AuthorityEmail": {
          "title": "String",
          "description": "業管機關電子信箱",
          "type": "string",
          "xml": {
            "name": "AuthorityEmail"
          }
        },
        "AuthorityUrl": {
          "title": "String",
          "description": "業管機關網址鏈結",
          "type": "string",
          "xml": {
            "name": "AuthorityUrl"
          }
        },
        "AuthorityCode": {
          "title": "String",
          "description": "業管機關簡碼",
          "type": "string",
          "xml": {
            "name": "AuthorityCode"
          }
        },
        "UpdateTime": {
          "format": "date-time",
          "title": "DateTime",
          "description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
          "type": "string"
        }
      },
      "xml": {
        "name": "Authority"
      }
    },
    "PTX.Service.DTO.Shared.Specification.V2.Base.NameType": {
      "title": "NameType",
      "description": "名稱資料型別",
      "type": "object",
      "properties": {
        "Zh_tw": {
          "title": "String",
          "description": "中文繁體名稱",
          "type": "string",
          "xml": {
            "name": "Zh_tw"
          }
        },
        "En": {
          "title": "String",
          "description": "英文名稱",
          "type": "string",
          "xml": {
            "name": "En"
          }
        }
      },
      "xml": {
        "name": "NameType"
      }
    },
    "PTX.Service.DTO.Shared.Specification.V2.Base.News": {
      "title": "News",
      "description": "業管機關資料型別",
      "required": [
        "Description",
        "Language",
        "NewsID"
      ],
      "type": "object",
      "properties": {
        "NewsID": {
          "format": "uuid",
          "title": "Guid",
          "description": "最新消息原單位發布代碼",
          "type": "string"
        },
        "Language": {
          "title": "String",
          "description": "語系",
          "type": "string",
          "xml": {
            "name": "Language"
          }
        },
        "Department": {
          "title": "String",
          "description": "發布單位",
          "type": "string",
          "xml": {
            "name": "Department"
          }
        },
        "Title": {
          "title": "String",
          "description": "消息標題",
          "type": "string",
          "xml": {
            "name": "Title"
          }
        },
        "NewsCategory": {
          "title": "Int32",
          "description": "消息類別 : [1:'最新消息',2:'新聞稿',3:'營運資訊',4:'轉乘資訊',5:'活動訊息',6:'系統公告',7:'新服務上架',8:'API修正',9:'來源異常',10:'資料更新',99:'其他']",
          "type": "integer"
        },
        "Description": {
          "title": "String",
          "description": "內容描述",
          "type": "string",
          "xml": {
            "name": "Description"
          }
        },
        "NewsURL": {
          "title": "String",
          "description": "報導網站連結",
          "type": "string",
          "xml": {
            "name": "NewsURL"
          }
        },
        "AttachmentURL": {
          "title": "String",
          "description": "相關網站連結",
          "type": "string",
          "xml": {
            "name": "AttachmentURL"
          }
        },
        "PublishTime": {
          "format": "date-time",
          "description": "消息公告日期時間",
          "type": "string"
        },
        "StartTime": {
          "format": "date-time",
          "description": "開始時間",
          "type": "string"
        },
        "EndTime": {
          "format": "date-time",
          "description": "結束時間",
          "type": "string"
        },
        "UpdateTime": {
          "format": "date-time",
          "title": "DateTime",
          "description": "消息更新時間",
          "type": "string"
        }
      },
      "xml": {
        "name": "News"
      }
    },
    "PTX.Service.DTO.Shared.Specification.V2.Base.Operator": {
      "title": "Operator",
      "description": "營運業者資料型別",
      "required": [
        "AuthorityCode",
        "OperatorCode",
        "OperatorID",
        "OperatorName",
        "OperatorNo",
        "ProviderID",
        "UpdateTime"
      ],
      "type": "object",
      "properties": {
        "ProviderID": {
          "title": "String",
          "description": "資料提供平台代碼",
          "type": "string",
          "xml": {
            "name": "ProviderID"
          }
        },
        "OperatorID": {
          "title": "String",
          "description": "營運業者代碼",
          "type": "string",
          "xml": {
            "name": "OperatorID"
          }
        },
        "OperatorName": {
          "title": "NameType",
          "description": "營運業者名稱",
          "allOf": [
            {
              "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
            }
          ],
          "xml": {
            "name": "NameType"
          }
        },
        "OperatorPhone": {
          "title": "String",
          "description": "營運業者連絡電話",
          "type": "string",
          "xml": {
            "name": "OperatorPhone"
          }
        },
        "OperatorEmail": {
          "title": "String",
          "description": "營運業者電子信箱",
          "type": "string",
          "xml": {
            "name": "OperatorEmail"
          }
        },
        "OperatorUrl": {
          "title": "String",
          "description": "營運業者網址鏈結",
          "type": "string",
          "xml": {
            "name": "OperatorUrl"
          }
        },
        "ReservationUrl": {
          "title": "String",
          "description": "訂票網址鏈結",
          "type": "string",
          "xml": {
            "name": "ReservationUrl"
          }
        },
        "ReservationPhone": {
          "title": "String",
          "description": "訂票連絡電話",
          "type": "string",
          "xml": {
            "name": "ReservationPhone"
          }
        },
        "OperatorCode": {
          "title": "String",
          "description": "營運業者簡碼",
          "type": "string",
          "xml": {
            "name": "OperatorCode"
          }
        },
        "AuthorityCode": {
          "title": "String",
          "description": "營運業者業管機關簡碼(對於於公路客運/國道客運而言為THB)",
          "type": "string",
          "xml": {
            "name": "AuthorityCode"
          }
        },
        "SubAuthorityCode": {
          "title": "String",
          "description": "營運業者所屬業管子機關簡碼(對於公路客運/國道客運路線而言為區監理所如THB-VO10-1..等)",
          "type": "string",
          "xml": {
            "name": "SubAuthorityCode"
          }
        },
        "OperatorNo": {
          "title": "String",
          "description": "營運業者編號[交通部票證資料系統定義]",
          "type": "string",
          "xml": {
            "name": "OperatorNo"
          }
        },
        "UpdateTime": {
          "format": "date-time",
          "title": "DateTime",
          "description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
          "type": "string"
        }
      },
      "xml": {
        "name": "Operator"
      }
    },
    "PTX.Service.DTO.Shared.Specification.V2.Base.Provider": {
      "title": "Provider",
      "description": "資料提供平台資料型別",
      "required": [
        "ProviderCode",
        "ProviderID",
        "ProviderName",
        "UpdateTime"
      ],
      "type": "object",
      "properties": {
        "ProviderID": {
          "title": "String",
          "description": "資料提供平台代碼",
          "type": "string",
          "xml": {
            "name": "ProviderID"
          }
        },
        "ProviderName": {
          "title": "NameType",
          "description": "資料提供平台名稱",
          "allOf": [
            {
              "$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
            }
          ],
          "xml": {
            "name": "NameType"
          }
        },
        "ProviderPhone": {
          "title": "String",
          "description": "資料提供平台連絡電話",
          "type": "string",
          "xml": {
            "name": "ProviderPhone"
          }
        },
        "ProviderEmail": {
          "title": "String",
          "description": "資料提供平台電子信箱",
          "type": "string",
          "xml": {
            "name": "ProviderEmail"
          }
        },
        "ProviderUrl": {
          "title": "String",
          "description": "資料提供平台網址鏈結",
          "type": "string",
          "xml": {
            "name": "ProviderUrl"
          }
        },
        "UpdateTime": {
          "format": "date-time",
          "title": "DateTime",
          "description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
          "type": "string"
        },
        "ProviderCode": {
          "title": "String",
          "description": "資料提供平台簡碼",
          "type": "string",
          "xml": {
            "name": "ProviderCode"
          }
        }
      },
      "xml": {
        "name": "Provider"
      }
    }
  },
  "securityDefinitions": {
    "AppID": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header",
      "description": "Specify the authorization token."
    },
    "AppKey": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header",
      "description": "Specify the authorization token."
    }
  },
  "security": [
    {
      "AppID": [],
      "AppKey": []
    }
  ],
  "tags": [
    {
      "name": "Common",
      "description": "共通資料(公共運輸)"
    }
  ]
}