From 094c389c46266874a51e783fcd7d1ca83658e9db Mon Sep 17 00:00:00 2001 From: Pier-Paolo Mammi Date: Mon, 20 Apr 2026 15:29:26 +0200 Subject: [PATCH] add initial ESSE3 collections --- ...ione allegato al documento di identità.yml | 128 ++++++ ...lazione allegato al tratto di carriera.yml | 113 +++++ .../ESSE3 Anagrafica API/allegati/folder.yml | 7 + ...tadati allegato dichiarazione handicap.yml | 86 ++++ ...o metadati allegato documento identità.yml | 86 ++++ ...o metadati allegato foto della persona.yml | 86 ++++ ...nserimento metadati allegato matricola.yml | 86 ++++ ...inserimento metadati allegato maturità.yml | 86 ++++ ...ti allegato relativo ad un autorizzato.yml | 86 ++++ ...documento d'identità di un autorizzato.yml | 86 ++++ ...allegato titolo universitario italiano.yml | 86 ++++ ...llegato titolo universitario straniero.yml | 86 ++++ ...tadati allegati dichiarazioni handicap.yml | 203 +++++++++ ...o metadati allegati documento identità.yml | 158 +++++++ .../recupero metadati allegati matricola.yml | 131 ++++++ .../recupero metadati allegati maturità.yml | 173 ++++++++ ...ti allegati relativi ad un autorizzato.yml | 131 ++++++ ...documenti d'identità di un autorizzato.yml | 158 +++++++ ... allegati titoli universitari italiani.yml | 158 +++++++ ...allegati titoli universitari stranieri.yml | 158 +++++++ ...ento dei consensi del soggetto esterno.yml | 122 ++++++ ...ono presenti dichiarazioni da valutare.yml | 95 +++++ .../Recupera le tipologie di handicap.yml | 95 +++++ .../Recupera le tipologie di parentele.yml | 71 ++++ .../anagrafica/Recupero atenei stranieri.yml | 168 ++++++++ .../anagrafica/Recupero atenei.yml | 158 +++++++ .../Recupero corsi di studio di un ateneo.yml | 221 ++++++++++ ... legate alle dichiarazioni di handicap.yml | 71 ++++ .../anagrafica/Recupero istituti.yml | 168 ++++++++ .../Recupero range voti maturità.yml | 50 +++ .../anagrafica/Recupero tipi cotutela.yml | 90 ++++ .../Recupero tipi istituto superiore.yml | 50 +++ .../Recupero tipi titoli scuola superiore.yml | 148 +++++++ .../Recupero tipi titoli stranieri.yml | 138 ++++++ ... di dichiarazione dei titoli stranieri.yml | 128 ++++++ .../anagrafica/folder.yml | 7 + .../autorizzati/folder.yml | 7 + ...upero delle regole di richiesta tutori.yml | 82 ++++ .../datiBancari/folder.yml | 7 + .../datiBancari/recupero dei dati bancari.yml | 156 +++++++ ...handicap legata ad un'anagrafica (PUT).yml | 110 +++++ ...ni di handicap legata ad un'anagrafica.yml | 116 +++++ ...cupera il blob dell'allegato richiesto.yml | 177 ++++++++ ...di invalidità di una anagrafica. (PUT).yml | 159 +++++++ ...azione di invalidità di una anagrafica.yml | 150 +++++++ .../dichiarazioni_invalidità/folder.yml | 7 + ...bisogni speciali degli studeneti (GET).yml | 117 ++++++ ...ni di handicap legate ad un'anagrafica.yml | 101 +++++ ...ni di handicap legata ad un'anagrafica.yml | 110 +++++ .../ESSE3 Anagrafica API/docenti/folder.yml | 7 + .../docenti/getDocente.yml | 173 ++++++++ .../dream_apply/folder.yml | 7 + ...ply e recupero dell’url di attivazione.yml | 120 ++++++ .../environments/ESSE3 Pre-Prod #2.yml | 8 + .../Recupero misure compensative.yml | 90 ++++ .../misure_compensative/folder.yml | 7 + .../ESSE3 Anagrafica API/opencollection.yml | 30 ++ ... indirizzo email istituzionale (PATCH).yml | 118 ++++++ ...mette un indirizzo email istituzionale.yml | 103 +++++ ...iornamento dei consensi dello studente.yml | 152 +++++++ ...ell'email istituzionale dello studente.yml | 116 +++++ ...to dell'email personale dello studente.yml | 118 ++++++ ...toli di studio relativi ad una persona.yml | 90 ++++ ... studio relativi ad una persona (POST).yml | 122 ++++++ ...toli di studio relativi ad una persona.yml | 134 ++++++ ...ra i consensi relativi ad uno studente.yml | 143 +++++++ ...i titoli relativi ad una persona (GET).yml | 219 ++++++++++ ...upera i titoli relativi ad una persona.yml | 201 +++++++++ ...Recupero della carriera degli studenti.yml | 89 ++++ ...e anagrafiche presenti a sistema (GET).yml | 235 +++++++++++ ...o delle anagrafiche presenti a sistema.yml | 397 ++++++++++++++++++ ...stema ed identificata dal persid (GET).yml | 77 ++++ ...e a sistema ed identificata dal persid.yml | 77 ++++ .../persone/aggiornamento cellulare.yml | 93 ++++ .../aggiornamento telefono di domicilio.yml | 93 ++++ .../aggiornamento telefono di residenza.yml | 93 ++++ .../ESSE3 Anagrafica API/persone/folder.yml | 7 + .../persone/getFotoPersona.yml | 93 ++++ .../persone/getValidaFlgFoto.yml | 93 ++++ ...per i bisogni speciali degli studeneti.yml | 211 ++++++++++ ...i autorizzati legati ad una anagrafica.yml | 159 +++++++ ...ro dei tutori legati ad una anagrafica.yml | 104 +++++ ...i dati di un soggetto esterno in esse3.yml | 109 +++++ ...i dati di un soggetto esterno in esse3.yml | 142 +++++++ ...nsensi relativi ad un soggetto esterno.yml | 113 +++++ .../Recupero dei soggetti esterni (1).yml | 147 +++++++ .../Recupero dei soggetti esterni (GET).yml | 305 ++++++++++++++ .../Recupero dei soggetti esterni.yml | 270 ++++++++++++ .../soggetti_esterni/folder.yml | 7 + .../autenticazione/changeUserPassword.yml | 65 +++ .../autenticazione/checkLogon.yml | 38 ++ .../autenticazione/checkSessionId.yml | 61 +++ .../autenticazione/folder.yml | 7 + .../autenticazione/getCacheParams.yml | 51 +++ .../autenticazione/getCurrentSession.yml | 157 +++++++ .../autenticazione/getJWT.yml | 63 +++ .../autenticazione/getLinguaCod.yml | 52 +++ .../autenticazione/login.yml | 180 ++++++++ .../autenticazione/logout.yml | 50 +++ .../autenticazione/setCacheParams.yml | 72 ++++ .../autenticazione/setLinguaCod.yml | 64 +++ .../ESSE3 Common Auth API/jwt/folder.yml | 7 + .../ESSE3 Common Auth API/jwt/getJWK.yml | 51 +++ .../ESSE3 Common Auth API/jwt/refreshJWT.yml | 90 ++++ .../ESSE3 Common Auth API/opencollection.yml | 34 ++ workspace.yml | 4 + 106 files changed, 11289 insertions(+) create mode 100644 collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al documento di identità.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al tratto di carriera.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato dichiarazione handicap.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato documento identità.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato foto della persona.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato matricola.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato maturità.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un autorizzato.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un documento d'identità di un autorizzato.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario italiano.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario straniero.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati dichiarazioni handicap.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati documento identità.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati matricola.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati maturità.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ad un autorizzato.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ai documenti d'identità di un autorizzato.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari italiani.yml create mode 100644 collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari stranieri.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Effettua l'aggiornamento dei consensi del soggetto esterno.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di parentele.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei stranieri.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero corsi di studio di un ateneo.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero delle normative legate alle dichiarazioni di handicap.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero istituti.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero range voti maturità.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi cotutela.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi istituto superiore.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli scuola superiore.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli stranieri.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/Recupero tipologie di dichiarazione dei titoli stranieri.yml create mode 100644 collections/ESSE3 Anagrafica API/anagrafica/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/autorizzati/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/autorizzati/recupero delle regole di richiesta tutori.yml create mode 100644 collections/ESSE3 Anagrafica API/datiBancari/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/datiBancari/recupero dei dati bancari.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica (PUT).yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Recupera il blob dell'allegato richiesto.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. (PUT).yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/misure compensative per i bisogni speciali degli studeneti (GET).yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero delle dichiarazioni di handicap legate ad un'anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero di una dichiarazioni di handicap legata ad un'anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/docenti/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/docenti/getDocente.yml create mode 100644 collections/ESSE3 Anagrafica API/dream_apply/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/dream_apply/refresh della data di scadenza del token dreamapply e recupero dell’url di attivazione.yml create mode 100644 collections/ESSE3 Anagrafica API/environments/ESSE3 Pre-Prod #2.yml create mode 100644 collections/ESSE3 Anagrafica API/misure_compensative/Recupero misure compensative.yml create mode 100644 collections/ESSE3 Anagrafica API/misure_compensative/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/opencollection.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale (PATCH).yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dei consensi dello studente.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email istituzionale dello studente.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email personale dello studente.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona (POST).yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupera i consensi relativi ad uno studente.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona (GET).yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupero della carriera degli studenti.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema (GET).yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid (GET).yml create mode 100644 collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/aggiornamento cellulare.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di domicilio.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di residenza.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/folder.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/getFotoPersona.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/getValidaFlgFoto.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/misure compensative per i bisogni speciali degli studeneti.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/recupero degli autorizzati legati ad una anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/persone/recupero dei tutori legati ad una anagrafica.yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Elimina i dati di un soggetto esterno in esse3.yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Inserisce oppure aggiorna i dati di un soggetto esterno in esse3.yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Recupera i consensi relativi ad un soggetto esterno.yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (1).yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (GET).yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni.yml create mode 100644 collections/ESSE3 Anagrafica API/soggetti_esterni/folder.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/changeUserPassword.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/checkLogon.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/checkSessionId.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/folder.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/getCacheParams.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/getCurrentSession.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/getJWT.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/getLinguaCod.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/login.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/logout.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/setCacheParams.yml create mode 100644 collections/ESSE3 Common Auth API/autenticazione/setLinguaCod.yml create mode 100644 collections/ESSE3 Common Auth API/jwt/folder.yml create mode 100644 collections/ESSE3 Common Auth API/jwt/getJWK.yml create mode 100644 collections/ESSE3 Common Auth API/jwt/refreshJWT.yml create mode 100644 collections/ESSE3 Common Auth API/opencollection.yml diff --git a/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al documento di identità.yml b/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al documento di identità.yml new file mode 100644 index 0000000..a2d4ae3 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al documento di identità.yml @@ -0,0 +1,128 @@ +info: + name: cancellazione allegato al documento di identità + type: http + seq: 6 + tags: + - allegati + +http: + method: DELETE + url: "{{baseUrl}}/allegati/docPers/:docPersId" + params: + - name: docPersId + value: "" + type: path + description: identificativo documento identità + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: persId + value: "" + type: query + description: identificativo della persona + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 204 Response + description: Delete succeded + request: + url: "{{baseUrl}}/allegati/docPers/:docPersId" + method: DELETE + params: + - name: docPersId + value: "" + type: path + description: identificativo documento identità + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: persId + value: "" + type: query + description: identificativo della persona + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + response: + status: 204 + statusText: No Content + body: + type: text + data: "" + - name: 422 Response + description: Parametri errati + request: + url: "{{baseUrl}}/allegati/docPers/:docPersId" + method: DELETE + params: + - name: docPersId + value: "" + type: path + description: identificativo documento identità + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: persId + value: "" + type: query + description: identificativo della persona + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare la cancellazione dell'allegato relativo al documento di identità + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al tratto di carriera.yml b/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al tratto di carriera.yml new file mode 100644 index 0000000..ac101da --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/cancellazione allegato al tratto di carriera.yml @@ -0,0 +1,113 @@ +info: + name: cancellazione allegato al tratto di carriera + type: http + seq: 5 + tags: + - allegati + +http: + method: DELETE + url: "{{baseUrl}}/allegati/carriere/:matId" + params: + - name: matId + value: "" + type: path + description: Identificativo tratto carriera studente + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 204 Response + description: Delete succeded + request: + url: "{{baseUrl}}/allegati/carriere/:matId" + method: DELETE + params: + - name: matId + value: "" + type: path + description: Identificativo tratto carriera studente + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + response: + status: 204 + statusText: No Content + body: + type: text + data: "" + - name: 422 Response + description: Parametri errati + request: + url: "{{baseUrl}}/allegati/carriere/:matId" + method: DELETE + params: + - name: matId + value: "" + type: path + description: Identificativo tratto carriera studente + - name: allegatoId + value: "" + type: query + description: identificativo allegato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare la cancellazione dell'allegato legato al tratto di 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() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/allegati/folder.yml b/collections/ESSE3 Anagrafica API/allegati/folder.yml new file mode 100644 index 0000000..617da0e --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/folder.yml @@ -0,0 +1,7 @@ +info: + name: allegati + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato dichiarazione handicap.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato dichiarazione handicap.yml new file mode 100644 index 0000000..32e0715 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato dichiarazione handicap.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato dichiarazione handicap + type: http + seq: 8 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato documento identità.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato documento identità.yml new file mode 100644 index 0000000..d71a299 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato documento identità.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato documento identità + type: http + seq: 10 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato foto della persona.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato foto della persona.yml new file mode 100644 index 0000000..0040623 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato foto della persona.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato foto della persona + type: http + seq: 11 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiFotoPersona/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiFotoPersona/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiFotoPersona/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato matricola.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato matricola.yml new file mode 100644 index 0000000..9b319a7 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato matricola.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato matricola + type: http + seq: 19 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + method: POST + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + method: POST + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato maturità.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato maturità.yml new file mode 100644 index 0000000..3bef9aa --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato maturità.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato maturità + type: http + seq: 13 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un autorizzato.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un autorizzato.yml new file mode 100644 index 0000000..da6cc29 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un autorizzato.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato relativo ad un autorizzato + type: http + seq: 2 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + method: POST + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + method: POST + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un documento d'identità di un autorizzato.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un documento d'identità di un autorizzato.yml new file mode 100644 index 0000000..142d596 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato relativo ad un documento d'identità di un autorizzato.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato relativo ad un documento d'identità di un autorizzato + type: http + seq: 4 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + method: POST + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + method: POST + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario italiano.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario italiano.yml new file mode 100644 index 0000000..fa7f301 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario italiano.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato titolo universitario italiano + type: http + seq: 15 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario straniero.yml b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario straniero.yml new file mode 100644 index 0000000..2400510 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/inserimento metadati allegato titolo universitario straniero.yml @@ -0,0 +1,86 @@ +info: + name: inserimento metadati allegato titolo universitario straniero + type: http + seq: 17 + tags: + - allegati + +http: + method: POST + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 201 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 201 + statusText: Created + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + method: POST + params: + - name: persId + value: "" + type: path + description: identificativo della persona + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di effettuare l'inserimento dei metadati di un nuovo allegato, sulla risposta è presente l'header location che consente di effettuare l'upload del blob collegato ai metadati + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati dichiarazioni handicap.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati dichiarazioni handicap.yml new file mode 100644 index 0000000..20c708b --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati dichiarazioni handicap.yml @@ -0,0 +1,203 @@ +info: + name: recupero metadati allegati dichiarazioni handicap + type: http + seq: 7 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + - name: dataDichiar + value: "" + type: query + description: data della dichiarazione + disabled: true + - name: dataIni + value: "" + type: query + description: data di inizio invalidità + disabled: true + - name: dataFine + value: "" + type: query + description: data di fine invalidità + disabled: true + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + - name: dataDichiar + value: "" + type: query + description: data della dichiarazione + disabled: true + - name: dataIni + value: "" + type: query + description: data di inizio invalidità + disabled: true + - name: dataFine + value: "" + type: query + description: data di fine invalidità + disabled: true + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDicHand/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + - name: dataDichiar + value: "" + type: query + description: data della dichiarazione + disabled: true + - name: dataIni + value: "" + type: query + description: data di inizio invalidità + disabled: true + - name: dataFine + value: "" + type: query + description: data di fine invalidità + disabled: true + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati delle dichiarazioni di handicap. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati documento identità.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati documento identità.yml new file mode 100644 index 0000000..caf601a --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati documento identità.yml @@ -0,0 +1,158 @@ +info: + name: recupero metadati allegati documento identità + type: http + seq: 9 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: docPersId + value: "" + type: query + description: identificativo documento identità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: docPersId + value: "" + type: query + description: identificativo documento identità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:persId/allegatiDocIdent/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: docPersId + value: "" + type: query + description: identificativo documento identità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati del documento identità. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati matricola.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati matricola.yml new file mode 100644 index 0000000..3a00ff8 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati matricola.yml @@ -0,0 +1,131 @@ +info: + name: recupero metadati allegati matricola + type: http + seq: 18 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + method: GET + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:stuId/allegatiMatricola/" + method: GET + params: + - name: stuId + value: "" + type: path + description: identificativo della carriera + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati della matricola. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati maturità.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati maturità.yml new file mode 100644 index 0000000..f3a0234 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati maturità.yml @@ -0,0 +1,173 @@ +info: + name: recupero metadati allegati maturità + type: http + seq: 12 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: annoMaturita + value: "" + type: query + description: anno di maturità, coincide con l'anno solare della data di conseguimento del diploma. Per esempio, anno scolastico 2019/2020, l'anno di diploma è 2020 + - name: idDiplomaMiur + value: "" + type: query + description: identificativo diploma MIUR + disabled: true + - name: dataMaturita + value: "" + type: query + description: data di maturità + disabled: true + - name: maturId + value: "" + type: query + description: identificativo della maturità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: annoMaturita + value: "" + type: query + description: anno di maturità, coincide con l'anno solare della data di conseguimento del diploma. Per esempio, anno scolastico 2019/2020, l'anno di diploma è 2020 + - name: idDiplomaMiur + value: "" + type: query + description: identificativo diploma MIUR + disabled: true + - name: dataMaturita + value: "" + type: query + description: data di maturità + disabled: true + - name: maturId + value: "" + type: query + description: identificativo della maturità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:persId/allegatiMatur/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: annoMaturita + value: "" + type: query + description: anno di maturità, coincide con l'anno solare della data di conseguimento del diploma. Per esempio, anno scolastico 2019/2020, l'anno di diploma è 2020 + - name: idDiplomaMiur + value: "" + type: query + description: identificativo diploma MIUR + disabled: true + - name: dataMaturita + value: "" + type: query + description: data di maturità + disabled: true + - name: maturId + value: "" + type: query + description: identificativo della maturità + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati di maturità. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ad un autorizzato.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ad un autorizzato.yml new file mode 100644 index 0000000..5998a17 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ad un autorizzato.yml @@ -0,0 +1,131 @@ +info: + name: recupero metadati allegati relativi ad un autorizzato + type: http + seq: 1 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + method: GET + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiAutorizzato/" + method: GET + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati relativi ad un autorizzato. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ai documenti d'identità di un autorizzato.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ai documenti d'identità di un autorizzato.yml new file mode 100644 index 0000000..d003a83 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati relativi ai documenti d'identità di un autorizzato.yml @@ -0,0 +1,158 @@ +info: + name: recupero metadati allegati relativi ai documenti d'identità di un autorizzato + type: http + seq: 3 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: autDocPersId + value: "" + type: query + description: identificativo documento identità autorizzato + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + method: GET + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: autDocPersId + value: "" + type: query + description: identificativo documento identità autorizzato + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/autorizzati/:autorizzatoId/allegatiDocPers/" + method: GET + params: + - name: autorizzatoId + value: "" + type: path + description: id dell'autorizzato + - name: docIdentTipoCod + value: "" + type: query + description: codice tipo di documento d'identità (CI - Carta Identità, PAT - Patente, PAS - Passaporto) + - name: autDocPersId + value: "" + type: query + description: identificativo documento identità autorizzato + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + - name: webVisFlg + value: "" + type: query + description: flag che indica se l'allegato risulta visibile da web o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati relativi ai documenti d'identità di un autorizzato. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari italiani.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari italiani.yml new file mode 100644 index 0000000..7c050a2 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari italiani.yml @@ -0,0 +1,158 @@ +info: + name: recupero metadati allegati titoli universitari italiani + type: http + seq: 14 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoTititCod + value: "" + type: query + description: codice tipo titolo italiano + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + disabled: true + - name: titItId + value: "" + type: query + description: identificativo del titolo + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoTititCod + value: "" + type: query + description: codice tipo titolo italiano + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + disabled: true + - name: titItId + value: "" + type: query + description: identificativo del titolo + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitIt/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: tipoTititCod + value: "" + type: query + description: codice tipo titolo italiano + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + disabled: true + - name: titItId + value: "" + type: query + description: identificativo del titolo + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati dei titoli universitari italiani. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari stranieri.yml b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari stranieri.yml new file mode 100644 index 0000000..784010c --- /dev/null +++ b/collections/ESSE3 Anagrafica API/allegati/recupero metadati allegati titoli universitari stranieri.yml @@ -0,0 +1,158 @@ +info: + name: recupero metadati allegati titoli universitari stranieri + type: http + seq: 16 + tags: + - allegati + +http: + method: GET + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + - name: tipoTitstCod + value: "" + type: query + description: codice tipo titolo straniero + disabled: true + - name: titStraId + value: "" + type: query + description: identificativo del titolo straniero + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + - name: tipoTitstCod + value: "" + type: query + description: codice tipo titolo straniero + disabled: true + - name: titStraId + value: "" + type: query + description: identificativo del titolo straniero + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/allegati/:persId/allegatiTitStra/" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: aaConsegTit + value: "" + type: query + description: Anno Accademico di conseguimento del titolo + - name: tipoTitstCod + value: "" + type: query + description: codice tipo titolo straniero + disabled: true + - name: titStraId + value: "" + type: query + description: identificativo del titolo straniero + disabled: true + - name: tipologiaAllegato + value: "" + type: query + description: tipologia dell'allegato relativo all'entità p17_tipologia_allegati + disabled: true + - name: validoFlg + value: "" + type: query + description: flag che indica se l'allegato risulta validato o meno + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + consente di recuperare i metadati degli allegati dei titoli universitari stranieri. Il blob dell'allegato può essere scaricato tramite l'api degli allegati utilizzando l'allegatoId e ed il tipoAssAllegato recuperato con questo servizio. + + **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 diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Effettua l'aggiornamento dei consensi del soggetto esterno.yml b/collections/ESSE3 Anagrafica API/anagrafica/Effettua l'aggiornamento dei consensi del soggetto esterno.yml new file mode 100644 index 0000000..64620ea --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Effettua l'aggiornamento dei consensi del soggetto esterno.yml @@ -0,0 +1,122 @@ +info: + name: Effettua l'aggiornamento dei consensi del soggetto esterno + type: http + seq: 7 + tags: + - anagrafica + +http: + method: PUT + url: "{{baseUrl}}/soggettiEsterni/:soggEstId/consensi" + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Update succeded + request: + url: "{{baseUrl}}/soggettiEsterni/:soggEstId/consensi" + method: PUT + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: aggiornamento non riuscito + request: + url: "{{baseUrl}}/soggettiEsterni/:soggEstId/consensi" + method: PUT + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Effettua l'aggiornamento dei consensi del soggetto esterno. + + 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 diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare.yml new file mode 100644 index 0000000..c5e62bf --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare.yml @@ -0,0 +1,95 @@ +info: + name: Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare. + type: http + seq: 14 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipologieHandicapDaValutare" + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipologieHandicapDaValutare" + method: GET + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + 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}}/tipologieHandicapDaValutare" + method: GET + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera le tipologie di handicap per cui sono presenti dichiarazioni da valutare. + + **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: DOCENTE** + + Profilo|Controllo| Funzione + -|-|- + DOCENTE|Permette la visualizzazione delle informazioni collegate ad una anagrafica docente|Security.checkDocenteId(docenteId) + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap.yml new file mode 100644 index 0000000..09656d5 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di handicap.yml @@ -0,0 +1,95 @@ +info: + name: Recupera le tipologie di handicap + type: http + seq: 13 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipologieHandicap" + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipologieHandicap" + method: GET + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + 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}}/tipologieHandicap" + method: GET + params: + - name: docenteId + value: "" + type: query + description: id univoco che consente di individuare l'account utente + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera le tipologie di handicap + + **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: DOCENTE** + + Profilo|Controllo| Funzione + -|-|- + DOCENTE|Permette la visualizzazione delle informazioni collegate ad una anagrafica docente|Security.checkDocenteId(docenteId) + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di parentele.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di parentele.yml new file mode 100644 index 0000000..cc1ef81 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupera le tipologie di parentele.yml @@ -0,0 +1,71 @@ +info: + name: Recupera le tipologie di parentele + type: http + seq: 15 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipologieParentele" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipologieParentele" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Parametri di ricerca errati o non coerenti. + request: + url: "{{baseUrl}}/tipologieParentele" + method: GET + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera le tipologie di parentele + + **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 diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei stranieri.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei stranieri.yml new file mode 100644 index 0000000..43b2d57 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei stranieri.yml @@ -0,0 +1,168 @@ +info: + name: Recupero atenei stranieri + type: http + seq: 3 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/ateneiStranieri" + params: + - name: erasmusCod + value: "" + type: query + description: Codice Erasmus ateneo + disabled: true + - name: ateneoStranieroId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: nazioneCodFisc + value: "" + type: query + description: Codice fiscale della nazione + disabled: true + - name: nazioneOrdCodFisc + value: "" + type: query + description: Codice fiscale della nazione di ordinamento + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/ateneiStranieri" + method: GET + params: + - name: erasmusCod + value: "" + type: query + description: Codice Erasmus ateneo + disabled: true + - name: ateneoStranieroId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: nazioneCodFisc + value: "" + type: query + description: Codice fiscale della nazione + disabled: true + - name: nazioneOrdCodFisc + value: "" + type: query + description: Codice fiscale della nazione di ordinamento + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce gli atenei stranieri configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei.yml new file mode 100644 index 0000000..0fa2843 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero atenei.yml @@ -0,0 +1,158 @@ +info: + name: Recupero atenei + type: http + seq: 1 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/atenei" + params: + - name: istatCod + value: "" + type: query + description: Codice ISTAT dell'ateneo + disabled: true + - name: ateneoId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: codeUn + value: "" + type: query + description: Codice università MIUR + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/atenei" + method: GET + params: + - name: istatCod + value: "" + type: query + description: Codice ISTAT dell'ateneo + disabled: true + - name: ateneoId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: codeUn + value: "" + type: query + description: Codice università MIUR + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce gli atenei configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero corsi di studio di un ateneo.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero corsi di studio di un ateneo.yml new file mode 100644 index 0000000..64a0cde --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero corsi di studio di un ateneo.yml @@ -0,0 +1,221 @@ +info: + name: Recupero corsi di studio di un ateneo + type: http + seq: 2 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/atenei/corsi" + params: + - name: erasmusCod + value: "" + type: query + description: Codice Erasmus ateneo + disabled: true + - name: ateneoId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: istatCod + value: "" + type: query + description: Codice ISTAT dell'ateneo + disabled: true + - name: codeUn + value: "" + type: query + description: Codice università MIUR + disabled: true + - name: tipoCorsoCod + value: "" + type: query + description: Codice tipo corso di studio. + 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: 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/atenei/corsi" + method: GET + params: + - name: erasmusCod + value: "" + type: query + description: Codice Erasmus ateneo + disabled: true + - name: ateneoId + value: "" + type: query + description: id univoco ateneo + disabled: true + - name: istatCod + value: "" + type: query + description: Codice ISTAT dell'ateneo + disabled: true + - name: codeUn + value: "" + type: query + description: Codice università MIUR + disabled: true + - name: tipoCorsoCod + value: "" + type: query + description: Codice tipo corso di studio. + 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: 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce i corsi di studio di un altro ateneo che sono configurati su esse3. + Opzionalmente, è possibile recuperare anche le classi associate al corso di studio tramite il parametro optionalFields. + + + **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 : CorsoDiStudio + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + cdsAteId|primaryKey + classe|optional diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero delle normative legate alle dichiarazioni di handicap.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero delle normative legate alle dichiarazioni di handicap.yml new file mode 100644 index 0000000..ee8df86 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero delle normative legate alle dichiarazioni di handicap.yml @@ -0,0 +1,71 @@ +info: + name: Recupero delle normative legate alle dichiarazioni di handicap + type: http + seq: 5 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/normativeHandicap" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/normativeHandicap" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Parametri di ricerca errati o non coerenti. + request: + url: "{{baseUrl}}/normativeHandicap" + method: GET + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupero delle normative legate alle dichiarazioni di handicap + + **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 diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero istituti.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero istituti.yml new file mode 100644 index 0000000..12da102 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero istituti.yml @@ -0,0 +1,168 @@ +info: + name: Recupero istituti + type: http + seq: 4 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/istituti" + params: + - name: tipologiaScuolaCod + value: "" + type: query + description: Codice della tipologia della scuola. + disabled: true + - name: scuolaMiurCod + value: "" + type: query + description: Codice meccanografico della scuola. + disabled: true + - name: scuolaSupId + value: "" + type: query + description: Identificativo della scuola. + disabled: true + - name: scuolaMiurId + value: "" + type: query + description: Identificativo scuola MIUR. + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/istituti" + method: GET + params: + - name: tipologiaScuolaCod + value: "" + type: query + description: Codice della tipologia della scuola. + disabled: true + - name: scuolaMiurCod + value: "" + type: query + description: Codice meccanografico della scuola. + disabled: true + - name: scuolaSupId + value: "" + type: query + description: Identificativo della scuola. + disabled: true + - name: scuolaMiurId + value: "" + type: query + description: Identificativo scuola MIUR. + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce gli istituti configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero range voti maturità.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero range voti maturità.yml new file mode 100644 index 0000000..d81c9de --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero range voti maturità.yml @@ -0,0 +1,50 @@ +info: + name: Recupero range voti maturità + type: http + seq: 6 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/rangeVotiMaturita" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/rangeVotiMaturita" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce i range dei voti di maturità configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi cotutela.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi cotutela.yml new file mode 100644 index 0000000..802bea4 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi cotutela.yml @@ -0,0 +1,90 @@ +info: + name: Recupero tipi cotutela + type: http + seq: 8 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipiCotutela" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipiCotutela" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Parametri di ricerca errati o non coerenti. + request: + url: "{{baseUrl}}/tipiCotutela" + method: GET + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupero tipi cotutela + + **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: SEGRETERIA** + + Profilo|Controllo| Funzione + -|-|- + UTENTE_PTA|funzione accessibile alle utenze del personale tecnico amministrativo per accessi ai servizi REST|Security.checkUserPtaNoDataCheck() + UTENTE_PTA_ADMIN|funzione accessibile alle utenze del personale ADMINISTRATOR per accessi ai servizi REST|Security.checkUserPtaAdmin() + + **Utente: DOCENTE** + + Profilo|Controllo| Funzione + -|-|- + DOCENTE|funzione accessibile alle utenze di tipo docente|Security.checkDocente() + + **Utente: SOGG_EST** + + Profilo|Controllo| Funzione + -|-|- + SOGG_EST|Permette la visualizzazione delle informazioni collegate ad una anagrafica soggetto esterno|Security.checkSoggettoEsterno() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi istituto superiore.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi istituto superiore.yml new file mode 100644 index 0000000..ef8f02e --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi istituto superiore.yml @@ -0,0 +1,50 @@ +info: + name: Recupero tipi istituto superiore + type: http + seq: 9 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipiIstituto" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipiIstituto" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce le tipologie di istituti superiori configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli scuola superiore.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli scuola superiore.yml new file mode 100644 index 0000000..0434084 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli scuola superiore.yml @@ -0,0 +1,148 @@ +info: + name: Recupero tipi titoli scuola superiore + type: http + seq: 10 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipiTitoliScuolaSup" + params: + - name: tipologiaTitoloCod + value: "" + type: query + description: Codice della tipologia del titolo superiore. + disabled: true + - name: tipoTitoloCod + value: "" + type: query + description: Codice MIUR del tipo di titolo superiore. + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipiTitoliScuolaSup" + method: GET + params: + - name: tipologiaTitoloCod + value: "" + type: query + description: Codice della tipologia del titolo superiore. + disabled: true + - name: tipoTitoloCod + value: "" + type: query + description: Codice MIUR del tipo di titolo superiore. + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce la tipologia dei titoli delle scuole superiori configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli stranieri.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli stranieri.yml new file mode 100644 index 0000000..b0e8727 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipi titoli stranieri.yml @@ -0,0 +1,138 @@ +info: + name: Recupero tipi titoli stranieri + type: http + seq: 11 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipiTitoliStranieri" + params: + - name: livelloCod + value: "" + type: query + description: Indica se il titolo è di livello universitario (U) o di livello di scuola superiore (S). + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipiTitoliStranieri" + method: GET + params: + - name: livelloCod + value: "" + type: query + description: Indica se il titolo è di livello universitario (U) o di livello di scuola superiore (S). + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce la tipologia dei titoli stranieri configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipologie di dichiarazione dei titoli stranieri.yml b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipologie di dichiarazione dei titoli stranieri.yml new file mode 100644 index 0000000..0ca978e --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/Recupero tipologie di dichiarazione dei titoli stranieri.yml @@ -0,0 +1,128 @@ +info: + name: Recupero tipologie di dichiarazione dei titoli stranieri + type: http + seq: 12 + tags: + - anagrafica + +http: + method: GET + url: "{{baseUrl}}/tipologieDichiarazioneValoreTitoloStraniero" + 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tipologieDichiarazioneValoreTitoloStraniero" + method: GET + 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce le tipologie di dichiarazione dei titoli stranieri configurati su esse3. + + **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() diff --git a/collections/ESSE3 Anagrafica API/anagrafica/folder.yml b/collections/ESSE3 Anagrafica API/anagrafica/folder.yml new file mode 100644 index 0000000..e2dafeb --- /dev/null +++ b/collections/ESSE3 Anagrafica API/anagrafica/folder.yml @@ -0,0 +1,7 @@ +info: + name: anagrafica + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/autorizzati/folder.yml b/collections/ESSE3 Anagrafica API/autorizzati/folder.yml new file mode 100644 index 0000000..f708983 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/autorizzati/folder.yml @@ -0,0 +1,7 @@ +info: + name: autorizzati + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/autorizzati/recupero delle regole di richiesta tutori.yml b/collections/ESSE3 Anagrafica API/autorizzati/recupero delle regole di richiesta tutori.yml new file mode 100644 index 0000000..efc38be --- /dev/null +++ b/collections/ESSE3 Anagrafica API/autorizzati/recupero delle regole di richiesta tutori.yml @@ -0,0 +1,82 @@ +info: + name: recupero delle regole di richiesta tutori + type: http + seq: 1 + tags: + - autorizzati + +http: + method: GET + url: "{{baseUrl}}/tutori/regoleRichiesta/" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/tutori/regoleRichiesta/" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/tutori/regoleRichiesta/" + method: GET + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Consente di recuperare le regole di richiesta tutori. + + + **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 : TestataRegoleTutori + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + regTutoriTstId|primaryKey + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/datiBancari/folder.yml b/collections/ESSE3 Anagrafica API/datiBancari/folder.yml new file mode 100644 index 0000000..b2e7eff --- /dev/null +++ b/collections/ESSE3 Anagrafica API/datiBancari/folder.yml @@ -0,0 +1,7 @@ +info: + name: datiBancari + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/datiBancari/recupero dei dati bancari.yml b/collections/ESSE3 Anagrafica API/datiBancari/recupero dei dati bancari.yml new file mode 100644 index 0000000..9687e28 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/datiBancari/recupero dei dati bancari.yml @@ -0,0 +1,156 @@ +info: + name: recupero dei dati bancari + type: http + seq: 1 + tags: + - datiBancari + +http: + method: GET + url: "{{baseUrl}}/datiBancari/:persId" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - 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}}/datiBancari/:persId" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - 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}}/datiBancari/:persId" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - 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: | + Consente di recuperare i dati bancari. + + + **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 diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica (PUT).yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica (PUT).yml new file mode 100644 index 0000000..509204b --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica (PUT).yml @@ -0,0 +1,110 @@ +info: + name: Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica (PUT) + type: http + seq: 6 + tags: + - dichiarazioni_invalidità + +http: + method: PUT + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Aggiornamento dei dati relativi ad una dichiarazione di invalidità con identificatico 'dicHandId', per la persona con identificativo '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: 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 diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica.yml new file mode 100644 index 0000000..727bbf2 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica.yml @@ -0,0 +1,116 @@ +info: + name: Aggiornamento di una dichiarazioni di handicap legata ad un'anagrafica + type: http + seq: 4 + tags: + - dichiarazioni_invalidità + +http: + method: PUT + url: "{{baseUrl}}/persone/:persId/dicHand" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + 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/dicHand" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/dicHand" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Aggiornamento dei dati relativi ad una dichiarazione di invalidità, per la persona con identificativo 'persId'. Permette di aggiornare sia per identificativo della dichiarazione che per tipologia di handicap. Nel caso si filtri solo per tipoHandicap, verrà aggiornata la dichiarazione non annullata più recente per quella tipologia. Nel caso sia tipoHandicap che dicHandId siano nulli, verrà aggiornata la dichiarazione non annullata più recente. + + **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 diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Recupera il blob dell'allegato richiesto.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Recupera il blob dell'allegato richiesto.yml new file mode 100644 index 0000000..82fac3b --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/Recupera il blob dell'allegato richiesto.yml @@ -0,0 +1,177 @@ +info: + name: Recupera il blob dell'allegato richiesto + type: http + seq: 7 + tags: + - dichiarazioni_invalidità + +http: + method: GET + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId/allegatiDicHand/:allegatoId/blob" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: allegatoId + value: "" + type: path + description: identificativo allegato + - name: userId + value: "" + type: query + description: userId + 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/dicHand/:dicHandId/allegatiDicHand/:allegatoId/blob" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: allegatoId + value: "" + type: path + description: identificativo allegato + - name: userId + value: "" + type: query + description: userId + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 404 Response + description: Allegato non trovato + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId/allegatiDicHand/:allegatoId/blob" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: allegatoId + value: "" + type: path + description: identificativo allegato + - name: userId + value: "" + type: query + description: userId + disabled: true + response: + status: 404 + statusText: Not Found + body: + type: text + data: "" + - name: 422 Response + description: Errore + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId/allegatiDicHand/:allegatoId/blob" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: allegatoId + value: "" + type: path + description: identificativo allegato + - name: userId + value: "" + type: query + description: userId + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera il blob dell'allegato + + + **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: 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 + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. (PUT).yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. (PUT).yml new file mode 100644 index 0000000..4fb4006 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. (PUT).yml @@ -0,0 +1,159 @@ +info: + name: effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. (PUT) + type: http + seq: 2 + tags: + - dichiarazioni_invalidità + +http: + method: PUT + url: "{{baseUrl}}/persone/:persId/dic-hand/:dicHandId/misure-compensative-dicHand/:dicHandMisureId" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: path + description: Identificativo associazione dichiarazione e misura compensativa. + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + 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/dic-hand/:dicHandId/misure-compensative-dicHand/:dicHandMisureId" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: path + description: Identificativo associazione dichiarazione e misura compensativa. + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/dic-hand/:dicHandId/misure-compensative-dicHand/:dicHandMisureId" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: path + description: Identificativo associazione dichiarazione e misura compensativa. + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. + + ##### 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 diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica.yml new file mode 100644 index 0000000..92c096e --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica.yml @@ -0,0 +1,150 @@ +info: + name: effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. + type: http + seq: 1 + tags: + - dichiarazioni_invalidità + +http: + method: PUT + url: "{{baseUrl}}/persone/:persId/agg-dicHandMisComp" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: query + description: Identificativo associazione dichiarazione e misura compensativa. + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + 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/agg-dicHandMisComp" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: query + description: Identificativo associazione dichiarazione e misura compensativa. + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/agg-dicHandMisComp" + method: PUT + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + - name: dicHandMisureId + value: "" + type: query + description: Identificativo associazione dichiarazione e misura compensativa. + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + - name: misuraCompensativaCod + value: "" + type: query + description: codice misura compensativa + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + effettua l'aggiornamento dei dettagli di una misura compensative associate alla dichiarazione di invalidità di una anagrafica. + + ##### 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 diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/folder.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/folder.yml new file mode 100644 index 0000000..f4cf508 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/folder.yml @@ -0,0 +1,7 @@ +info: + name: dichiarazioni_invalidità + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/misure compensative per i bisogni speciali degli studeneti (GET).yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/misure compensative per i bisogni speciali degli studeneti (GET).yml new file mode 100644 index 0000000..d26e0ef --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/misure compensative per i bisogni speciali degli studeneti (GET).yml @@ -0,0 +1,117 @@ +info: + name: misure compensative per i bisogni speciali degli studeneti (GET) + type: http + seq: 8 + tags: + - dichiarazioni_invalidità + +http: + method: GET + url: "{{baseUrl}}/persone/:persId/misure-compensative-dicHand" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + 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-dicHand" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Parametri Errati + request: + url: "{{baseUrl}}/persone/:persId/misure-compensative-dicHand" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera le misure compensative per i bisogni speciali della 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() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero delle dichiarazioni di handicap legate ad un'anagrafica.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero delle dichiarazioni di handicap legate ad un'anagrafica.yml new file mode 100644 index 0000000..8ac5764 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero delle dichiarazioni di handicap legate ad un'anagrafica.yml @@ -0,0 +1,101 @@ +info: + name: recupero delle dichiarazioni di handicap legate ad un'anagrafica + type: http + seq: 3 + tags: + - dichiarazioni_invalidità + +http: + method: GET + url: "{{baseUrl}}/persone/:persId/dicHand" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + 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/dicHand" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/dicHand" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: query + description: identificativo dichiarazione invalidità + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Permette di recuperare tutte le dichiarazioni legate ad un'anagrafica oppure una in particolare filtrando per identificatico della dichiarazione. + + **Estensioni:** + + Codice Estensione|Valore|Nota + -|-|- + x-cache-type|midRefreshRateUserDependent|Risorsa che varia con frequenza media, 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() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero di una dichiarazioni di handicap legata ad un'anagrafica.yml b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero di una dichiarazioni di handicap legata ad un'anagrafica.yml new file mode 100644 index 0000000..af87214 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dichiarazioni_invalidità/recupero di una dichiarazioni di handicap legata ad un'anagrafica.yml @@ -0,0 +1,110 @@ +info: + name: recupero di una dichiarazioni di handicap legata ad un'anagrafica + type: http + seq: 5 + tags: + - dichiarazioni_invalidità + +http: + method: GET + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/persone/:persId/dicHand/:dicHandId" + method: GET + params: + - name: persId + value: "" + type: path + description: identificativo della persona + - name: dicHandId + value: "" + type: path + description: identificativo dichiarazione invalidità + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Permette di recuperare una dichiarazione di invalidità legata ad un'anagrafica, filtrando per identificatico anagrafica e identificativo dichiarazione. + + **Estensioni:** + + Codice Estensione|Valore|Nota + -|-|- + x-cache-type|highRefreshRateUserDependent|Risorsa che varia con frequenza elevata, 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: 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 diff --git a/collections/ESSE3 Anagrafica API/docenti/folder.yml b/collections/ESSE3 Anagrafica API/docenti/folder.yml new file mode 100644 index 0000000..a1a3987 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/docenti/folder.yml @@ -0,0 +1,7 @@ +info: + name: docenti + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/docenti/getDocente.yml b/collections/ESSE3 Anagrafica API/docenti/getDocente.yml new file mode 100644 index 0000000..5b44cb0 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/docenti/getDocente.yml @@ -0,0 +1,173 @@ +info: + name: getDocente + type: http + seq: 1 + tags: + - docenti + +http: + method: GET + url: "{{baseUrl}}/docenti/:docenteId" + 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +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: | + Attenzione!!
Questo endpoint risulta **deprecato**.
Verrà rimossa a partire dalla seguente data : **30/06/2026.**
Note: Utilizzare l'endpoint /docenti/{docenteId} su /docenti-service-v1 + + + **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 diff --git a/collections/ESSE3 Anagrafica API/dream_apply/folder.yml b/collections/ESSE3 Anagrafica API/dream_apply/folder.yml new file mode 100644 index 0000000..67da2c6 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dream_apply/folder.yml @@ -0,0 +1,7 @@ +info: + name: dream_apply + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/dream_apply/refresh della data di scadenza del token dreamapply e recupero dell’url di attivazione.yml b/collections/ESSE3 Anagrafica API/dream_apply/refresh della data di scadenza del token dreamapply e recupero dell’url di attivazione.yml new file mode 100644 index 0000000..cede0f4 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/dream_apply/refresh della data di scadenza del token dreamapply e recupero dell’url di attivazione.yml @@ -0,0 +1,120 @@ +info: + name: refresh della data di scadenza del token dreamapply e recupero dell’url di attivazione + type: http + seq: 1 + tags: + - dream_apply + +http: + method: PUT + url: "{{baseUrl}}/activation-url:applicationId" + params: + - name: applicationId + value: "123456" + type: path + description: id esterno della carriera per dreamapply + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Update succeded + request: + url: "{{baseUrl}}/activation-url:applicationId" + method: PUT + params: + - name: applicationId + value: "" + type: path + description: id esterno della carriera per dreamapply + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 404 Response + description: ApplicationId non valido + request: + url: "{{baseUrl}}/activation-url:applicationId" + method: PUT + params: + - name: applicationId + value: "" + type: path + description: id esterno della carriera per dreamapply + response: + status: 404 + statusText: Not Found + body: + type: text + data: "" + - name: 422 Response + description: aggiornamento non riuscito + request: + url: "{{baseUrl}}/activation-url:applicationId" + method: PUT + params: + - name: applicationId + value: "" + type: path + description: id esterno della carriera per dreamapply + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + servizion che provvede al refresh della data di scadenza del token dreamapply e al recupero dell’url di attivazione con token eventualmente aggiornando la domanda in stato A. + + ##### Codici di ritorno della funzione + Codice di Ritorno | Descrizione + - | - + -1 | Errore generico + 0 | Carriera non attivabile + 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 diff --git a/collections/ESSE3 Anagrafica API/environments/ESSE3 Pre-Prod #2.yml b/collections/ESSE3 Anagrafica API/environments/ESSE3 Pre-Prod #2.yml new file mode 100644 index 0000000..4a96185 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/environments/ESSE3 Pre-Prod #2.yml @@ -0,0 +1,8 @@ +name: "ESSE3 Pre-Prod #2" +variables: + - name: rootUrl + value: https://unipr2.esse3.pp.cineca.it + - name: esse3apiUsername + value: "{{process.env.apiUsername}}" + - name: esse3apiPassword + value: "{{process.env.apiPassword}}" diff --git a/collections/ESSE3 Anagrafica API/misure_compensative/Recupero misure compensative.yml b/collections/ESSE3 Anagrafica API/misure_compensative/Recupero misure compensative.yml new file mode 100644 index 0000000..3a4e18d --- /dev/null +++ b/collections/ESSE3 Anagrafica API/misure_compensative/Recupero misure compensative.yml @@ -0,0 +1,90 @@ +info: + name: Recupero misure compensative + type: http + seq: 1 + tags: + - misure_compensative + +http: + method: GET + url: "{{baseUrl}}/misureCompensative" + params: + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/misureCompensative" + method: GET + params: + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Parametri Errati + request: + url: "{{baseUrl}}/misureCompensative" + method: GET + params: + - name: tipoHandicap + value: "" + type: query + description: tipo di handicap + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera le misure compemnsative + + + **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: ALL** + + Profilo|Controllo| Funzione + -|-|- + ALL|Funzione Pubblica|Security.checkDummy() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/misure_compensative/folder.yml b/collections/ESSE3 Anagrafica API/misure_compensative/folder.yml new file mode 100644 index 0000000..bdbf4cb --- /dev/null +++ b/collections/ESSE3 Anagrafica API/misure_compensative/folder.yml @@ -0,0 +1,7 @@ +info: + name: misure_compensative + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/opencollection.yml b/collections/ESSE3 Anagrafica API/opencollection.yml new file mode 100644 index 0000000..7bca13a --- /dev/null +++ b/collections/ESSE3 Anagrafica API/opencollection.yml @@ -0,0 +1,30 @@ +opencollection: 1.0.0 + +info: + name: ESSE3 Anagrafica API +config: + proxy: + inherit: true + config: + protocol: http + hostname: "" + port: "" + auth: + username: "" + password: "" + bypassProxy: "" + +request: + auth: + type: basic + username: "{{esse3apiUsername}}" + password: "{{esse3apiPassword}}" + variables: + - name: baseUrl + value: "{{rootUrl}}/e3rest/api/anagrafica-service-v2" +bundled: false +extensions: + bruno: + ignore: + - node_modules + - .git diff --git a/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale (PATCH).yml b/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale (PATCH).yml new file mode 100644 index 0000000..31dc96c --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale (PATCH).yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale.yml b/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale.yml new file mode 100644 index 0000000..bc3dd54 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Dismette un indirizzo email istituzionale.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dei consensi dello studente.yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dei consensi dello studente.yml new file mode 100644 index 0000000..b9adddf --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dei consensi dello studente.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email istituzionale dello studente.yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email istituzionale dello studente.yml new file mode 100644 index 0000000..926805f --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email istituzionale dello studente.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email personale dello studente.yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email personale dello studente.yml new file mode 100644 index 0000000..912eba2 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento dell'email personale dello studente.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona.yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona.yml new file mode 100644 index 0000000..dcea106 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'aggiornamento o l'inserimento dei titoli di studio relativi ad una persona.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona (POST).yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona (POST).yml new file mode 100644 index 0000000..add2dfc --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona (POST).yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona.yml b/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona.yml new file mode 100644 index 0000000..e7edf80 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Effettua l'inserimento dei titoli di studio relativi ad una persona.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupera i consensi relativi ad uno studente.yml b/collections/ESSE3 Anagrafica API/persone/Recupera i consensi relativi ad uno studente.yml new file mode 100644 index 0000000..bc82b09 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupera i consensi relativi ad uno studente.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona (GET).yml b/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona (GET).yml new file mode 100644 index 0000000..ff11f6f --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona (GET).yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona.yml b/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona.yml new file mode 100644 index 0000000..42d1dfa --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupera i titoli relativi ad una persona.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupero della carriera degli studenti.yml b/collections/ESSE3 Anagrafica API/persone/Recupero della carriera degli studenti.yml new file mode 100644 index 0000000..6ecb348 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupero della carriera degli studenti.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema (GET).yml b/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema (GET).yml new file mode 100644 index 0000000..f63fdc2 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema (GET).yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema.yml b/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema.yml new file mode 100644 index 0000000..ad7ddd7 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupero delle anagrafiche presenti a sistema.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid (GET).yml b/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid (GET).yml new file mode 100644 index 0000000..9dde4d8 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid (GET).yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid.yml b/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid.yml new file mode 100644 index 0000000..4c08632 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/Recupero delle informazioni relative ad una singola persona presente a sistema ed identificata dal persid.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/aggiornamento cellulare.yml b/collections/ESSE3 Anagrafica API/persone/aggiornamento cellulare.yml new file mode 100644 index 0000000..4434524 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/aggiornamento cellulare.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di domicilio.yml b/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di domicilio.yml new file mode 100644 index 0000000..4c51cd3 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di domicilio.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di residenza.yml b/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di residenza.yml new file mode 100644 index 0000000..6290c1a --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/aggiornamento telefono di residenza.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/folder.yml b/collections/ESSE3 Anagrafica API/persone/folder.yml new file mode 100644 index 0000000..019b817 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/folder.yml @@ -0,0 +1,7 @@ +info: + name: persone + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Anagrafica API/persone/getFotoPersona.yml b/collections/ESSE3 Anagrafica API/persone/getFotoPersona.yml new file mode 100644 index 0000000..58eb6eb --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/getFotoPersona.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/getValidaFlgFoto.yml b/collections/ESSE3 Anagrafica API/persone/getValidaFlgFoto.yml new file mode 100644 index 0000000..5df625e --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/getValidaFlgFoto.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/misure compensative per i bisogni speciali degli studeneti.yml b/collections/ESSE3 Anagrafica API/persone/misure compensative per i bisogni speciali degli studeneti.yml new file mode 100644 index 0000000..7f9b345 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/misure compensative per i bisogni speciali degli studeneti.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/recupero degli autorizzati legati ad una anagrafica.yml b/collections/ESSE3 Anagrafica API/persone/recupero degli autorizzati legati ad una anagrafica.yml new file mode 100644 index 0000000..399a7f2 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/recupero degli autorizzati legati ad una anagrafica.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/persone/recupero dei tutori legati ad una anagrafica.yml b/collections/ESSE3 Anagrafica API/persone/recupero dei tutori legati ad una anagrafica.yml new file mode 100644 index 0000000..8989e8a --- /dev/null +++ b/collections/ESSE3 Anagrafica API/persone/recupero dei tutori legati ad una anagrafica.yml @@ -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: | + 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 diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Elimina i dati di un soggetto esterno in esse3.yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Elimina i dati di un soggetto esterno in esse3.yml new file mode 100644 index 0000000..a5513d8 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Elimina i dati di un soggetto esterno in esse3.yml @@ -0,0 +1,109 @@ +info: + name: Elimina i dati di un soggetto esterno in esse3 + type: http + seq: 3 + tags: + - soggetti_esterni + +http: + method: DELETE + url: "{{baseUrl}}/soggettiEsterni/:soggEstId" + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 204 Response + description: Update succeded + request: + url: "{{baseUrl}}/soggettiEsterni/:soggEstId" + method: DELETE + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + response: + status: 204 + statusText: No Content + body: + type: text + data: "" + - name: 422 Response + description: aggiornamento non riuscito + request: + url: "{{baseUrl}}/soggettiEsterni/:soggEstId" + method: DELETE + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Il servizio prevede l'indicazione di SOGG_EST_ID per identificare l'eventuale soggetto esterno da eliminare. Il servizio avrà come valore di ritorno un json contenente i dati del soggetto esterno eliminato. + + + **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 : SoggettoEsterno + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + soggEstAlias|optional + soggEstProfili|optional + + + Classe di modello : SoggEstProfili + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Inserisce oppure aggiorna i dati di un soggetto esterno in esse3.yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Inserisce oppure aggiorna i dati di un soggetto esterno in esse3.yml new file mode 100644 index 0000000..e51b552 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Inserisce oppure aggiorna i dati di un soggetto esterno in esse3.yml @@ -0,0 +1,142 @@ +info: + name: Inserisce oppure aggiorna i dati di un soggetto esterno in esse3 + type: http + seq: 2 + tags: + - soggetti_esterni + +http: + method: PUT + url: "{{baseUrl}}/soggettiEsterni" + params: + - 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: Update succeded + request: + url: "{{baseUrl}}/soggettiEsterni" + method: PUT + params: + - 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: aggiornamento non riuscito + request: + url: "{{baseUrl}}/soggettiEsterni" + method: PUT + params: + - 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: | + Il servizio prevede l'indicazione di SOGG_EST_ID o COD_FIS o ID_AB per identificare l'eventuale soggetto esterno da aggiornare. Se sono tutti nulli sarà creato un nuovo soggetto esterno, altrimenti si procede all'aggiornamento. + + + **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 : SoggettoEsterno + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + soggEstAlias|optional + soggEstProfili|optional + + + Classe di modello : SoggEstProfili + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupera i consensi relativi ad un soggetto esterno.yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupera i consensi relativi ad un soggetto esterno.yml new file mode 100644 index 0000000..d42f30b --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupera i consensi relativi ad un soggetto esterno.yml @@ -0,0 +1,113 @@ +info: + name: Recupera i consensi relativi ad un soggetto esterno + type: http + seq: 4 + tags: + - soggetti_esterni + +http: + method: GET + url: "{{baseUrl}}/soggettiEsterni/:soggEstId/consensi" + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/soggettiEsterni/:soggEstId/consensi" + method: GET + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + 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}}/soggettiEsterni/:soggEstId/consensi" + method: GET + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - name: procWebCod + value: "" + type: query + description: Codice processo WEB + - name: iso6392Cod + value: "" + type: query + description: Codice ISO lingua + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Recupera i consensi relativi ad un soggetto esterno + + **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 diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (1).yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (1).yml new file mode 100644 index 0000000..9529e73 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (1).yml @@ -0,0 +1,147 @@ +info: + name: Recupero dei soggetti esterni (1) + type: http + seq: 6 + tags: + - soggetti_esterni + +http: + method: GET + url: "{{baseUrl}}/soggettiEsterniReplica/:soggEstId" + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - 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}}/soggettiEsterniReplica/:soggEstId" + method: GET + params: + - name: soggEstId + value: "" + type: path + description: Identificativo soggetto esterno + - 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: | + Fornisce i soggetti esterni configurati su esse3. + + **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 : ReplicaSoggettoEsterno + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + consensiSoggEsterni|optional + entiSoggEsterni|optional + soggEstAlias|optional + soggEstProfili|optional + + + Classe di modello : ReplicaConsensiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + + + Classe di modello : ReplicaEntiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + enteId|primaryKey + sedi|optional + + + Classe di modello : ReplicaSediEntiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + enteId|primaryKey + + + Classe di modello : SoggEstProfili + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (GET).yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (GET).yml new file mode 100644 index 0000000..df91640 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni (GET).yml @@ -0,0 +1,305 @@ +info: + name: Recupero dei soggetti esterni (GET) + type: http + seq: 5 + tags: + - soggetti_esterni + +http: + method: GET + url: "{{baseUrl}}/soggettiEsterniReplica" + params: + - name: soggEstId + value: "" + type: query + description: identificativo soggetto esterno + disabled: true + - 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: dipId + value: "" + type: query + description: id dipartimento + disabled: true + - name: tipoSoggEstCod + value: "" + type: query + description: codice tipo relatore + disabled: true + - name: idAb + value: "" + type: query + description: identificativo address book della persona in U-GOV + disabled: true + - name: codFis + value: "" + type: query + description: codice fiscale dell'utente + disabled: true + - name: daDataMod + value: "" + type: query + description: data di ultima modifica (DD/MM/YYYY), 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: 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: 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: 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 + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/soggettiEsterniReplica" + method: GET + params: + - name: soggEstId + value: "" + type: query + description: identificativo soggetto esterno + disabled: true + - 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: dipId + value: "" + type: query + description: id dipartimento + disabled: true + - name: tipoSoggEstCod + value: "" + type: query + description: codice tipo relatore + disabled: true + - name: idAb + value: "" + type: query + description: identificativo address book della persona in U-GOV + disabled: true + - name: codFis + value: "" + type: query + description: codice fiscale dell'utente + disabled: true + - name: daDataMod + value: "" + type: query + description: data di ultima modifica (DD/MM/YYYY), 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: 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: 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: 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 + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Fornisce i soggetti esterni configurati su esse3. + + **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 : ReplicaSoggettoEsterno + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + consensiSoggEsterni|optional + entiSoggEsterni|optional + soggEstAlias|optional + soggEstProfili|optional + + + Classe di modello : ReplicaConsensiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + + + Classe di modello : ReplicaEntiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + enteId|primaryKey + sedi|optional + + + Classe di modello : ReplicaSediEntiSoggEsterni + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + enteId|primaryKey + + + Classe di modello : SoggEstProfili + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni.yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni.yml new file mode 100644 index 0000000..03b2158 --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/Recupero dei soggetti esterni.yml @@ -0,0 +1,270 @@ +info: + name: Recupero dei soggetti esterni + type: http + seq: 1 + tags: + - soggetti_esterni + +http: + method: GET + url: "{{baseUrl}}/soggettiEsterni" + 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: dipId + value: "" + type: query + description: id dipartimento + disabled: true + - name: tipoSoggEstCod + value: "" + type: query + description: codice tipo relatore + disabled: true + - name: idAb + value: "" + type: query + description: identificativo address book della persona in U-GOV + disabled: true + - name: codFis + value: "" + type: query + description: codice fiscale dell'utente + disabled: true + - name: soggEstId + value: "" + type: query + description: Lista di identificativi di Soggetti Esterni + disabled: true + - name: daDataMod + value: "" + type: query + description: data di ultima modifica (DD/MM/YYYY), 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: 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: 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: 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: 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}}/soggettiEsterni" + 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: dipId + value: "" + type: query + description: id dipartimento + disabled: true + - name: tipoSoggEstCod + value: "" + type: query + description: codice tipo relatore + disabled: true + - name: idAb + value: "" + type: query + description: identificativo address book della persona in U-GOV + disabled: true + - name: codFis + value: "" + type: query + description: codice fiscale dell'utente + disabled: true + - name: soggEstId + value: "" + type: query + description: Lista di identificativi di Soggetti Esterni + disabled: true + - name: daDataMod + value: "" + type: query + description: data di ultima modifica (DD/MM/YYYY), 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: 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: 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: 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: 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: | + Fornisce i soggetti esterni configurati su esse3. + + **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 : SoggettoEsterno + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey + soggEstAlias|optional + soggEstProfili|optional + + + Classe di modello : SoggEstProfili + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + soggEstId|primaryKey diff --git a/collections/ESSE3 Anagrafica API/soggetti_esterni/folder.yml b/collections/ESSE3 Anagrafica API/soggetti_esterni/folder.yml new file mode 100644 index 0000000..d70e4ae --- /dev/null +++ b/collections/ESSE3 Anagrafica API/soggetti_esterni/folder.yml @@ -0,0 +1,7 @@ +info: + name: soggetti_esterni + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Common Auth API/autenticazione/changeUserPassword.yml b/collections/ESSE3 Common Auth API/autenticazione/changeUserPassword.yml new file mode 100644 index 0000000..5c205f8 --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/changeUserPassword.yml @@ -0,0 +1,65 @@ +info: + name: changeUserPassword + type: http + seq: 1 + tags: + - autenticazione + +http: + method: PUT + url: "{{baseUrl}}/changeUserPassword" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: | + il contenuto ritornato esprime il risultato dell'operazione. + request: + url: "{{baseUrl}}/changeUserPassword" + method: PUT + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 401 Response + description: l'header "Authorization" non è presente oppure contiene dati non validi o credenziali errate + request: + url: "{{baseUrl}}/changeUserPassword" + method: PUT + response: + status: 401 + statusText: Unauthorized + body: + type: text + data: "" + +docs: | + Modifica la password di un utente. Per poter accedere al servizio occorrono le credenziali di un'utenza + tecnica passate tramite header http "Authorization: Basic ....". + NB: l'utente deve poter utilizzare il tipo client REST ed avere abilitato l'accesso alla funzione SI_18_008. + + + **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: common-auth-permissions** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/autenticazione/checkLogon.yml b/collections/ESSE3 Common Auth API/autenticazione/checkLogon.yml new file mode 100644 index 0000000..6c524dd --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/checkLogon.yml @@ -0,0 +1,38 @@ +info: + name: checkLogon + type: http + seq: 2 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/checkLogon" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +docs: | + Verifica le credenziali di un utente fornite tramite header http "Authorization: Basic ...." + + + **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: common-public-permissions** + + Profilo|Controllo| Funzione + -|-|- + ALL|Funzione Pubblica|Security.checkDummy() diff --git a/collections/ESSE3 Common Auth API/autenticazione/checkSessionId.yml b/collections/ESSE3 Common Auth API/autenticazione/checkSessionId.yml new file mode 100644 index 0000000..51b1e7c --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/checkSessionId.yml @@ -0,0 +1,61 @@ +info: + name: checkSessionId + type: http + seq: 11 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/sessions/:sessionId/check" + params: + - name: sessionId + value: "" + type: path + description: sessionId di backend + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/sessions/:sessionId/check" + method: GET + params: + - name: sessionId + value: "" + type: path + description: sessionId di backend + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + controlla se il sessionId passato in ingresso è valido, nel caso non sia valido viene restituito 404 + + + **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-permissions** + + Profilo|Controllo| Funzione + -|-|- + UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico() diff --git a/collections/ESSE3 Common Auth API/autenticazione/folder.yml b/collections/ESSE3 Common Auth API/autenticazione/folder.yml new file mode 100644 index 0000000..29d3d00 --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/folder.yml @@ -0,0 +1,7 @@ +info: + name: autenticazione + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Common Auth API/autenticazione/getCacheParams.yml b/collections/ESSE3 Common Auth API/autenticazione/getCacheParams.yml new file mode 100644 index 0000000..513975d --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/getCacheParams.yml @@ -0,0 +1,51 @@ +info: + name: getCacheParams + type: http + seq: 4 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/login/cache/" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/login/cache/" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + recupea le informazioni sulle cache abilitate per la sessione + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/autenticazione/getCurrentSession.yml b/collections/ESSE3 Common Auth API/autenticazione/getCurrentSession.yml new file mode 100644 index 0000000..3c8fc59 --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/getCurrentSession.yml @@ -0,0 +1,157 @@ +info: + name: getCurrentSession + type: http + seq: 10 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/sessions/current-session" + params: + - 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}}/sessions/current-session" + method: GET + params: + - 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: 300 Response + description: Più profili disponibili, rieffettuare la login aggiungendo l'header X-Esse3-User-Profile, indicando come valore STUDENTE, DOCENTE o USER_TECNICO + request: + url: "{{baseUrl}}/sessions/current-session" + method: GET + params: + - 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: 300 + statusText: Multiple Choice + body: + type: text + data: "" + - name: 401 Response + description: login failed + request: + url: "{{baseUrl}}/sessions/current-session" + method: GET + params: + - 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: 401 + statusText: Unauthorized + body: + type: text + data: "" + +docs: | + controlla se il sessionId passato in ingresso è valido, nel caso non sia valido viene restituito 404 + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() + + + Classe di modello : SessioneUtente + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + jwt|optional + + + Classe di modello : SessioneUtente + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + jwt|optional diff --git a/collections/ESSE3 Common Auth API/autenticazione/getJWT.yml b/collections/ESSE3 Common Auth API/autenticazione/getJWT.yml new file mode 100644 index 0000000..215ffbf --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/getJWT.yml @@ -0,0 +1,63 @@ +info: + name: getJWT + type: http + seq: 6 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/login/jwt/new" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/login/jwt/new" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Recupera il token JWT rilasciato da esse3 relativo alla sessione utente già autenticata + + La pagina di recupero delle chiavi per la validazione del token è reperibile sulla installazione di webesse3 + all'indirizzo /jwt/jwk.do + + Il token rilasciato contiene i seguenti claim + * sub (secondo il par_cond OAUTH_USER_CLAIM) + * iss = esse3 + * iat = epoch di generazione del token + * exp = epoch di expire del token configurata nel gruppo utente + * profile = profillo dell'utente + * fiscalCode = codice Fiscale dell'utente + * tenant = tenant dell'installazione + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/autenticazione/getLinguaCod.yml b/collections/ESSE3 Common Auth API/autenticazione/getLinguaCod.yml new file mode 100644 index 0000000..27eb97c --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/getLinguaCod.yml @@ -0,0 +1,52 @@ +info: + name: getLinguaCod + type: http + seq: 7 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/login/lingua" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/login/lingua" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Recupera la lingua impostata nella sessione utente. Questa lingua viene utilizzata nelle operazioni get per + effettaure i recuperi delle descrizioni nella lingua selezionata (dove previsto) + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/autenticazione/login.yml b/collections/ESSE3 Common Auth API/autenticazione/login.yml new file mode 100644 index 0000000..01ff16d --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/login.yml @@ -0,0 +1,180 @@ +info: + name: login + type: http + seq: 3 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/login" + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + 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}}/login" + method: GET + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + 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: 300 Response + description: Più profili disponibili, rieffettuare la login aggiungendo l'header X-Esse3-User-Profile, indicando come valore STUDENTE, DOCENTE o USER_TECNICO + request: + url: "{{baseUrl}}/login" + method: GET + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + 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: 300 + statusText: Multiple Choice + body: + type: text + data: "" + - name: 401 Response + description: login failed + request: + url: "{{baseUrl}}/login" + method: GET + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + 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: 401 + statusText: Unauthorized + body: + type: text + data: "" + +docs: | + Effettua la login ad esse3. + E' possibile richiedere una tipologia specifica di profilo utente tramite l'header HTTP X-Esse3-User-Profile, indicando come valore STUDENTE, DOCENTE o USER_TECNICO + Nel caso di utenza con più profili (e accesso tramite codice fiscale) viene ritornato lo status code 300 e *NON* viene effettauta la login. + Occorre come indicato rieffettuare la chiamata aggiungendo uno dei profili disponibili + + + **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 + -|-|- + ALL|Funzione Pubblica|Security.checkDummy() + + + Classe di modello : SessioneUtente + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + jwt|optional + + + Classe di modello : SessioneUtente + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + jwt|optional diff --git a/collections/ESSE3 Common Auth API/autenticazione/logout.yml b/collections/ESSE3 Common Auth API/autenticazione/logout.yml new file mode 100644 index 0000000..a22798b --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/logout.yml @@ -0,0 +1,50 @@ +info: + name: logout + type: http + seq: 9 + tags: + - autenticazione + +http: + method: GET + url: "{{baseUrl}}/logout" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/logout" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Effettua la logout da esse3. + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/autenticazione/setCacheParams.yml b/collections/ESSE3 Common Auth API/autenticazione/setCacheParams.yml new file mode 100644 index 0000000..84d701d --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/setCacheParams.yml @@ -0,0 +1,72 @@ +info: + name: setCacheParams + type: http + seq: 5 + tags: + - autenticazione + +http: + method: PUT + url: "{{baseUrl}}/login/cache/" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/login/cache/" + method: PUT + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: Aggiornamento non riuscito + request: + url: "{{baseUrl}}/login/cache/" + method: PUT + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + Imposta le cache da abiltiare/disabilitare per la sessione utente + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Common Auth API/autenticazione/setLinguaCod.yml b/collections/ESSE3 Common Auth API/autenticazione/setLinguaCod.yml new file mode 100644 index 0000000..8021983 --- /dev/null +++ b/collections/ESSE3 Common Auth API/autenticazione/setLinguaCod.yml @@ -0,0 +1,64 @@ +info: + name: setLinguaCod + type: http + seq: 8 + tags: + - autenticazione + +http: + method: PUT + url: "{{baseUrl}}/login/lingua" + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/login/lingua" + method: PUT + params: + - name: sessionLinguaCod + value: "" + type: query + description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + Aggiorna la lingua di sessione. Questa lingua viene utilizzata nelle operazioni get per + effettaure i recuperi delle descrizioni nella lingua selezionata (dove previsto) + + + **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: AUTHENTICATED** + + Profilo|Controllo| Funzione + -|-|- + AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser() diff --git a/collections/ESSE3 Common Auth API/jwt/folder.yml b/collections/ESSE3 Common Auth API/jwt/folder.yml new file mode 100644 index 0000000..481a313 --- /dev/null +++ b/collections/ESSE3 Common Auth API/jwt/folder.yml @@ -0,0 +1,7 @@ +info: + name: jwt + type: folder + seq: 1 + +request: + auth: inherit diff --git a/collections/ESSE3 Common Auth API/jwt/getJWK.yml b/collections/ESSE3 Common Auth API/jwt/getJWK.yml new file mode 100644 index 0000000..60cf492 --- /dev/null +++ b/collections/ESSE3 Common Auth API/jwt/getJWK.yml @@ -0,0 +1,51 @@ +info: + name: getJWK + type: http + seq: 1 + tags: + - jwt + +http: + method: GET + url: "{{baseUrl}}/jwt/jwk" + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/jwt/jwk" + method: GET + response: + status: 200 + statusText: OK + body: + type: text + data: "" + +docs: | + effettua il refresh di un token jwt passato in ingresso se questo è stato emesso da esse3 tramite la login oppure con l'endopoint di creazione + + + **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 + -|-|- + ALL|Funzione Pubblica|Security.checkDummy() diff --git a/collections/ESSE3 Common Auth API/jwt/refreshJWT.yml b/collections/ESSE3 Common Auth API/jwt/refreshJWT.yml new file mode 100644 index 0000000..0590b42 --- /dev/null +++ b/collections/ESSE3 Common Auth API/jwt/refreshJWT.yml @@ -0,0 +1,90 @@ +info: + name: refreshJWT + type: http + seq: 2 + tags: + - jwt + +http: + method: GET + url: "{{baseUrl}}/jwt/refresh" + params: + - name: jwt + value: "" + type: query + description: token jwt in ingresso per il quale effettuare il refresh + disabled: true + auth: inherit + +settings: + encodeUrl: true + timeout: 0 + followRedirects: true + maxRedirects: 5 + +examples: + - name: 200 Response + description: Successful response + request: + url: "{{baseUrl}}/jwt/refresh" + method: GET + params: + - name: jwt + value: "" + type: query + description: token jwt in ingresso per il quale effettuare il refresh + disabled: true + response: + status: 200 + statusText: OK + body: + type: text + data: "" + - name: 422 Response + description: parametri Errati + request: + url: "{{baseUrl}}/jwt/refresh" + method: GET + params: + - name: jwt + value: "" + type: query + description: token jwt in ingresso per il quale effettuare il refresh + disabled: true + response: + status: 422 + statusText: Unprocessable Entity + body: + type: text + data: "" + +docs: | + effettua il refresh di un token jwt passato in ingresso se questo è stato emesso da esse3 tramite la login oppure con l'endopoint di creazione + + + **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 + -|-|- + ALL|Funzione Pubblica|Security.checkDummy() + + + Classe di modello : DettaglioErroreAggiuntivo + ====== + + Estensioni sulle proprietà + ---- + Proprietà | x-field-type + -|-| + rawValue|rawJson diff --git a/collections/ESSE3 Common Auth API/opencollection.yml b/collections/ESSE3 Common Auth API/opencollection.yml new file mode 100644 index 0000000..57da171 --- /dev/null +++ b/collections/ESSE3 Common Auth API/opencollection.yml @@ -0,0 +1,34 @@ +opencollection: 1.0.0 + +info: + name: ESSE3 Common Auth API +config: + proxy: + inherit: true + config: + protocol: http + hostname: "" + port: "" + auth: + username: "" + password: "" + bypassProxy: "" + +request: + auth: + type: basic + username: "{{esse3apiUsername}}" + password: "{{esse3apiPassword}}" + variables: + - name: baseUrl + value: https://unipr2.esse3.pp.cineca.it/e3rest/api + - name: esse3apiUsername + value: da2.rest + - name: esse3apiPassword + value: paperino +bundled: false +extensions: + bruno: + ignore: + - node_modules + - .git diff --git a/workspace.yml b/workspace.yml index 33c99ec..463123f 100644 --- a/workspace.yml +++ b/workspace.yml @@ -20,6 +20,10 @@ collections: path: "collections/SharePoint API" - name: "Scopus" path: "collections/Scopus" + - name: "ESSE3 Common Auth API" + path: "collections/ESSE3 Common Auth API" + - name: "ESSE3 Anagrafica API" + path: "collections/ESSE3 Anagrafica API" specs: