add initial ESSE3 collections

This commit is contained in:
2026-04-20 15:29:26 +02:00
parent 280ce2580e
commit 094c389c46
106 changed files with 11289 additions and 0 deletions
@@ -0,0 +1,118 @@
info:
name: Dismette un indirizzo email istituzionale (PATCH)
type: http
seq: 12
tags:
- persone
http:
method: PATCH
url: "{{baseUrl}}/persone/:persId/dismettiEmail"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzio email istituzionale da dismettere
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Update succeded
request:
url: "{{baseUrl}}/persone/:persId/dismettiEmail"
method: PATCH
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzio email istituzionale da dismettere
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: aggiornamento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/dismettiEmail"
method: PATCH
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzio email istituzionale da dismettere
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Permette la dismissione di un indirizzo email istituzionale.
Se viene passato l'indirizzo email, questo viene confrontato con quello dello studente e si procede alla dismissione solo se coincidono.
Codice di Ritorno | Descrizione
- | -
-1 | Errore
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,103 @@
info:
name: Dismette un indirizzo email istituzionale
type: http
seq: 4
tags:
- persone
http:
method: PATCH
url: "{{baseUrl}}/persone/:emailAte/dismetti"
params:
- name: emailAte
value: ""
type: path
description: indirizzio email istituzionale da dismettere
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Update succeded
request:
url: "{{baseUrl}}/persone/:emailAte/dismetti"
method: PATCH
params:
- name: emailAte
value: ""
type: path
description: indirizzio email istituzionale da dismettere
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: aggiornamento non riuscito
request:
url: "{{baseUrl}}/persone/:emailAte/dismetti"
method: PATCH
params:
- name: emailAte
value: ""
type: path
description: indirizzio email istituzionale da dismettere
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Permette la dismissione di un indirizzo email istituzionale.
Viene recuperato l'identificativo della persona associata all'email e si invoca il servizio patch /persone/{persId}/dismettiEmail .
Codice di Ritorno | Descrizione
- | -
-1 | Errore
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,152 @@
info:
name: Effettua l'aggiornamento dei consensi dello studente
type: http
seq: 10
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/consensi"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Update succeded
request:
url: "{{baseUrl}}/persone/:persId/consensi"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: aggiornamento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/consensi"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'aggiornamento dei consensi dello studente.
Viene restituita una lista di consensi contenente tutti i consensi aggiornati.
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,116 @@
info:
name: Effettua l'aggiornamento dell'email istituzionale dello studente
type: http
seq: 14
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/emailAte"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzo email istituzionale
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Update succeded
request:
url: "{{baseUrl}}/persone/:persId/emailAte"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzo email istituzionale
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: aggiornamento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/emailAte"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: emailAte
value: ""
type: query
description: indirizzo email istituzionale
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'aggiornamento dell'email istituzionale dello studente.
Non è possibile impostare l'email istituzionale ad un valore nullo (esiste il servizio
'/persone/{persId}/dismettiEmail' per dismettere l'email istituzionale).
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,118 @@
info:
name: Effettua l'aggiornamento dell'email personale dello studente
type: http
seq: 13
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/email"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: email
value: ""
type: query
description: indirizzo email personale
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Update succeded
request:
url: "{{baseUrl}}/persone/:persId/email"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: email
value: ""
type: query
description: indirizzo email personale
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: aggiornamento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/email"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: email
value: ""
type: query
description: indirizzo email personale
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'aggiornamento dell'email personale dello studente.
E' possibile impostare la mail anche ad un valore nullo.
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,90 @@
info:
name: Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona
type: http
seq: 22
tags:
- persone
http:
method: POST
url: "{{baseUrl}}/titoli/import"
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 201 Response
description: Ritorna idtestata elaborazione se import con successo
request:
url: "{{baseUrl}}/titoli/import"
method: POST
response:
status: 201
statusText: Created
body:
type: text
data: ""
- name: 422 Response
description: Inserimento non riuscito
request:
url: "{{baseUrl}}/titoli/import"
method: POST
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona.
Viene restituito un oggetto di titoli contenente tutti i titoli aggiornati.
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,122 @@
info:
name: Effettua l'inserimento dei titoli di studio relativi ad una persona (POST)
type: http
seq: 16
tags:
- persone
http:
method: POST
url: "{{baseUrl}}/persone/:persId/ins-dicHandMisComp"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: query
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 201 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/ins-dicHandMisComp"
method: POST
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: query
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
response:
status: 201
statusText: Created
body:
type: text
data: ""
- name: 422 Response
description: Inserimento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/ins-dicHandMisComp"
method: POST
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: query
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'inserimento delle Misure Compensative legate ad una Dichiarazioni di invalidità
Viene restituito un oggetto di misure compensative contenente tutti i dati aggiornati.
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,134 @@
info:
name: Effettua l'inserimento dei titoli di studio relativi ad una persona
type: http
seq: 11
tags:
- persone
http:
method: POST
url: "{{baseUrl}}/persone/:persId/dic-hand/:dicHandId/misure-compensative-dicHand"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: path
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 201 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/dic-hand/:dicHandId/misure-compensative-dicHand"
method: POST
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: path
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
response:
status: 201
statusText: Created
body:
type: text
data: ""
- name: 422 Response
description: Inserimento non riuscito
request:
url: "{{baseUrl}}/persone/:persId/dic-hand/:dicHandId/misure-compensative-dicHand"
method: POST
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dicHandId
value: ""
type: path
description: identificativo dichiarazione invalidità
- name: tipoHandicap
value: ""
type: query
description: tipo di handicap
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua l'inserimento delle Misure Compensative legate ad una Dichiarazioni di invalidità
Viene restituito un oggetto di misure compensative contenente tutti i dati aggiornati.
##### Codici di ritorno della funzione
Codice di Ritorno | Descrizione
- | -
-1 | Errore generico
1 | Esecuzione Corretta
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: DOCENTE**
Profilo|Controllo| Funzione
-|-|-
DOCENTE|Permette la visualizzazione ad un utente di tipo DOCENTE e controlla che il docente sia colleagato alla persona|SecurityAnaper.checkDocenteDichHandByPersId(persId)
**Utente: SOGG_EST**
Profilo|Controllo| Funzione
-|-|-
SOGG_EST|Permette la visualizzazione ad un utente di tipo SOGG_EST e controlla che il docente sia colleagato alla persona|SecurityAnaper.checkSoggEstDichHandByPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,143 @@
info:
name: Recupera i consensi relativi ad uno studente
type: http
seq: 9
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/consensi"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/consensi"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri di ricerca errati o non coerenti.
request:
url: "{{baseUrl}}/persone/:persId/consensi"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: procWebCod
value: ""
type: query
description: Codice processo WEB
- name: iso6392Cod
value: ""
type: query
description: Codice ISO lingua
disabled: true
- name: stuId
value: ""
type: query
description: identificativo della carriera
disabled: true
- name: aaId
value: ""
type: query
description: identificativo anno accademico
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera i consensi relativi ad uno studente
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,219 @@
info:
name: Recupera i titoli relativi ad una persona (GET)
type: http
seq: 24
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/titoliPersona"
params:
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/titoliPersona"
method: GET
params:
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri di ricerca errati o non coerenti.
request:
url: "{{baseUrl}}/titoliPersona"
method: GET
params:
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera i titoli relativi ad una persona.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: ALL**
Profilo|Controllo| Funzione
-|-|-
PERSONA|Permette la visualizzazione delle informazioni della persona dell'utente registrato, immatricolato in ipotesi.|Security.checkPersonaPersId(persId)
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : TitoliPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
SUP|optional
TITSTRA|optional
TITIT|optional
Classe di modello : TitoloMaturPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : TitoloStraPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : TitoloItPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,201 @@
info:
name: Recupera i titoli relativi ad una persona
type: http
seq: 23
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/titoli/:persId"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/titoli/:persId"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri di ricerca errati o non coerenti.
request:
url: "{{baseUrl}}/titoli/:persId"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: stuId
value: ""
type: query
description: identificativo dello studente
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera i titoli relativi ad una persona.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: ALL**
Profilo|Controllo| Funzione
-|-|-
PERSONA|Permette la visualizzazione delle informazioni della persona dell'utente registrato, immatricolato in ipotesi.|Security.checkPersonaPersId(persId)
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : TitoliPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
SUP|optional
TITSTRA|optional
TITIT|optional
Classe di modello : TitoloMaturPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : TitoloStraPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : TitoloItPersona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,89 @@
info:
name: Recupero della carriera degli studenti
type: http
seq: 7
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/carriere/:stuId"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: stuId
value: ""
type: path
description: identificativo della carriera
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/carriere/:stuId"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: stuId
value: ""
type: path
description: identificativo della carriera
response:
status: 200
statusText: OK
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera l' oggetto 'Carriera'.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : Carriera
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
aaOrdId|primaryKey
pdsId|primaryKey
iscrId|primaryKey
cdsId|primaryKey
stuId|primaryKey
@@ -0,0 +1,235 @@
info:
name: Recupero delle anagrafiche presenti a sistema (GET)
type: http
seq: 2
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone-gdpr"
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone-gdpr"
method: GET
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: parametri Errati
request:
url: "{{baseUrl}}/persone-gdpr"
method: GET
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera la lista degli oggetti 'PersonaGdpr' che contiene i dati di una persona con anche le informazioni riservate. Per gli utenti tecnici è necessario farsi abilitare dall'ateneo all'utilizzo di questa operation. I parametri ozionali **start** e **limit** consentono di paginare i risultati. E'' possibile filtrare le persone da ricercare utilizzando i parametri di cognome nome e codice fiscale.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserDependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server disabilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|funzione accessibile alle utenze di tipo STUDENTE|Security.checkStudente()
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,397 @@
info:
name: Recupero delle anagrafiche presenti a sistema
type: http
seq: 1
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone"
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: identificativo U-Gov
value: ""
type: query
description: identificativo di U-Gov che permette di ritirare le informazioni dei responsabili.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone"
method: GET
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: identificativo U-Gov
value: ""
type: query
description: identificativo di U-Gov che permette di ritirare le informazioni dei responsabili.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: parametri Errati
request:
url: "{{baseUrl}}/persone"
method: GET
params:
- name: cognome
value: ""
type: query
description: cognome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: nome
value: ""
type: query
description: nome dell'utente (se viene utilizzato il carattere * viene applicato il like)
disabled: true
- name: codFis
value: ""
type: query
description: codice fiscale dell'utente
disabled: true
- name: daDataMod
value: ""
type: query
description: data di ultima modifica, verranno recuperati tutti i record inseriti con data di ultima modifica successiva a questa data
disabled: true
- name: daOraMod
value: ""
type: query
description: ora, minuti e secondi dell'ultima modifica (HH:MI:SS), verranno recuperati tutti i record inseriti con orario di ultima modifica successivo a questo orario in data daDataMod. Se i secondi verranno omessi saranno impostati automaticamente a 00.
disabled: true
- name: persId
value: ""
type: query
description: identificativo della persona
disabled: true
- name: identificativo U-Gov
value: ""
type: query
description: identificativo di U-Gov che permette di ritirare le informazioni dei responsabili.
disabled: true
- name: start
value: ""
type: query
description: |
utilizzato insieme a `limit` per indicare la paginazione sui record; `start` indica il numero del primo record da caricare (se non indicato viene utilizzato 0)
disabled: true
- name: limit
value: ""
type: query
description: |
utilizzato insieme a `start` per indicare la paginazione sui record, `limit` indica il numero di record da recuperare (a partire da `start`);
se non indicato viene utilizzato 50, i valori consentiti vanno da 0 a 100
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera la lista degli oggetti 'Persona'. I parametri ozionali **start** e **limit** consentono di paginare i risultati. E'' possibile filtrare le persone da ricercare utilizzando i parametri di cognome nome e codice fiscale
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserDependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server disabilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|funzione accessibile alle utenze di tipo STUDENTE|Security.checkStudente()
Classe di modello : PersonaAnagComuni
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
anaperCodExt|optional
anaperStorico|optional
anaperConsensi|optional
anaperContatti|optional
datiBancari|optional
docPers|optional
dicHand|optional
permSog|optional
indirizzi|optional
autorizzati|optional
autorizzazioni|optional
tutori|optional
matur|optional
titIt|optional
titStra|optional
profiliEsterni|optional
aliasAnagrafica|optional
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
Classe di modello : AnaperConsensi
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
tipoConsensoCod|primaryKey
Classe di modello : AnaperConsensiSto
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
tipoConsensoCod|primaryKey
Classe di modello : ReplicaDicHand
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
dicHandId|primaryKey
Classe di modello : DicHandMisComp
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
dicHandId|primaryKey
Classe di modello : AnaperIndirizzi
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
tipoIndirizCod|primaryKey
Classe di modello : AnaperIndirizziSto
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
tipoIndirizCod|primaryKey
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,77 @@
info:
name: Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid (GET)
type: http
seq: 5
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/"
params:
- name: persId
value: "135097"
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera un singolo oggetto 'Persona'.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
@@ -0,0 +1,77 @@
info:
name: Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid
type: http
seq: 3
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone-gdpr/:persId/"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone-gdpr/:persId/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera un singolo oggetto 'PersonaGdpr' che contiene i dati di una persona con anche le informazioni riservate. Per gli utenti tecnici è necessario farsi abilitare dall'ateneo all'utilizzo di questa operation.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : Persona
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
persId|primaryKey
@@ -0,0 +1,93 @@
info:
name: aggiornamento cellulare
type: http
seq: 8
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/cellulare"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/cellulare"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/cellulare"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>aggiornamento cellulare
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,93 @@
info:
name: aggiornamento telefono di domicilio
type: http
seq: 18
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/telefono-domicilio"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/telefono-domicilio"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/telefono-domicilio"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>aggiornamento telefono di residenza
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,93 @@
info:
name: aggiornamento telefono di residenza
type: http
seq: 19
tags:
- persone
http:
method: PUT
url: "{{baseUrl}}/persone/:persId/telefono-residenza"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/telefono-residenza"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/telefono-residenza"
method: PUT
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>aggiornamento telefono di residenza
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,7 @@
info:
name: persone
type: folder
seq: 1
request:
auth: inherit
@@ -0,0 +1,93 @@
info:
name: getFotoPersona
type: http
seq: 15
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/foto"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/foto"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/foto"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupero della foto relativa ad una singola persona presente a sistema ed identificata dal persid
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,93 @@
info:
name: getValidaFlgFoto
type: http
seq: 21
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/validaFoto"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/validaFoto"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/validaFoto"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupero dello stato del flag di validazione di una foto relativa ad una singola persona presente a sistema ed identificata dal persid
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,211 @@
info:
name: misure compensative per i bisogni speciali degli studeneti
type: http
seq: 17
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/misure-compensative"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dataInizioApp
value: ""
type: query
description: data inizio appello.
disabled: true
- name: q
value: ""
type: query
description: |
il parametro consente di filtrare i campi con delle particolari condizioni predefinite, consultare la documentazione del metodo per verificare i codici che
è possibile utilizzare
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: fields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/misure-compensative"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dataInizioApp
value: ""
type: query
description: data inizio appello.
disabled: true
- name: q
value: ""
type: query
description: |
il parametro consente di filtrare i campi con delle particolari condizioni predefinite, consultare la documentazione del metodo per verificare i codici che
è possibile utilizzare
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: fields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: Parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/misure-compensative"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: dataInizioApp
value: ""
type: query
description: data inizio appello.
disabled: true
- name: q
value: ""
type: query
description: |
il parametro consente di filtrare i campi con delle particolari condizioni predefinite, consultare la documentazione del metodo per verificare i codici che
è possibile utilizzare
disabled: true
- name: order
value: ""
type: query
description: |
consente di specificare un ordine per il recupero dei record. La sintassi è la seguente
* +/- : specifica l'ordinamento (+ = ASC, - = DESC); se omesso viene utilizzato +
* field : nome del campo da ordinare
E' possibile indicare più campi separandoli da virgola (Es: +annoCorso,+adCod)
disabled: true
- name: fields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera le misure compemnsative per i bisogni speciali della persona. La lista delle misure ha una data di validità e uno stato
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
**Utente: STUDENTE**
Profilo|Controllo| Funzione
-|-|-
STUDENTE|Permette la visualizzazione delle informazioni della persona dello studente|Security.checkStuPersId(persId)
**Valori parametro q :**
Valore|descrizione
-|-
PRENOTAZIONE|recupera solo le misure compensative valide per un determinato appello
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,159 @@
info:
name: recupero degli autorizzati legati ad una anagrafica
type: http
seq: 6
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/autorizzati/"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: autorizzatoId
value: ""
type: query
description: identificativo dell'autorizzato
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/autorizzati/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: autorizzatoId
value: ""
type: query
description: identificativo dell'autorizzato
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/autorizzati/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: autorizzatoId
value: ""
type: query
description: identificativo dell'autorizzato
disabled: true
- name: optionalFields
value: ""
type: query
description: |
specifica la lista dei campi opzionali (che non vengono recupeati di default);
impostando il valore `ALL` vengono mostrati tutti i campi.
Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*
I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)
Esempi
* per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
* Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
* Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Consente di recuperare gli autorizzati legati ad un'anagrafica.
Nel caso si volessero recuperare anche i documenti di identità legati ad un autorizzato, inserire in optionalFields ALL oppure documentiIdentita.
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : Autorizzato
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
autorizzatoId|primaryKey
documentiIdentita|optional
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson
@@ -0,0 +1,104 @@
info:
name: recupero dei tutori legati ad una anagrafica
type: http
seq: 20
tags:
- persone
http:
method: GET
url: "{{baseUrl}}/persone/:persId/tutori/"
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: filtroTutori
value: ""
type: query
description: "1: recupera tutti i tutori. 0 (o nullo): recupera solo i tutori validi."
disabled: true
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful response
request:
url: "{{baseUrl}}/persone/:persId/tutori/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: filtroTutori
value: ""
type: query
description: "1: recupera tutti i tutori. 0 (o nullo): recupera solo i tutori validi."
disabled: true
response:
status: 200
statusText: OK
body:
type: text
data: ""
- name: 422 Response
description: parametri Errati
request:
url: "{{baseUrl}}/persone/:persId/tutori/"
method: GET
params:
- name: persId
value: ""
type: path
description: identificativo della persona
- name: filtroTutori
value: ""
type: query
description: "1: recupera tutti i tutori. 0 (o nullo): recupera solo i tutori validi."
disabled: true
response:
status: 422
statusText: Unprocessable Entity
body:
type: text
data: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Consente di recuperare i tutori legati ad un'anagrafica.
Di default, vengono recuperati solo i tutori validi, ovvero con stato Attivo e data odierna compresa tra data inizio e data fine validità.
Nel caso si volessero recuperare anche i tutori non validi, impostare a 1 il parametro "filtroTutori".
**Estensioni:**
Codice Estensione|Valore|Nota
-|-|-
x-cache-type|lowRefreshRateUserIndependent|Risorsa che varia con frequenza bassa, cache Http abilitata, cache server abilitata. Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste)
**Controlli di sicurezza:**
======
_Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_
**Utente: USER_TECNICO**
Profilo|Controllo| Funzione
-|-|-
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
Classe di modello : DettaglioErroreAggiuntivo
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
rawValue|rawJson