Files
api-collections/bruno/collections/ESSE3 Anagrafica API/docenti/getDocente.yml

175 lines
6.1 KiB
YAML

info:
name: getDocente
type: http
seq: 1
tags:
- docenti
http:
method: GET
url: "{{baseUrl}}/docenti/:docenteId"
params:
- 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: 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
- name: docenteId
value: ""
type: path
description: id del docente
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
forwardAuthorizationHeader: true
examples:
- name: 200 Response
description: successful operation
request:
url: "{{baseUrl}}/docenti/:docenteId"
method: GET
params:
- name: docenteId
value: ""
type: path
description: id del docente
- 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: 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: ""
docs: |
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span><span class="e3rest-deprecated-api"><span class="e3rest-deprecated-api-title">Attenzione!!</span><br/>Questo endpoint risulta <span class="e3rest-deprecated-api-bold">**deprecato**</span>.<br/>Verrà rimossa a partire dalla seguente data : <span class="e3rest-deprecated-api-bold">**30/06/2026.**</span><br/>Note: Utilizzare l'endpoint /docenti/{docenteId} su /docenti-service-v1</span>
**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
-|-|-
UserTecnicoMassivo|funzione massiva riservata ad utenti tecnici autorizzati|Security.checkMassiveGET()
**Utente: DOCENTE**
Profilo|Controllo| Funzione
-|-|-
DOCENTE|Permette la visualizzazione delle informazioni collegate ad una anagrafica docente|Security.checkDocenteId(docenteId)
Classe di modello : DocentiNew
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
docenteId|primaryKey
orario|optional
cariche|optional
docentiNote|optional
docentiRecapiti|optional
docentiAlias|optional
docentiProfili|optional
Classe di modello : DocentiOrario
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
docenteOrarioId|primaryKey
Classe di modello : DocentiNote
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
docenteId|primaryKey
Classe di modello : DocentiRecapiti
======
Estensioni sulle proprietà
----
Proprietà | x-field-type
-|-|
docenteId|primaryKey