-
Notifications
You must be signed in to change notification settings - Fork 5
/
IFS08-iscrizioni-per-fasce-isee.yaml
221 lines (220 loc) · 8.06 KB
/
IFS08-iscrizioni-per-fasce-isee.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
openapi: 3.0.0
info:
title: IFS08 - Academic enrollments by ISEE / Iscrizioni accademiche per fasce ISEE
x-summary: |
Retrieve the number of academic enrollments by ISEE / Ottiene il numero di iscrizioni accademiche per fasce ISEE
version: 2.1.0
description: |
Retrieve the number of academic enrollments by ISEE / Ottiene il numero di iscrizioni accademiche per fasce ISEE
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-isee-ranges:
post:
summary: |
Retrieve the number of academic enrollments by ISEE / Ottiene il numero di iscrizioni accademiche per fasce ISEE
tags:
- IFS08.1 - count-academic-enrollments-by-isee-ranges
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/count_academic_enrollments_by_isee_ranges'
examples:
Statuscode=200:
value:
tot_enrollment_count: 3000
ranges:
- range_description: 'ISEE non presentato'
isee_min_value: null
isee_max_value: null
enrollment_count: 1000
- range_description: '<=13.000'
isee_min_value: 0
isee_max_value: 13000
enrollment_count: 1000
- range_description: '13.001-16.000'
isee_min_value: 13001
isee_max_value: 16000
enrollment_count: 1000
- range_description: '40.001-45.000'
isee_min_value: 40001
isee_max_value: 45000
enrollment_count: 500
- range_description: '60.001-70.000'
isee_min_value: 60001
isee_max_value: 70000
enrollment_count: 500
- range_description: '> 100.000'
isee_min_value: 100001
isee_max_value: null
enrollment_count: 500
'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/isee_enrollment_request'
examples:
Example:
value:
academic_year: '2023/2024'
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
operationId: enrollments-per-isee
description: Retrieve the number of academic enrollments by ISEE / Ottiene il numero di iscrizioni accademiche per fasce ISEE
/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:
ranges:
type: object
additionalProperties: false
properties:
isee_min_value:
type: integer
format: int64
description: Minimum value of the ISEE reference band / Valore minimo della fascia ISEE di riferimento
minimum: 0
maximum: 9999999
nullable: true
isee_max_value:
type: integer
format: int64
description: Maximum value of the ISEE reference band / Valore massimo della fascia ISEE di riferimento
minimum: 0
maximum: 9999999
nullable: true
enrollment_count:
type: integer
format: int32
description: Number of students enrolled by ISEE reference bracket / Numero di iscritti per fascia ISEE di riferimento
minimum: 0
maximum: 1000000000
nullable: true
range_description:
type: string
description: Description ISEE band / Descrizione Fascia ISEE
example: '> 100000'
nullable: true
minLength: 0
maxLength: 64
required:
- isee_min_value
- isee_max_value
- enrollment_count
- range_description
count_academic_enrollments_by_isee_ranges:
type: object
nullable: true
additionalProperties: false
description: Students enrolled in the degree course by ISEE bracket / Iscritti al corso di laurea per fascia ISEE
properties:
tot_enrollment_count:
type: integer
format: int32
description: Number of total subscribers / Numero di iscritti totali
minimum: 0
maximum: 1000000000
nullable: true
ranges:
type: array
maxItems: 500000
minItems: 0
description: List of ISEE bands / Elenco di fasce ISEE
items:
$ref: '#/components/schemas/ranges'
isee_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
required:
- academic_year
requestBodies: {}
responses: {}
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: PASETO
servers:
- url: 'https://localhost:8080/api'
description: localhost
tags:
- name: IFS08.1 - count-academic-enrollments-by-isee-ranges
- name: health-check