| Requires any of the roles: | Admin, ApiUser |
| GET | /soggetti-ubicazioni-esterne |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | int? | No | |
| IdGreaterThanOrEqualTo | query | int? | No | |
| IdGreaterThan | query | int? | No | |
| IdLessThan | query | int? | No | |
| IdLessThanOrEqualTo | query | int? | No | |
| IdNotEqualTo | query | int? | No | |
| IdBetween | query | int[] | No | |
| IdIn | query | int[] | No | |
| SoggettoId | query | int? | No | |
| SoggettoIdGreaterThanOrEqualTo | query | int? | No | |
| SoggettoIdGreaterThan | query | int? | No | |
| SoggettoIdLessThan | query | int? | No | |
| SoggettoIdLessThanOrEqualTo | query | int? | No | |
| SoggettoIdNotEqualTo | query | int? | No | |
| SoggettoIdBetween | query | int[] | No | |
| SoggettoIdIn | query | int[] | No | |
| TipoUbicazioneId | query | int? | No | |
| TipoUbicazioneIdGreaterThanOrEqualTo | query | int? | No | |
| TipoUbicazioneIdGreaterThan | query | int? | No | |
| TipoUbicazioneIdLessThan | query | int? | No | |
| TipoUbicazioneIdLessThanOrEqualTo | query | int? | No | |
| TipoUbicazioneIdNotEqualTo | query | int? | No | |
| TipoUbicazioneIdBetween | query | int[] | No | |
| TipoUbicazioneIdIn | query | int[] | No | |
| Indirizzo | query | string | No | |
| IndirizzoStartsWith | query | string | No | |
| IndirizzoEndsWith | query | string | No | |
| IndirizzoContains | query | string | No | |
| IndirizzoLike | query | string | No | |
| IndirizzoBetween | query | string[] | No | |
| IndirizzoIn | query | string[] | No | |
| CAP | query | string | No | |
| CAPStartsWith | query | string | No | |
| CAPEndsWith | query | string | No | |
| CAPContains | query | string | No | |
| CAPLike | query | string | No | |
| CAPBetween | query | string[] | No | |
| CAPIn | query | string[] | No | |
| Citta | query | string | No | |
| CittaStartsWith | query | string | No | |
| CittaEndsWith | query | string | No | |
| CittaContains | query | string | No | |
| CittaLike | query | string | No | |
| CittaBetween | query | string[] | No | |
| CittaIn | query | string[] | No | |
| Provincia | query | string | No | |
| ProvinciaStartsWith | query | string | No | |
| ProvinciaEndsWith | query | string | No | |
| ProvinciaContains | query | string | No | |
| ProvinciaLike | query | string | No | |
| ProvinciaBetween | query | string[] | No | |
| ProvinciaIn | query | string[] | No | |
| Paese | query | string | No | |
| PaeseStartsWith | query | string | No | |
| PaeseEndsWith | query | string | No | |
| PaeseContains | query | string | No | |
| PaeseLike | query | string | No | |
| PaeseBetween | query | string[] | No | |
| PaeseIn | query | string[] | No | |
| Descrizione | query | string | No | |
| DescrizioneStartsWith | query | string | No | |
| DescrizioneEndsWith | query | string | No | |
| DescrizioneContains | query | string | No | |
| DescrizioneLike | query | string | No | |
| DescrizioneBetween | query | string[] | No | |
| DescrizioneIn | query | string[] | No | |
| CodiceEsterno | query | string | No | |
| CodiceEsternoStartsWith | query | string | No | |
| CodiceEsternoEndsWith | query | string | No | |
| CodiceEsternoContains | query | string | No | |
| CodiceEsternoLike | query | string | No | |
| CodiceEsternoBetween | query | string[] | No | |
| CodiceEsternoIn | query | string[] | No | |
| RecapitoPredefinitoId | query | int? | No | |
| RecapitoPredefinitoIdGreaterThanOrEqualTo | query | int? | No | |
| RecapitoPredefinitoIdGreaterThan | query | int? | No | |
| RecapitoPredefinitoIdLessThan | query | int? | No | |
| RecapitoPredefinitoIdLessThanOrEqualTo | query | int? | No | |
| RecapitoPredefinitoIdNotEqualTo | query | int? | No | |
| RecapitoPredefinitoIdBetween | query | int[] | No | |
| RecapitoPredefinitoIdIn | query | int[] | No | |
| CoordGPS | query | string | No | |
| CoordGPSStartsWith | query | string | No | |
| CoordGPSEndsWith | query | string | No | |
| CoordGPSContains | query | string | No | |
| CoordGPSLike | query | string | No | |
| CoordGPSBetween | query | string[] | No | |
| CoordGPSIn | query | string[] | No | |
| RegioneId | query | int? | No | |
| RegioneIdGreaterThanOrEqualTo | query | int? | No | |
| RegioneIdGreaterThan | query | int? | No | |
| RegioneIdLessThan | query | int? | No | |
| RegioneIdLessThanOrEqualTo | query | int? | No | |
| RegioneIdNotEqualTo | query | int? | No | |
| RegioneIdBetween | query | int[] | No | |
| RegioneIdIn | query | int[] | No | |
| IsImpianto | query | bool? | No | |
| IsSedeCommerciale | query | bool? | No | |
| CodiceRiferimentoProprietario | query | string | No | |
| CodiceRiferimentoProprietarioStartsWith | query | string | No | |
| CodiceRiferimentoProprietarioEndsWith | query | string | No | |
| CodiceRiferimentoProprietarioContains | query | string | No | |
| CodiceRiferimentoProprietarioLike | query | string | No | |
| CodiceRiferimentoProprietarioBetween | query | string[] | No | |
| CodiceRiferimentoProprietarioIn | query | string[] | No | |
| AuthToken | query | string | No | Token di Autenticazione del Soggetto. **Obbligatorio per utenti con ruolo 'ApiUser' (utenti generici).** Questo token autentica l'utente specifico e filtra i dati per mostrare solo le ubicazioni associate al soggetto del token. **Non richiesto per utenti con ruolo 'Admin'.** Generalmente fornito nel corpo della richiesta (POST) o come parametro di query (GET). |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| SoggettoId | form | int | No | |
| TipoUbicazioneId | form | int | No | |
| Indirizzo | form | string | No | |
| CAP | form | string | No | |
| Citta | form | string | No | |
| Provincia | form | string | No | |
| Paese | form | string | No | |
| Descrizione | form | string | No | |
| CodiceEsterno | form | string | No | |
| RecapitoPredefinitoId | form | int | No | |
| CoordGPS | form | string | No | |
| RegioneId | form | int | No | |
| IsImpianto | form | bool | No | |
| IsSedeCommerciale | form | bool | No | |
| CodiceRiferimentoProprietario | form | string | No | |
| Regione | form | Regione | No | |
| TipoUbicazione | form | TipoUbicazione | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Nome | form | string | No | |
| Area | form | string | No | |
| Province | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Descrizione | form | string | No | |
| IsDefault | form | bool | No | |
| AziendaId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /soggetti-ubicazioni-esterne HTTP/1.1 Host: gemma.api.kerberos.energy Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"offset":0,"total":0,"results":[{"id":0,"indirizzo":"String","cap":"String","citta":"String","provincia":"String","paese":"String","descrizione":"String","codiceEsterno":"String","coordGPS":"String","isImpianto":false,"isSedeCommerciale":false,"codiceRiferimentoProprietario":"String","regione":{"id":0,"nome":"String","area":"String","province":"String"},"tipoUbicazione":{"id":0,"descrizione":"String","isDefault":false,"aziendaId":0}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}