-
Notifications
You must be signed in to change notification settings - Fork 5
/
IFS02-iscrizioni.yaml
1104 lines (1098 loc) · 44.4 KB
/
IFS02-iscrizioni.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
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
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: |
IFS02 - Academic enrollments / Iscrizioni accademiche
x-summary: Provides the detailed information regarding the enrollment of student at an university or AFAM / Fornisce le informazioni di dettaglio riguardanti le iscrizioni di una studentessa o uno studente all'università o AFAM
version: 2.1.0
description: |
Provides the detailed information regarding the enrollment of student at an university or AFAM / Fornisce le informazioni di dettaglio riguardanti le iscrizioni di una studentessa o uno studente all'università o AFAM
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:
'/academic-enrollments':
post:
summary: |
Retrieve the details of the enrollments in the last three academic years of a student. /
Acquisizione del dettaglio delle iscrizioni per corso di studi negli ultimi tre anni accademici di una studentessa o di uno studente
tags:
- IFS02.1 - academic-enrollments
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/enrollments'
examples:
Personal data only taxCode:
value:
personal_data:
tax_code: RSSMRA80A01F205D
enrollments:
- institute_code: '16'
programme_type_code: MS
degree_course_code: '1573960'
degree_class_code: MSLM32
academic_year: 2021/2022
degree_course_year: 3
status: active
Personal data taxCode/personID:
value:
personal_data:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
enrollments:
- institute_code: '16'
programme_type_code: MS
degree_course_code: '1573960'
degree_class_code: MSLM32
academic_year: 2021/2022
degree_course_year: 3
status: active
Personal data witout taxCode:
value:
personal_data:
given_name: Mario
family_name: Rossi
birth_date: 1980-12-10
birth_place: Italia,RM,Roma
enrollments:
- institute_code: '16'
programme_type_code: MS
degree_course_code: '1573960'
degree_class_code: MSLM32
academic_year: 2021/2022
degree_course_year: 3
status: active
Enrollments with degree class code:
value:
personal_data:
tax_code: RSSMRA80A01F205D
enrollments:
- institute_code: '16'
programme_type_code: MS
degree_course_code: '1573960'
degree_class_code: MSLM32
academic_year: 2021/2022
degree_course_year: 3
status: active
Enrollments without degree class code:
value:
personal_data:
tax_code: RSSMRA80A01F205D
enrollments:
- institute_code: '16'
programme_type_code: MS
degree_course_code: '1573960'
degree_class_code: null
academic_year: 2021/2022
degree_course_year: 3
status: active
'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
operationId: Enrollments-of-student
description: Returns the enrollment details of student / Restituisce i dettagli delle iscrizioni di una studentessa o di uno studente
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/it_enrollment_request'
examples:
taxcode/personId:
value:
tax_code: RSSMRA80A01F205D
person_id: 12345678A
key:
value:
key: 8e44f796d7478a135c226598939d56a5b0d9405210235d4845ed158a7fec7535
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
parameters: []
'/proof-tertiary-education-enrollments':
post:
summary: |
Retrieves the evidences of the enrollment in tertiary education studies of a student. /
Acquisizione delle prove riguardanti l'iscrizione agli studi di istruzione terziaria di una studentessa/studente
tags:
- IFS02.2 - proof-tertiary-education-enrollments
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/proof_education_enrollments'
examples:
statuscode=200:
value:
personal_data:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
proof_enrollments:
- programme_type_code: MS
programme_type_name: Laurea Magistrale (DM 270/04)
degree_course_code: '1573960'
degree_course_name: Ingegneria informatica
degree_class_code: MSLM32
degree_class_name: Ingegneria informatica
institute_code: '16'
institute_name: Milano - Politecnico
country_of_academic_institution: Italia
expected_graduation_date: 2023-10-01
enrollment_date: 2020-10-01
'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
operationId: Enrollments-education-of-student
description: <ul> <li>Retrieves the evidences regarding enrollment to tertiary education studies.</li><li>Acquisisce le prove riguardanti l'iscrizione agli studi di istruzione terziaria (livelli EQF 5/6/7/8)</li></ul>
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/eu_enrollment_request'
examples:
Example:
value:
tax_code: RSSMRA80A01F205D
person_id: 12345678A
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
parameters: []
'/proof-tertiary-education-courses':
post:
summary: |
Retrieves the evidence of the transcript (attended learnings, grades obtained, etc.) of tertiary education studies of a student. The transcript may pertain to completed or ongoing studies. /
Acquisizione delle prove riguardanti la trascrizione (insegnamenti conseguiti, voti ottenuti, ecc.) degli studi di istruzione terziaria di una studentessa/studente. La trascrizione può riferirsi a studi completati o in corso
tags:
- IFS02.3 - proof-tertiary-education-courses
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/proof_education_courses'
examples:
statuscode=200:
value:
personal_data:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
proof_education_course:
- programme_type_code: MT
programme_type_name: Laurea Triennale (DM 270/04)
degree_course_code: '1573961'
degree_course_name: Ingegneria informatica
degree_class_code: MSLT32
degree_class_name: Ingegneria informatica
institute_code: '16'
institute_name: Milano - Politecnico
learnings:
- attended_learning_name: Esame 3
start_date: 2020-10-13
end_date: 2023-10-13
grade_value: '30'
grading_scale_min: '18'
grading_scale_max: '30'
ects_credits_received: 6
- attended_learning_name: Esame 4
start_date: 2020-10-13
end_date: 2023-10-13
grade_value: '30'
grading_scale_min: '18'
grading_scale_max: '30'
ects_credits_received: 6
- programme_type_code: MS
programme_type_name: Laurea Magistrale (DM 270/04)
degree_course_code: '1573960'
degree_course_name: Ingegneria informatica
degree_class_code: MSLM32
degree_class_name: Ingegneria informatica
institute_code: '16'
institute_name: Milano - Politecnico
learnings:
- attended_learning_name: Esame 1
start_date: 2020-10-13
end_date: 2023-10-13
grade_value: '30'
grading_scale_min: '18'
grading_scale_max: '30'
ects_credits_received: 6
- attended_learning_name: Esame 2
start_date: 2020-10-13
end_date: 2023-10-13
grade_value: '30L'
grading_scale_min: '18'
grading_scale_max: '30'
ects_credits_received: 6
'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
operationId: Qualifications-education-of-student
description: <ul> <li>Retrieves the evidences regarding the transcript (courses taken, grades obtained, etc.) of tertiary education studies (EQF levels 5/6/7/8). The transcript may refer to completed or in progress courses</li><li>Acquisisce le prove riguardanti la trascrizione (corsi seguiti, voti ottenuti, ecc.) degli studi di istruzione terziaria (livelli EQF 5/6/7/8). La trascrizione può riferirsi a studi completati o in corso.</li></ul>
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/eu_enrollment_request'
examples:
Example:
value:
tax_code: RSSMRA80A01F205D
person_id: 12345678A
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
parameters: []
'/proof-tertiary-education-admission':
post:
summary: |
Retrieves the evidences of admission to tertiary education studies of a student. /
Acquisizione delle prove riguardanti l'ammissione agli studi di istruzione terziaria di una studentessa/studente
tags:
- IFS02.4 - proof-tertiary-education-admission
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/proof_tertiary_education_admission'
examples:
statuscode=200:
value:
personal_data:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
proof_admissions:
- institute_code: '16'
institute_name: Milano - Politecnico
programme_type_code: MS
programme_type_name: Laurea Magistrale (DM 270/04)
degree_course_code: '1573960'
degree_course_name: Ingegneria informatica
degree_class_code: MSLM32
degree_class_name: Ingegneria informatica
degree_course_duration_in_months: 36
degree_course_duration_ects_credit: 180
start_date_of_academic_year: 2020-10-13
end_date_of_academic_year: 2023-10-13
'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
operationId: Tertiary-education-of-student
description: >
<ul> <li>Retrieves the evidences regarding admission to tertiary education studies (EQF levels 5/6/7/8);
</li><li>Acquisisce le prove riguardanti l'ammissione agli studi di istruzione terziaria (livelli EQF 5/6/7/8);
pur essendo collegato alla prova di iscrizione, non è intrinsecamente equivalente ad essa.</li></ul>
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/eu_enrollment_request'
examples:
Example:
value:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
parameters: []
'/proof-mobility-periods':
post:
summary: |
Retrieves the evidences of the learning activities conducted outside the tertiary education institution which a student obtained her/his diploma. /
Acquisizione delle prove relative alle attività di apprendimento svolte al di fuori dell'istituzione di istruzione terziaria dalla quale una studentessa/studente ha ottenuto il proprio diploma.
tags:
- IFS02.5 - proof-mobility-periods
security:
- bearerAuth: []
responses:
'200':
description: Request successfully executed / Richiesta eseguita con successo
content:
application/json:
schema:
$ref: '#/components/schemas/proof_personal_mobility_periods'
examples:
statuscode=200:
value:
personal_data:
tax_code: RSSMRA80A01F205D
person_id: AB123456C
proof_mobility_periods:
- eqf_level: Livello 7
mobility_start_date: 2020-05-17
mobility_end_date: 2021-05-17
mobility_period_type: lungo_termine
destination_institute_name: Universidad Politecnica de Madrid
destination_erasmus_code: VALENCI02
departure_institute_name: Politecnico di Milano
departure_erasmus_code: MILANO02
destination_department: Faculty of Science & Engineering
departure_department: Dipartimento di Ingegneria Industriale
destination_country: Spagna
departure_country: Italia
'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
operationId: proof-mobility-periods
description: |
<ul> <li>Retrieves the evidences related to learning activities that the student have done outside the
institute where her/he got the diploma</li><li>Fornisce le prove relative alle attività di
apprendimento svolte al di fuori dell'istituzione di istruzione terziaria dalla quale una persona ha ottenuto
il proprio diploma.</li></ul>
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/eu_enrollment_request'
examples:
Example:
value:
tax_code: RSSMRA80A01F205D
person_id: A1234568A
application/xml:
schema:
type: object
additionalProperties: false
properties: {}
description: ''
parameters: []
/status:
get:
summary: Verifica stato delle API (Health Check)
security: [{}]
operationId: check-status
description: Check the system's health status / Verificare lo stato di salute del sistema
tags:
- health-check
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:
enrollments:
additionalProperties: false
type: object
description: Enrollment details of student / Dettaglio iscrizioni di una studentessa o di uno studente
properties:
personal_data:
$ref: '#/components/schemas/personal_data'
enrollments:
type: array
maxItems: 256
minItems: 0
description: List of enrollments for student / Elenco iscrizioni di una studentessa o di uno studente
items:
$ref: '#/components/schemas/enrollment'
proof_education_enrollments:
additionalProperties: false
type: object
description: Enrollment details of student / Dettaglio iscrizioni di una studentessa o di uno studente
properties:
personal_data:
$ref: '#/components/schemas/personal_data'
proof_enrollments:
type: array
maxItems: 256
minItems: 0
description: List of enrollments for student / Elenco iscrizioni di una studentessa o di uno studente
items:
$ref: '#/components/schemas/proof_enrollment'
proof_enrollment:
type: object
additionalProperties: false
description: Detailed enrollment information / Informazioni dettagliate sull'iscrizione
properties:
programme_type_code:
type: string
description: Code of study program / codice del corso di studio
example: 'LM'
minLength: 1
maxLength: 256
nullable: true
programme_type_name:
type: string
description: Type of study program / Tipologia del corso di studio
example: 'Laurea Specialistica (DM 509/99), Laurea Magistrale (DM 270/04), Laurea Triennale (DM 509/99)'
minLength: 1
maxLength: 2048
nullable: true
degree_course_code:
type: string
description: Course code / Codice del corso
minLength: 1
maxLength: 20
nullable: true
degree_course_name:
type: string
description: Course name / Denominazione corso
example: 'ingegneria, economia, giurisprudenza, medicina, scienze umanistiche, scienze sociali, informatica, arte e design'
minLength: 1
maxLength: 2048
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
degree_class_name:
type: string
description: Name of the degree class / Denominazione della classe di laurea
example: 'Ingegneria informatica, Scienze giuridiche'
minLength: 1
maxLength: 2048
nullable: true
institute_code:
type: string
description: Institute identification code / Codice identificativo dell’istituto
example: 'AA'
minLength: 1
maxLength: 256
nullable: true
institute_name:
type: string
description: Institute's name / Denominazione dell’istituto
example: 'Milano - Politecnico'
minLength: 1
maxLength: 2048
nullable: true
country_of_academic_institution:
type: string
description: Country of the academic institution / Paese dell'istituzione accademica
minLength: 1
maxLength: 20
nullable: true
expected_graduation_date:
type: string
format: date
description: Date of completion of studies / Data completamento studi
example: 2023-10-01
nullable: true
enrollment_date:
type: string
format: date
description: Enrollment date / Data iscrizione
example: 2020-10-01
nullable: true
proof_education_courses:
additionalProperties: false
type: object
description: Examinations details of student / Dettaglio esami di una studentessa o di uno studente
properties:
personal_data:
$ref: '#/components/schemas/personal_data'
proof_education_course:
type: array
minItems: 0
maxItems: 256
items:
$ref: '#/components/schemas/proof_education_course'
proof_education_course:
type: object
additionalProperties: false
description: Examinations taken by the student / Esami sostenuti della studentessa o dello studente
properties:
programme_type_code:
type: string
description: Code of study program / codice del corso di studio
example: 'LM'
minLength: 1
maxLength: 256
nullable: true
programme_type_name:
type: string
description: Type of study program / Tipologia del corso di studio
example: 'Laurea Specialistica (DM 509/99), Laurea Magistrale (DM 270/04), Laurea Triennale (DM 509/99)'
minLength: 1
maxLength: 2048
nullable: true
degree_course_code:
type: string
description: Course code / Codice del corso
minLength: 1
maxLength: 20
nullable: true
degree_course_name:
type: string
description: Course name / Denominazione corso
example: 'ingegneria, economia, giurisprudenza, medicina, scienze umanistiche, scienze sociali, informatica, arte e design'
minLength: 1
maxLength: 2048
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
degree_class_name:
type: string
description: Name of the degree class / Denominazione della classe di laurea
example: 'Ingegneria informatica, Scienze giuridiche'
minLength: 1
maxLength: 2048
nullable: true
institute_code:
type: string
description: Institute identification code / Codice identificativo dell’istituto
example: 'AA'
minLength: 1
maxLength: 256
nullable: true
institute_name:
type: string
description: Institute's name / Denominazione dell’istituto
example: 'Milano - Politecnico'
minLength: 1
maxLength: 2048
nullable: true
learnings:
type: array
maxItems: 256
minItems: 0
description: List of qualifications for student / Elenco iscrizioni di una studentessa o di uno studente
items:
$ref: '#/components/schemas/learnings'
learnings:
type: object
additionalProperties: false
description: Detailed examination information / Informazioni dettagliate sul corso
properties:
attended_learning_name:
type: string
description: Course name / Nome corso
example: Esame 1
minLength: 1
maxLength: 2048
nullable: true
start_date:
type: string
format: date
description: Course start date / Data inizio corso
example: 2020-10-13
nullable: true
end_date:
type: string
format: date
description: Course end date / Data fine corso
example: 2023-10-13
nullable: true
grade_value:
type: string
description: Grade / Voto
example: '28'
pattern: ^(\d+(.\d{1,2})?|\d+L|QUALIFIED|[A-Z])$
nullable: true
grading_scale_min:
type: string
description: Minimum course grade / Voto minimo del corso
example: '18'
pattern: ^(\d+(.\d{1,2})?|[A-Z])$
nullable: true
grading_scale_max:
type: string
description: Highest course grade / Voto massimo del corso
example: '30'
pattern: ^(\d+(.\d{1,2})?|[A-Z])$
nullable: true
ects_credits_received:
type: integer
format: int32
description: ECTS credits / Crediti ECTS
example: 6
maximum: 999
minimum: 1
nullable: true
proof_tertiary_education_admission:
additionalProperties: false
type: object
description: Return the certificates of admission to tertiary education institute / Restituisce i certificati di ammissione a istituti di istruzione terziaria
properties:
personal_data:
$ref: '#/components/schemas/personal_data'
proof_admissions:
type: array
maxItems: 256
minItems: 0
description: List of admission certificates / Elenco dei certificati di ammissione
items:
$ref: '#/components/schemas/proof_admissions'
proof_admissions:
type: object
additionalProperties: false
description: Detailed information on admission certification / Informazioni dettagliate sulla certificazione di ammissione
properties:
institute_code:
type: string
description: Institute identification code / Codice identificativo dell’istituto
example: 'AA'
minLength: 1
maxLength: 256
nullable: true
institute_name:
type: string
description: Institute's name / Denominazione dell’istituto
example: 'Milano - Politecnico'
minLength: 1
maxLength: 2048
nullable: true
programme_type_code:
type: string
description: Code of study program / codice del corso di studio
example: 'LM'
minLength: 1
maxLength: 256
nullable: true
programme_type_name:
type: string
description: Type of study program / Tipologia del corso di studio
example: 'Laurea Specialistica (DM 509/99), Laurea Magistrale (DM 270/04), Laurea Triennale (DM 509/99)'
minLength: 1
maxLength: 2048
nullable: true
degree_course_code:
type: string
description: Course code / Codice del corso
minLength: 1
maxLength: 20
nullable: true
degree_course_name:
type: string
description: Course name / Denominazione corso
example: 'ingegneria, economia, giurisprudenza, medicina, scienze umanistiche, scienze sociali, informatica, arte e design'
minLength: 1
maxLength: 2048
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
degree_class_name:
type: string
description: Name of the degree class / Denominazione della classe di laurea
example: 'Ingegneria informatica, Scienze giuridiche'
minLength: 1
maxLength: 2048
nullable: true
degree_course_duration_in_months:
type: integer
format: int32
description: Duration of study course / Durata del corso di studi
minimum: 0
maximum: 999
nullable: true
degree_course_duration_ects_credit:
type: integer
format: int32
description: Duration of study course in ECTS/ Durata del corso di studi in ECTS
minimum: 1
maximum: 999
nullable: true
start_date_of_academic_year:
type: string
format: date
description: Academic year start date / Data inzio anno accademico
example: 2023-10-01
nullable: true
end_date_of_academic_year:
type: string
format: date
description: Academic year end date / Data fine anno accademico
example: 2020-10-01
nullable: true
proof_personal_mobility_periods:
additionalProperties: false
type: object
description: Return the certificates of admission to tertiary education institutes / Restituisce i certificati di ammissione a istituti di istruzione terziaria
properties:
personal_data:
$ref: '#/components/schemas/personal_data'
proof_mobility_periods:
type: array
maxItems: 256
minItems: 0
description: List of admission certificates / Elenco dei certificati di ammissione
items:
$ref: '#/components/schemas/proof_mobility_periods'
proof_mobility_periods:
type: object
additionalProperties: false
description: Detailed information on admission certification / Informazioni dettagliate sulla certificazione di ammissione
properties:
eqf_level:
type: string
description: Level of education (EQF) / Livello di educazione (EQF)
example: Livello 7
minLength: 1
maxLength: 2048
nullable: true
mobility_start_date:
type: string
format: date
description: Erasmus start date / Data inzio anno erasmus
example: 2020-05-17
nullable: true
mobility_end_date:
type: string
format: date
description: Erasmus end date / Data fine anno erasmus
example: 2021-05-17
nullable: true
mobility_period_type:
type: string
nullable: true
description: Type of mobility period / Tipo del periodo di mobilità
example: lungo_termine
enum:
- trimestrale
- semestrale
- annuale
- breve_termine
- lungo_termine
destination_institute_name:
type: string
nullable: true
description: Destination institute's name / Nome dell'istituto di destinazione
example: Universidad Politecnica de Madrid
minLength: 1
maxLength: 2048
destination_erasmus_code:
type: string
nullable: true
description: Erasmus code of destination institute / Codice erasmus dell'istituto di destinazione
example: VALENCI02
minLength: 1
maxLength: 2048
departure_institute_name:
type: string
nullable: true
description: Name of departure institute / Nome dell'istituto di partenza
example: Politecnico di Milano
minLength: 1
maxLength: 2048
departure_erasmus_code:
type: string
nullable: true
description: Erasmus code of departure institute / Codice erasmus dell'istituto di partenza
example: MILANO02
minLength: 1
maxLength: 2048
destination_department:
type: string
nullable: true
description: Department of destination / Dipartimento di destinazione
example: Faculty of Science & Engineering
minLength: 1
maxLength: 2048
departure_department:
type: string
nullable: true
description: Department of departure / Dipartimento di partenza
example: Dipartimento di Ingegneria Industriale
minLength: 1
maxLength: 2048
destination_country:
type: string
nullable: true
description: Destination country / Paese di destinazione
example: Spagna
minLength: 1
maxLength: 2048
departure_country:
type: string
nullable: true
description: Departure country / Paese di arrivo
example: Italia
minLength: 1
maxLength: 2048
enrollment:
type: object
additionalProperties: false
description: Detailed enrollment information / Informazioni dettagliate sull'iscrizione
properties:
institute_code:
type: string
description: Institute identification code / Codice identificativo dell’istituto
example: 'AA'
minLength: 1
maxLength: 256
nullable: true
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
degree_class_code:
type: string
description: Identification code of the degree class / Codice identificativo della classe di laurea
example: MSLM32
nullable: true
minLength: 1
maxLength: 20
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_year:
type: integer
format: int32
description: Last year in which enrollment in the student's course is recorded / Ultimo anno in cui risulta l'iscrizione al corso della studentessa o dello studente
example: 3
pattern: ^\d{1,2}$
minimum: 1
maximum: 99
status:
type: string
description: Enrollment status / Stato dell'iscrizione
example: active
enum:
- active
- inactive
- wait
required:
- status
- degree_course_year
- academic_year
- degree_course_code
- programme_type_code
- institute_code
personal_data:
type: object
additionalProperties: false
description: Personal data of the student / Dati personali della studentessa o dello studente
properties:
tax_code:
type: string
description: Tax Identification Number / Codice Fiscale
example: RSSMRA80A01F205D
pattern: '^(?:^(?:[A-Z][AEIOU][AEIOUX]|[B-DF-HJ-NP-TV-Z]{2}[A-Z]){2}(?:[\dLMNP-V]{2}(?:[A-EHLMPR-T](?:[04LQ][1-9MNP-V]|[15MR][\dLMNP-V]|[26NS][0-8LMNP-U])|[DHPS][37PT][0L]|[ACELMRT][37PT][01LM]|[AC-EHLMPR-T][26NS][9V])|(?:[02468LNQSU][048LQU]|[13579MPRTV][26NS])B[26NS][9V])(?:[A-MZ][1-9MNP-V][\dLMNP-V]{2}|[A-M][0L](?:[1-9MNP-V][\dLMNP-V]|[0L][1-9MNP-V]))[A-Z]$)'
minLength: 16
maxLength: 16
nullable: true
person_id:
type: string
description: Unique National Identifier (ANPR ID) / Identificativo unico nazionale (ID ANPR)
maxLength: 9
minLength: 9
example: AB123456C