Files
api-collections/bruno/collections/ESSE3 Anagrafica API/persone/misure compensative per i bisogni speciali degli studeneti.yml

213 lines
7.7 KiB
YAML

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: 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
- name: persId
value: ""
type: path
description: identificativo della persona
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
forwardAuthorizationHeader: true
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