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 forwardAuthorizationHeader: true 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: | 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