| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfSoggettoUbicazioneEsternaCYQkyN_Pr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
<d2p1:SoggettoUbicazioneEsterna>
<d2p1:CAP>String</d2p1:CAP>
<d2p1:Citta>String</d2p1:Citta>
<d2p1:CodiceEsterno>String</d2p1:CodiceEsterno>
<d2p1:CodiceRiferimentoProprietario>String</d2p1:CodiceRiferimentoProprietario>
<d2p1:CoordGPS>String</d2p1:CoordGPS>
<d2p1:Descrizione>String</d2p1:Descrizione>
<d2p1:Id>0</d2p1:Id>
<d2p1:Indirizzo>String</d2p1:Indirizzo>
<d2p1:IsImpianto>false</d2p1:IsImpianto>
<d2p1:IsSedeCommerciale>false</d2p1:IsSedeCommerciale>
<d2p1:Paese>String</d2p1:Paese>
<d2p1:Provincia>String</d2p1:Provincia>
<d2p1:RecapitoPredefinitoId>0</d2p1:RecapitoPredefinitoId>
<d2p1:Regione>
<d2p1:Area>String</d2p1:Area>
<d2p1:Id>0</d2p1:Id>
<d2p1:Nome>String</d2p1:Nome>
<d2p1:Province>String</d2p1:Province>
</d2p1:Regione>
<d2p1:RegioneId>0</d2p1:RegioneId>
<d2p1:SoggettoId>0</d2p1:SoggettoId>
<d2p1:TipoUbicazione>
<d2p1:AziendaId>0</d2p1:AziendaId>
<d2p1:Descrizione>String</d2p1:Descrizione>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsDefault>false</d2p1:IsDefault>
</d2p1:TipoUbicazione>
<d2p1:TipoUbicazioneId>0</d2p1:TipoUbicazioneId>
</d2p1:SoggettoUbicazioneEsterna>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfSoggettoUbicazioneEsternaCYQkyN_Pr>