-
Notifications
You must be signed in to change notification settings - Fork 5
/
IFS09-iscrizioni-per-corso.yaml
214 lines (212 loc) · 7.85 KB
/
IFS09-iscrizioni-per-corso.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
openapi: 3.0.0
info:
title: IFS09 - Academic enrollments by degree course / Iscrizioni accademiche per corso di studi
x-summary: |
Retrieve the number of academic enrollments by degree course / Ottiene il numero di iscrizioni accademiche per corso di studi
version: 2.1.0
description: |
Retrieve the number of academic enrollments by degree course / Ottiene il numero di iscrizioni accademiche per corso di studi
contact:
name: Institute name
email: [email protected]
x-api-id: 00000000-0000-0000-0000-000000000000
termsOfService: 'http://swagger.io/terms/'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
paths:
/count-academic-enrollments-by-degree-courses:
post:
summary: |
Retrieve the number of academic enrollments by degree course / Ottiene il numero di iscrizioni accademiche per corso di studi
tags:
- IFS09.1 - count-academic-enrollments-by-degree-courses
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/count_academic_enrollments_by_degree_courses'
examples:
Statuscode=200:
value:
- programme_type_code: MS
degree_course_code: '469'
degree_class_code: MSLM32
female_enrollment_count: 15000
male_enrollment_count: 10000
- programme_type_code: MS
degree_course_code: '355'
degree_class_code: MSLM20
female_enrollment_count: 2000
male_enrollment_count: 1500
- programme_type_code: LT
degree_course_code: '245'
degree_class_code: LT10
female_enrollment_count: 5000
male_enrollment_count: 6000
'400':
description: <b>Bad Request</b> - il server non può elaborare la richiesta del client a causa di una sintassi errata o di una richiesta non valida. <br> Esempi di cause
<br> - Richiesta non valida
<br> - Sintassi errata
<br> - Parametro mancante
<br> - Richiesta incompleta
<br> - ...
'500':
description: Internal server error / Errore interno del server
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/count_enrollment_request'
examples:
Academic year filtered:
value:
academic_year: '2023/2024'
Degree course filtered:
value:
academic_year: '2023/2024'
degree_course_code: '465'
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
operationId: enrollments-per-degree-course
description: Retrieve the number of academic enrollments by degree course / Ottiene il numero di iscrizioni accademiche per corso di studi
/status:
get:
summary: Verifica stato delle API (Health Check)
operationId: check-status
description: Check the system's health status / Verificare lo stato di salute del sistema
tags:
- health-check
security: [{}]
responses:
'400':
description: Bad Request
'204':
description: The service is running correctly / il servizio è in esecuzione correttamente.
'500':
description: The service is not running. / il servizio non è in esecuzione.
components:
headers:
Retry-After:
description: |-
Retry contacting the endpoint *at least* after seconds.
See https://tools.ietf.org/html/rfc7231#section-7.1.3
schema:
format: int32
maximum: 186400
minimum: 0
type: integer
X-RateLimit-Limit:
description: The number of allowed requests in the current period / Numero di richieste consentite nel periodo attuale
schema:
format: int32
maximum: 1000000
minimum: 0
type: integer
X-RateLimit-Remaining:
description: The number of remaining requests in the current period / Numero di richieste rimanenti nel periodo attuale
schema:
format: int32
maximum: 1000000
minimum: 0
type: integer
X-RateLimit-Reset:
description: The number of seconds left in the current period / Numero di secondi rimanenti nel periodo attuale
schema:
format: int32
maximum: 186400
minimum: 0
type: integer
schemas:
count_academic_enrollments_by_degree_courses:
type: array
description: Enrollment details of student / Dettaglio iscrizioni di una studentessa o di uno studente - count academic student enrollments / numero iscrizioni per corso
minItems: 0
items:
$ref: '#/components/schemas/count_academic_enrollment'
count_academic_enrollment:
type: object
additionalProperties: false
description: Detailed examination information / Informazioni dettagliate sul corso
properties:
programme_type_code:
type: string
description: Code of study program / codice del corso di studio
example: 'LM'
minLength: 1
maxLength: 256
degree_course_code:
type: string
description: Course code / Codice del corso
minLength: 1
maxLength: 20
nullable: true
degree_class_code:
type: string
description: Identification code of the degree class / Codice identificativo della classe di laurea
example: MSLM32
minLength: 1
maxLength: 20
nullable: true
female_enrollment_count:
type: integer
format: int32
description: number of enrollment/numero di iscritti (female)
example: 30000
nullable: true
minimum: 0
maximum: 9999999
male_enrollment_count:
type: integer
format: int32
description: number of enrollment/numero di iscritti (male)
example: 30000
nullable: true
minimum: 0
maximum: 9999999
required:
- programme_type_code
- degree_course_code
- female_enrollment_count
- male_enrollment_count
count_enrollment_request:
type: object
additionalProperties: false
description: Request enrollment of a student's enrollment / Richiesta iscrizione di una studentessa o uno studente
properties:
academic_year:
type: string
description: Last academic year in which enrollment in the student's course is recorded / Ultimo anno accademico in cui risulta l'iscrizione al corso della studentessa o dello studente
example: 2022/2023
pattern: '^\d{4}/\d{4}$'
minLength: 9
maxLength: 9
degree_course_code:
type: string
description: Course code / Codice del corso
minLength: 1
maxLength: 20
required:
- academic_year
requestBodies: {}
responses: {}
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: PASETO
servers:
- url: 'https://localhost:8080/api'
description: localhost
tags:
- name: IFS09.1 - count-academic-enrollments-by-degree-courses
- name: health-check