-
Notifications
You must be signed in to change notification settings - Fork 5
/
prc-exam-api.yaml
178 lines (178 loc) · 4.5 KB
/
prc-exam-api.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
openapi: 3.0.0
info:
title: PRC Exam API
version: 1.0.0
description: |
Compiled from [Republic of the Philippines PROFESSIONAL REGULATION COMMISSION](https://www.prc.gov.ph/2022-schedule-examination) examination schedule.
servers:
- url: https://api.whenisthenextboardexam.com
paths:
/exams/upcoming:
get:
summary: Get upcoming exams
tags:
- Exams
responses:
"200":
description: The list of upcoming exams
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Exam"
"400":
description: Bad Request
/exams/{year}:
get:
summary: Get the exams by year
tags:
- Exams
parameters:
- in: path
name: year
schema:
type: number
required: true
description: The exam year
responses:
"200":
description: The corresponding exams
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Exam"
"400":
description: Bad Request
"404":
description: The exam does not exist
/exam/upcoming:
get:
summary: Get nearest upcoming exam
tags:
- Exams
responses:
"200":
description: The nearest upcoming exam
content:
application/json:
schema:
$ref: "#/components/schemas/Exam"
"400":
description: Bad Request
/exam/{name}:
get:
summary: Get the exam by name
tags:
- Exams
parameters:
- in: path
name: name
schema:
type: string
required: true
description: The exam name
responses:
"200":
description: The corresponding exams
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Exam"
"400":
description: Bad Request
"404":
description: The exam does not exist
/professions:
get:
summary: Get supported professions
tags:
- Professions
responses:
"200":
description: The list of professions
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Profession"
"400":
description: Bad Request
components:
schemas:
Exam:
type: object
properties:
_id:
type: string
description: The auto-generated 12-byte ObjectId
name:
type: string
description: The examination name
type:
type: string
description: The examination type
year:
type: number
description: The examination year
dates:
type: array
items:
type: string
description: The date/s of exam
places:
type: array
items:
type: string
description: The location/s of exam
applicationStart:
type: string
description: The opening date of online processing
applicationEnd:
type: string
description: The deadline date in filing of applications
resultDate:
type: string
description: The target date of release of exam results
example:
_id: 507f1f77bcf86cd799439011
name: Veterinarians
type: null
year: 2022
dates:
- "2022-03-28T16:00:00.000Z"
- "2022-03-29T16:00:00.000Z"
- "2022-03-30T16:00:00.000Z"
places:
- NCR
- Baguio
- Cagayan de Oro
- Cebu
- Davao
- Legaspi
- Tuguegarao
applicationStart: 12/29/21
applicationEnd: 3/1/21
resultDate: 4/5/22
Profession:
type: object
properties:
_id:
type: string
description: The auto-generated 12-byte ObjectId
name:
type: string
description: The profession name
example:
_id: 507f1f77bcf86cd799439011
name: Veterinarians
tags:
- name: Exams
description: The exam details API
- name: Professions
description: The profession details API