forked from SuibianP/nus-nextbus-new-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NextBus.yaml
565 lines (561 loc) · 18.5 KB
/
NextBus.yaml
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
openapi: "3.0.0"
info:
title: NUS NextBus
description: "***Unofficially reverse-engineered API*** used by NUS NextBus application."
termsOfService: http://nus.edu.sg/registrar/docs/info/registration-guides/aup-form.pdf
version: 2.0.0
contact:
name: Hu Jialun
url: https://github.com/SuibianP
email: [email protected]
license:
name: DISCLAIMER
url: https://github.com/SuibianP/nus-nextbus-new-api/blob/openapi-def/DISCLAIMER.md
servers:
- url: https://nnextbus.nus.edu.sg
description: Current server used by NUS NextBus app
- url: https://nextbus.comfortdelgro.com.sg/eventservice.svc
description: OBSOLETE DEPRECATED server preserved merely for historical significance
paths:
/publicity:
get:
summary: Get Publicity
description: Get all publicity information.
operationId: GetPublicity
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
banners:
type: array
items:
type: object
properties:
begin:
type: string
format: date-time
description:
type: string
enabled:
type: boolean
end:
type: string
format: date-time
form:
type: object
properties:
input_label1:
type: string
input_label2:
type: string
id:
type: integer
img_url:
type: string
format: hostname
link_url:
type: string
format: hostname
name:
type: string
priority:
type: integer
type:
type: string
enum:
- IMG
- IMG_FORM
- IMG_LINK
frequency:
type: integer
401:
$ref: '#/components/responses/401'
/BusStops:
get:
summary: Get list of bus stops
description: Get information about bus stops
operationId: GetListOfBusStops
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
BusStopsResult:
type: object
properties:
busstops:
type: array
items:
type: object
properties:
LongName:
type: string
ShortName:
type: string
caption:
type: string
latitude:
type: number
format: double
longitude:
type: number
format: double
name:
type: string
401:
$ref: '#/components/responses/401'
/PickupPoint:
get:
summary: Get pickup point
description: Get all pickup points of a specified route
operationId: GetPickupPoint
parameters:
- $ref: '#/components/parameters/route_code'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
PickupPointResult:
type: object
properties:
pickuppoint:
type: array
items:
type: object
properties:
LongName:
type: string
ShortName:
type: string
busstopcode:
type: string
lat:
type: number
format: double
lng:
type: number
format: double
pickupname:
type: string
routeid:
type: integer
404:
$ref: '#/components/responses/404-service'
401:
$ref: '#/components/responses/401'
/ShuttleService:
get:
summary: Get shuttle service
description: Get all oncoming shuttle bus services at a specified stop
operationId: GetShuttleService
parameters:
- $ref: '#/components/parameters/busstopname'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
ShuttleServiceResult:
type: object
properties:
Timestamp:
type: string
format: date-time
caption:
type: string
name:
format: string
shuttles:
type: array
items:
type: object
properties:
arrivalTime:
type: string
pattern: '^-?\d*$'
arrivalTime_veh_plate:
type: string
name:
type: string
nextArrivalTime:
type: string
pattern: '^-?\d*$'
nextArrivalTime_veh_plate:
type: string
nextPassengers:
type: string
passengers:
type: string
404:
$ref: '#/components/responses/404-busstop'
401:
$ref: '#/components/responses/401'
/ActiveBus:
get:
summary: Get active bus
description: Get all active bus of a specified route
operationId: GetActiveBus
parameters:
- $ref: '#/components/parameters/route_code'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
ActiveBusResult:
type: object
properties:
ActiveBusCount:
type: string
pattern: '^\d*$'
Timestamp:
type: string
format: date-time
activebus:
type: array
items:
type: object
properties:
direction:
type: integer
lat:
type: number
format: float
lng:
type: number
format: float
speed:
type: integer
veh_plate:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404-service'
/BusLocation:
get:
summary: Get bus location
description: Get information about a specific bus by vehicle plate
operationId: GetBusLocation
parameters:
- $ref: '#/components/parameters/veh_plate'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
BusLocationResult:
type: object
properties:
direction:
type: integer
lat:
type: number
format: float
lng:
type: number
format: float
speed:
type: integer
status:
type: string
enum:
- "true"
- "false"
vehplate:
type: string
401:
$ref: '#/components/responses/401'
500:
$ref: '#/components/responses/500'
/RouteMinMaxTime:
get:
summary: Get route min max time
description: Get the minimum and maximum operating time of a route
operationId: GetRouteMinMaxTime
parameters:
- $ref: '#/components/parameters/route_code'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
RouteMinMaxTimeResult:
type: object
properties:
RouteMinMaxTime:
type: array
items:
type: object
properties:
DayType:
type: string
enum:
- Mon-Fri
- Sat
- Sun/PH
DisplayOrder:
type: string
pattern: '^\d+$'
FirstTime:
type: string
pattern: '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$'
LastTime:
type: string
pattern: '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$'
ScheduleType:
type: string
enum:
- Term
- Vacation
404:
$ref: '#/components/responses/404-service'
401:
$ref: '#/components/responses/401'
/ServiceDescription:
get:
summary: Get service description
description: Get brief path for each route
operationId: GetServiceDescription
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
ServiceDescriptionResult:
type: object
properties:
ServiceDescription:
type: array
items:
type: object
properties:
Route:
type: string
RouteDescription:
type: string
401:
$ref: '#/components/responses/401'
/Announcements:
get:
summary: Get announcements
description: Get all announcements
operationId: GetAnnouncements
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
AnnouncementsResult:
type: object
properties:
Announcement:
type: array
items:
type: object
properties:
Affected_Service_Ids:
type: string
Created_By:
type: string
Created_On:
type: string
format: date-time
ID:
type: string
pattern: '^\d+$'
Priority:
type: string
pattern: '^\d+$'
Status:
type: string
enum:
- Enabled
- Disabled
Text:
type: string
TimeStamp:
type: string
format: date-time
401:
$ref: '#/components/responses/401'
/TickerTapes:
get:
summary: Get ticker tapes
description: Get all ticker tapes
operationId: GetTickerTapes
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
TickerTapesResult:
type: object
properties:
TickerTape:
type: array
items:
type: object
properties:
Accident_Latitude:
type: number
format: double
Accident_Longitude:
type: number
format: double
Affected_Service_Ids:
type: string
Created_By:
type: string
Created_On:
type: string
format: date-time
Display_From:
type: string
format: date-time
Display_To:
type: string
format: date-time
ID:
type: string
pattern: '^\d+$'
Message:
type: string
Priority:
type: string
enum:
- High
- Medium
- Low
Status:
type: string
enum:
- Enabled
- Disabled
TimeStamp:
type: string
format: date-time
/CheckPoint:
get:
summary: Get checkpoints
description: Get all checkpoints of a specified route
operationId: GetAllCheckpoints
parameters:
- $ref: '#/components/parameters/route_code'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
CheckPointResult:
type: object
properties:
CheckPoint:
type: array
items:
type: object
properties:
PointID:
type: string
pattern: '\d+'
latitude:
type: number
format: double
longitude:
type: number
format: double
routeid:
type: integer
components:
responses:
401:
description: Unauthorized
content:
text/html:
schema:
type: string
enum: [Unauthorized Access]
404-service:
description: Not Found
content:
text/html:
schema:
type: string
enum: [Service not found!]
404-busstop:
description: Not Found
content:
text/html:
schema:
type: string
enum: [Bus stop not found!]
500:
description: Internal Server Error
content:
text/html:
schema:
type: string
enum: ['<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>500 Internal Server Error</title>
<h1>Internal Server Error</h1>
<p>The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application.</p>']
parameters:
route_code:
in: query
name: route_code
schema:
type: string
description: Code of the bus route
busstopname:
in: query
name: busstopname
schema:
type: string
description: Name of the bus stop
veh_plate:
in: query
name: veh_plate
schema:
type: string
description: Vehicle plate of a bus
securitySchemes:
Basic:
type: http
scheme: basic
security:
- Basic: []