This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathoas.basic.v2.json
619 lines (619 loc) · 17.6 KB
/
oas.basic.v2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
{
"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)<br>資料文本OAS描述:[請點我](https://ptx.transportdata.tw/MOTC/v2/Basic/api-docs/oas)",
"version": "v2"
},
"host": "ptx.transportdata.tw",
"basePath": "/MOTC",
"schemes": [
"https"
],
"paths": {
"/v2/Basic/Authority": {
"get": {
"tags": [
"Basic"
],
"summary": "取得業管機關資料",
"operationId": "BasicApi_Authority",
"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"
}
}
}
}
}
},
"/v2/Basic/Provider": {
"get": {
"tags": [
"Basic"
],
"summary": "取得資料提供平台資料",
"operationId": "BasicApi_Provider",
"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"
}
}
}
}
}
},
"/v2/Basic/Operator": {
"get": {
"tags": [
"Basic"
],
"summary": "取得營運業者資料",
"operationId": "BasicApi_Operator",
"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"
}
}
}
}
}
},
"/v2/PTX/Web/News": {
"get": {
"tags": [
"Basic"
],
"summary": "取得PTX官網最新消息資料",
"operationId": "WebSiteApi_News",
"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]"
}
}
}
}
}
},
"definitions": {
"PTX.Service.DTO.Shared.Specification.V2.Base.NameType": {
"title": "NameType",
"description": "名稱資料型別",
"type": "object",
"properties": {
"Zh_tw": {
"title": "String",
"description": "中文繁體名稱",
"type": "string"
},
"En": {
"title": "String",
"description": "英文名稱",
"type": "string"
}
}
},
"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"
},
"AuthorityName": {
"title": "NameType",
"description": "業管機關名稱",
"allOf": [
{
"$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
}
]
},
"AuthorityPhone": {
"title": "String",
"description": "業管機關連絡電話",
"type": "string"
},
"AuthorityEmail": {
"title": "String",
"description": "業管機關電子信箱",
"type": "string"
},
"AuthorityUrl": {
"title": "String",
"description": "業管機關網址鏈結",
"type": "string"
},
"AuthorityCode": {
"title": "String",
"description": "業管機關簡碼",
"type": "string"
},
"UpdateTime": {
"title": "DateTime",
"description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
"type": "string"
}
}
},
"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"
},
"Department": {
"title": "String",
"description": "發布單位",
"type": "string"
},
"Title": {
"title": "String",
"description": "消息標題",
"type": "string"
},
"NewsCategory": {
"format": "int32",
"title": "integer",
"description": "消息類別 : [1:'最新消息',2:'新聞稿',3:'營運資訊',4:'轉乘資訊',5:'活動訊息',6:'系統公告',7:'新服務上架',8:'API修正',9:'來源異常',99:'其他']",
"type": "integer"
},
"Description": {
"title": "String",
"description": "內容描述",
"type": "string"
},
"NewsURL": {
"title": "String",
"description": "報導網站連結",
"type": "string"
},
"AttachmentURL": {
"title": "String",
"description": "相關網站連結",
"type": "string"
},
"PublishTime": {
"title": "DateTime",
"description": "消息公告日期時間",
"type": "string"
},
"StartTime": {
"title": "DateTime",
"description": "開始時間",
"type": "string"
},
"EndTime": {
"title": "DateTime",
"description": "結束時間",
"type": "string"
},
"UpdateTime": {
"title": "DateTime",
"description": "消息更新時間",
"type": "string"
}
}
},
"PTX.API.Basic.Model.V2.BasicWrapper[PTX.Service.DTO.Shared.Specification.V2.Base.News]": {
"title": "NewsList",
"required": [
"Newses",
"UpdateInterval",
"UpdateTime"
],
"type": "object",
"properties": {
"UpdateTime": {
"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"
}
},
"Count": {
"format": "int64",
"type": "integer"
}
}
},
"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"
},
"OperatorID": {
"title": "String",
"description": "營運業者代碼",
"type": "string"
},
"OperatorName": {
"title": "NameType",
"description": "營運業者名稱",
"allOf": [
{
"$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
}
]
},
"OperatorPhone": {
"title": "String",
"description": "營運業者連絡電話",
"type": "string"
},
"OperatorEmail": {
"title": "String",
"description": "營運業者電子信箱",
"type": "string"
},
"OperatorUrl": {
"title": "String",
"description": "營運業者網址鏈結",
"type": "string"
},
"ReservationUrl": {
"title": "String",
"description": "訂票網址鏈結",
"type": "string"
},
"ReservationPhone": {
"title": "String",
"description": "訂票連絡電話",
"type": "string"
},
"OperatorCode": {
"title": "String",
"description": "營運業者簡碼",
"type": "string"
},
"AuthorityCode": {
"title": "String",
"description": "營運業者業管機關簡碼(對於於公路客運/國道客運而言為THB)",
"type": "string"
},
"SubAuthorityCode": {
"title": "String",
"description": "營運業者所屬業管子機關簡碼(對於公路客運/國道客運路線而言為區監理所如THB-VO10-1..等)",
"type": "string"
},
"OperatorNo": {
"title": "String",
"description": "營運業者編號[交通部票證資料系統定義]",
"type": "string"
},
"UpdateTime": {
"title": "DateTime",
"description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
"type": "string"
}
}
},
"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"
},
"ProviderName": {
"title": "NameType",
"description": "資料提供平台名稱",
"allOf": [
{
"$ref": "#/definitions/PTX.Service.DTO.Shared.Specification.V2.Base.NameType"
}
]
},
"ProviderPhone": {
"title": "String",
"description": "資料提供平台連絡電話",
"type": "string"
},
"ProviderEmail": {
"title": "String",
"description": "資料提供平台電子信箱",
"type": "string"
},
"ProviderUrl": {
"title": "String",
"description": "資料提供平台網址鏈結",
"type": "string"
},
"UpdateTime": {
"title": "DateTime",
"description": "資料更新日期時間(ISO8601格式:yyyy-MM-ddTHH:mm:sszzz)",
"type": "string"
},
"ProviderCode": {
"title": "String",
"description": "資料提供平台簡碼",
"type": "string"
}
}
}
},
"tags": [
{
"name": "Basic",
"description": "基礎資料"
}
]
}