Gemma.WebApi

<back to all web services

SoggettoUbicazioneEsternaQuery

Recupera le ubicazioni esterne dei soggetti. Questo endpoint utilizza un meccanismo di sicurezza avanzato che combina una API Key (Chiave di Applicazione) per l'autenticazione dell'applicazione e un AuthToken (Token di Autenticazione del Soggetto) per l'autorizzazione a livello di utente. ⚠️ Nota Importante: Questo meccanismo di sicurezza è attualmente in fase sperimentale e soggetto a possibili modifiche future.

Requires Authentication
Requires any of the roles:Admin, ApiUser
The following routes are available for this service:
GET/soggetti-ubicazioni-esterne
SoggettoUbicazioneEsternaQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
SoggettoIdqueryint?No
SoggettoIdGreaterThanOrEqualToqueryint?No
SoggettoIdGreaterThanqueryint?No
SoggettoIdLessThanqueryint?No
SoggettoIdLessThanOrEqualToqueryint?No
SoggettoIdNotEqualToqueryint?No
SoggettoIdBetweenqueryint[]No
SoggettoIdInqueryint[]No
TipoUbicazioneIdqueryint?No
TipoUbicazioneIdGreaterThanOrEqualToqueryint?No
TipoUbicazioneIdGreaterThanqueryint?No
TipoUbicazioneIdLessThanqueryint?No
TipoUbicazioneIdLessThanOrEqualToqueryint?No
TipoUbicazioneIdNotEqualToqueryint?No
TipoUbicazioneIdBetweenqueryint[]No
TipoUbicazioneIdInqueryint[]No
IndirizzoquerystringNo
IndirizzoStartsWithquerystringNo
IndirizzoEndsWithquerystringNo
IndirizzoContainsquerystringNo
IndirizzoLikequerystringNo
IndirizzoBetweenquerystring[]No
IndirizzoInquerystring[]No
CAPquerystringNo
CAPStartsWithquerystringNo
CAPEndsWithquerystringNo
CAPContainsquerystringNo
CAPLikequerystringNo
CAPBetweenquerystring[]No
CAPInquerystring[]No
CittaquerystringNo
CittaStartsWithquerystringNo
CittaEndsWithquerystringNo
CittaContainsquerystringNo
CittaLikequerystringNo
CittaBetweenquerystring[]No
CittaInquerystring[]No
ProvinciaquerystringNo
ProvinciaStartsWithquerystringNo
ProvinciaEndsWithquerystringNo
ProvinciaContainsquerystringNo
ProvinciaLikequerystringNo
ProvinciaBetweenquerystring[]No
ProvinciaInquerystring[]No
PaesequerystringNo
PaeseStartsWithquerystringNo
PaeseEndsWithquerystringNo
PaeseContainsquerystringNo
PaeseLikequerystringNo
PaeseBetweenquerystring[]No
PaeseInquerystring[]No
DescrizionequerystringNo
DescrizioneStartsWithquerystringNo
DescrizioneEndsWithquerystringNo
DescrizioneContainsquerystringNo
DescrizioneLikequerystringNo
DescrizioneBetweenquerystring[]No
DescrizioneInquerystring[]No
CodiceEsternoquerystringNo
CodiceEsternoStartsWithquerystringNo
CodiceEsternoEndsWithquerystringNo
CodiceEsternoContainsquerystringNo
CodiceEsternoLikequerystringNo
CodiceEsternoBetweenquerystring[]No
CodiceEsternoInquerystring[]No
RecapitoPredefinitoIdqueryint?No
RecapitoPredefinitoIdGreaterThanOrEqualToqueryint?No
RecapitoPredefinitoIdGreaterThanqueryint?No
RecapitoPredefinitoIdLessThanqueryint?No
RecapitoPredefinitoIdLessThanOrEqualToqueryint?No
RecapitoPredefinitoIdNotEqualToqueryint?No
RecapitoPredefinitoIdBetweenqueryint[]No
RecapitoPredefinitoIdInqueryint[]No
CoordGPSquerystringNo
CoordGPSStartsWithquerystringNo
CoordGPSEndsWithquerystringNo
CoordGPSContainsquerystringNo
CoordGPSLikequerystringNo
CoordGPSBetweenquerystring[]No
CoordGPSInquerystring[]No
RegioneIdqueryint?No
RegioneIdGreaterThanOrEqualToqueryint?No
RegioneIdGreaterThanqueryint?No
RegioneIdLessThanqueryint?No
RegioneIdLessThanOrEqualToqueryint?No
RegioneIdNotEqualToqueryint?No
RegioneIdBetweenqueryint[]No
RegioneIdInqueryint[]No
IsImpiantoquerybool?No
IsSedeCommercialequerybool?No
CodiceRiferimentoProprietarioquerystringNo
CodiceRiferimentoProprietarioStartsWithquerystringNo
CodiceRiferimentoProprietarioEndsWithquerystringNo
CodiceRiferimentoProprietarioContainsquerystringNo
CodiceRiferimentoProprietarioLikequerystringNo
CodiceRiferimentoProprietarioBetweenquerystring[]No
CodiceRiferimentoProprietarioInquerystring[]No
AuthTokenquerystringNoToken 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).
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SoggettoUbicazioneEsterna Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SoggettoIdformintNo
TipoUbicazioneIdformintNo
IndirizzoformstringNo
CAPformstringNo
CittaformstringNo
ProvinciaformstringNo
PaeseformstringNo
DescrizioneformstringNo
CodiceEsternoformstringNo
RecapitoPredefinitoIdformintNo
CoordGPSformstringNo
RegioneIdformintNo
IsImpiantoformboolNo
IsSedeCommercialeformboolNo
CodiceRiferimentoProprietarioformstringNo
RegioneformRegioneNo
TipoUbicazioneformTipoUbicazioneNo
Regione Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
AreaformstringNo
ProvinceformstringNo
TipoUbicazione Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescrizioneformstringNo
IsDefaultformboolNo
AziendaIdformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}