Gemma.WebApi

<back to all web services

SoggettoUbicazioneQuery

Requires Authentication
Required role:Admin
SoggettoUbicazioneQuery 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
RecapitoPredefinitoIdBetweenqueryNullable<Int32>[]No
RecapitoPredefinitoIdInqueryNullable<Int32>[]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
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SoggettoUbicazione Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SoggettoIdformintNo
TipoUbicazioneIdformintNo
IndirizzoformstringNo
CAPformstringNo
CittaformstringNo
ProvinciaformstringNo
PaeseformstringNo
DescrizioneformstringNo
CodiceEsternoformstringNo
RecapitoPredefinitoIdformint?No
CoordGPSformstringNo
RegioneIdformintNo
IsImpiantoformboolNo
IsSedeCommercialeformboolNo
CodiceRiferimentoProprietarioformstringNo
RegioneformRegioneNo
SoggettoformSoggettoNo
TipoUbicazioneformTipoUbicazioneNo
Regione Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
AreaformstringNo
ProvinceformstringNo
Soggetto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodiceformstringNo
TipoSoggettoIdformint?No
TipoTitoloIdformint?No
NomeRagSocformstringNo
CognomeformstringNo
IsFornitoreformboolNo
IsClienteformboolNo
NoteformstringNo
DateCreatedformDateTimeNo
EmpCreatedformstringNo
DateUpdatedformDateTime?No
EmpUpdatedformstringNo
RowVersionformintNo
CodiceFiscaleformstringNo
PartitaIvaformstringNo
CodiceEsternoformstringNo
CondizioniConsegnaformstringNo
CondizioniPagamentoformstringNo
BancaformstringNo
CinformstringNo
AbiformstringNo
CabformstringNo
IbanformstringNo
SwiftformstringNo
CondizioniSpedizioneformstringNo
AziendaIdformintNo
IsVettoreformboolNo
ListinoIdformintNo
ContoCorrenteformstringNo
SportelloformstringNo
NotaInternaformstringNo
OwnerIdformintNo
UtenteCreazioneIdformintNo
DataCreazioneformDateTimeNo
UtenteModificaIdformintNo
DataModificaformDateTimeNo
ScadenzaPagamentoIdformintNo
CategoriaIdformintNo
ScontoFornitore1formdecimalNo
ScontoFornitore2formdecimalNo
ScontoFornitore3formdecimalNo
ScontoCliente1formdecimalNo
ScontoCliente2formdecimalNo
ScontoCliente3formdecimalNo
ImmagineformintNo
AreaIdformintNo
IsVisibileformboolNo
IsAccessoWEBformboolNo
LoginformstringNo
PasswordformstringNo
IsEliminatoformboolNo
IsAnagraficaRichiestaformboolNo
IsAnagraficaInviataformboolNo
FidoClienteformdecimalNo
TipoIntermediarioIdformintNo
SoggettoIntermediarioIdformintNo
IsLIDformboolNo
ImportazioneIdformintNo
MagazzinoSoggettoIdformintNo
TipoStatoSoggettoIdformintNo
ContattoCommercialeIdformintNo
TAGSformstringNo
TipoDriverCommercialeIdformintNo
IsWebReferenceformboolNo
IsSoggettoConBenestareformboolNo
EsenzioneIVAAcquistoformintNo
EsenzioneIVAVenditaformintNo
TipoPartnerIdformintNo
WebIsPartnerVisibileformboolNo
URLTrackingformstringNo
ImportoCreditoformdecimalNo
OdooIdformintNo
PartitaIvaGruppoformstringNo
AuthTokenformstringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/SoggettoUbicazioneQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	idGreaterThanOrEqualTo: 0,
	idGreaterThan: 0,
	idLessThan: 0,
	idLessThanOrEqualTo: 0,
	idNotEqualTo: 0,
	idBetween: 
	[
		0
	],
	idIn: 
	[
		0
	],
	soggettoId: 0,
	soggettoIdGreaterThanOrEqualTo: 0,
	soggettoIdGreaterThan: 0,
	soggettoIdLessThan: 0,
	soggettoIdLessThanOrEqualTo: 0,
	soggettoIdNotEqualTo: 0,
	soggettoIdBetween: 
	[
		0
	],
	soggettoIdIn: 
	[
		0
	],
	tipoUbicazioneId: 0,
	tipoUbicazioneIdGreaterThanOrEqualTo: 0,
	tipoUbicazioneIdGreaterThan: 0,
	tipoUbicazioneIdLessThan: 0,
	tipoUbicazioneIdLessThanOrEqualTo: 0,
	tipoUbicazioneIdNotEqualTo: 0,
	tipoUbicazioneIdBetween: 
	[
		0
	],
	tipoUbicazioneIdIn: 
	[
		0
	],
	indirizzo: String,
	indirizzoStartsWith: String,
	indirizzoEndsWith: String,
	indirizzoContains: String,
	indirizzoLike: String,
	indirizzoBetween: 
	[
		String
	],
	indirizzoIn: 
	[
		String
	],
	cap: String,
	capStartsWith: String,
	capEndsWith: String,
	capContains: String,
	capLike: String,
	capBetween: 
	[
		String
	],
	capIn: 
	[
		String
	],
	citta: String,
	cittaStartsWith: String,
	cittaEndsWith: String,
	cittaContains: String,
	cittaLike: String,
	cittaBetween: 
	[
		String
	],
	cittaIn: 
	[
		String
	],
	provincia: String,
	provinciaStartsWith: String,
	provinciaEndsWith: String,
	provinciaContains: String,
	provinciaLike: String,
	provinciaBetween: 
	[
		String
	],
	provinciaIn: 
	[
		String
	],
	paese: String,
	paeseStartsWith: String,
	paeseEndsWith: String,
	paeseContains: String,
	paeseLike: String,
	paeseBetween: 
	[
		String
	],
	paeseIn: 
	[
		String
	],
	descrizione: String,
	descrizioneStartsWith: String,
	descrizioneEndsWith: String,
	descrizioneContains: String,
	descrizioneLike: String,
	descrizioneBetween: 
	[
		String
	],
	descrizioneIn: 
	[
		String
	],
	codiceEsterno: String,
	codiceEsternoStartsWith: String,
	codiceEsternoEndsWith: String,
	codiceEsternoContains: String,
	codiceEsternoLike: String,
	codiceEsternoBetween: 
	[
		String
	],
	codiceEsternoIn: 
	[
		String
	],
	recapitoPredefinitoId: 0,
	recapitoPredefinitoIdGreaterThanOrEqualTo: 0,
	recapitoPredefinitoIdGreaterThan: 0,
	recapitoPredefinitoIdLessThan: 0,
	recapitoPredefinitoIdLessThanOrEqualTo: 0,
	recapitoPredefinitoIdNotEqualTo: 0,
	recapitoPredefinitoIdBetween: 
	[
		0
	],
	recapitoPredefinitoIdIn: 
	[
		0
	],
	coordGPS: String,
	coordGPSStartsWith: String,
	coordGPSEndsWith: String,
	coordGPSContains: String,
	coordGPSLike: String,
	coordGPSBetween: 
	[
		String
	],
	coordGPSIn: 
	[
		String
	],
	regioneId: 0,
	regioneIdGreaterThanOrEqualTo: 0,
	regioneIdGreaterThan: 0,
	regioneIdLessThan: 0,
	regioneIdLessThanOrEqualTo: 0,
	regioneIdNotEqualTo: 0,
	regioneIdBetween: 
	[
		0
	],
	regioneIdIn: 
	[
		0
	],
	isImpianto: False,
	isSedeCommerciale: False,
	codiceRiferimentoProprietario: String,
	codiceRiferimentoProprietarioStartsWith: String,
	codiceRiferimentoProprietarioEndsWith: String,
	codiceRiferimentoProprietarioContains: String,
	codiceRiferimentoProprietarioLike: String,
	codiceRiferimentoProprietarioBetween: 
	[
		String
	],
	codiceRiferimentoProprietarioIn: 
	[
		String
	],
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			soggettoId: 0,
			tipoUbicazioneId: 0,
			indirizzo: String,
			cap: String,
			citta: String,
			provincia: String,
			paese: String,
			descrizione: String,
			codiceEsterno: String,
			recapitoPredefinitoId: 0,
			coordGPS: String,
			regioneId: 0,
			isImpianto: False,
			isSedeCommerciale: False,
			codiceRiferimentoProprietario: String,
			regione: 
			{
				id: 0,
				nome: String,
				area: String,
				province: String
			},
			soggetto: 
			{
				id: 0,
				codice: String,
				tipoSoggettoId: 0,
				tipoTitoloId: 0,
				nomeRagSoc: String,
				cognome: String,
				isFornitore: False,
				isCliente: False,
				note: String,
				empCreated: String,
				dateUpdated: 0001-01-01T00:00:00,
				empUpdated: String,
				rowVersion: 0,
				codiceFiscale: String,
				partitaIva: String,
				codiceEsterno: String,
				condizioniConsegna: String,
				condizioniPagamento: String,
				banca: String,
				cin: String,
				abi: String,
				cab: String,
				iban: String,
				swift: String,
				condizioniSpedizione: String,
				aziendaId: 0,
				isVettore: False,
				listinoId: 0,
				contoCorrente: String,
				sportello: String,
				notaInterna: String,
				ownerId: 0,
				utenteCreazioneId: 0,
				utenteModificaId: 0,
				scadenzaPagamentoId: 0,
				categoriaId: 0,
				scontoFornitore1: 0,
				scontoFornitore2: 0,
				scontoFornitore3: 0,
				scontoCliente1: 0,
				scontoCliente2: 0,
				scontoCliente3: 0,
				immagine: 0,
				areaId: 0,
				isVisibile: False,
				isAccessoWEB: False,
				login: String,
				password: String,
				isEliminato: False,
				isAnagraficaRichiesta: False,
				isAnagraficaInviata: False,
				fidoCliente: 0,
				tipoIntermediarioId: 0,
				soggettoIntermediarioId: 0,
				isLID: False,
				importazioneId: 0,
				magazzinoSoggettoId: 0,
				tipoStatoSoggettoId: 0,
				contattoCommercialeId: 0,
				tags: String,
				tipoDriverCommercialeId: 0,
				isWebReference: False,
				isSoggettoConBenestare: False,
				esenzioneIVAAcquisto: 0,
				esenzioneIVAVendita: 0,
				tipoPartnerId: 0,
				webIsPartnerVisibile: False,
				urlTracking: String,
				importoCredito: 0,
				odooId: 0,
				partitaIvaGruppo: 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
		}
	}
}