Gemma.WebApi

<back to all web services

NotaQuery

Requires Authentication
Required role:Admin
NotaQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
DataqueryDateTime?No
DataGreaterThanOrEqualToqueryDateTime?No
DataGreaterThanqueryDateTime?No
DataLessThanqueryDateTime?No
DataLessThanOrEqualToqueryDateTime?No
DataNotEqualToqueryDateTime?No
DataBetweenqueryDateTime[]No
DataInqueryDateTime[]No
UtenteIdqueryint?No
UtenteIdGreaterThanOrEqualToqueryint?No
UtenteIdGreaterThanqueryint?No
UtenteIdLessThanqueryint?No
UtenteIdLessThanOrEqualToqueryint?No
UtenteIdNotEqualToqueryint?No
UtenteIdBetweenqueryint[]No
UtenteIdInqueryint[]No
ContattoIdqueryint?No
ContattoIdGreaterThanOrEqualToqueryint?No
ContattoIdGreaterThanqueryint?No
ContattoIdLessThanqueryint?No
ContattoIdLessThanOrEqualToqueryint?No
ContattoIdNotEqualToqueryint?No
ContattoIdBetweenqueryint[]No
ContattoIdInqueryint[]No
TabellaquerystringNo
TabellaStartsWithquerystringNo
TabellaEndsWithquerystringNo
TabellaContainsquerystringNo
TabellaLikequerystringNo
TabellaBetweenquerystring[]No
TabellaInquerystring[]No
RiferimentoIdqueryint?No
RiferimentoIdGreaterThanOrEqualToqueryint?No
RiferimentoIdGreaterThanqueryint?No
RiferimentoIdLessThanqueryint?No
RiferimentoIdLessThanOrEqualToqueryint?No
RiferimentoIdNotEqualToqueryint?No
RiferimentoIdBetweenqueryint[]No
RiferimentoIdInqueryint[]No
NotaTestoquerystringNo
NotaTestoStartsWithquerystringNo
NotaTestoEndsWithquerystringNo
NotaTestoContainsquerystringNo
NotaTestoLikequerystringNo
NotaTestoBetweenquerystring[]No
NotaTestoInquerystring[]No
IsPerVerbalequerybool?No
TagNotifichequerystringNo
TagNotificheStartsWithquerystringNo
TagNotificheEndsWithquerystringNo
TagNotificheContainsquerystringNo
TagNotificheLikequerystringNo
TagNotificheBetweenquerystring[]No
TagNotificheInquerystring[]No
TestoVerbaleIdqueryint?No
TestoVerbaleIdGreaterThanOrEqualToqueryint?No
TestoVerbaleIdGreaterThanqueryint?No
TestoVerbaleIdLessThanqueryint?No
TestoVerbaleIdLessThanOrEqualToqueryint?No
TestoVerbaleIdNotEqualToqueryint?No
TestoVerbaleIdBetweenqueryint[]No
TestoVerbaleIdInqueryint[]No
IsNotaAutomaticaquerybool?No
IsEvidenziataquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Nota Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DataformDateTimeNo
UtenteIdformintNo
ContattoIdformintNo
TabellaformstringNo
RiferimentoIdformintNo
NotaTestoformstringNo
IsPerVerbaleformboolNo
TagNotificheformstringNo
TestoVerbaleIdformintNo
IsNotaAutomaticaformboolNo
IsEvidenziataformboolNo
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/NotaQuery 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
	],
	data: 0001-01-01T00:00:00,
	dataGreaterThanOrEqualTo: 0001-01-01T00:00:00,
	dataGreaterThan: 0001-01-01T00:00:00,
	dataLessThan: 0001-01-01T00:00:00,
	dataLessThanOrEqualTo: 0001-01-01T00:00:00,
	dataNotEqualTo: 0001-01-01T00:00:00,
	dataBetween: 
	[
		"0001-01-01T00: 00:00"
	],
	dataIn: 
	[
		"0001-01-01T00: 00:00"
	],
	utenteId: 0,
	utenteIdGreaterThanOrEqualTo: 0,
	utenteIdGreaterThan: 0,
	utenteIdLessThan: 0,
	utenteIdLessThanOrEqualTo: 0,
	utenteIdNotEqualTo: 0,
	utenteIdBetween: 
	[
		0
	],
	utenteIdIn: 
	[
		0
	],
	contattoId: 0,
	contattoIdGreaterThanOrEqualTo: 0,
	contattoIdGreaterThan: 0,
	contattoIdLessThan: 0,
	contattoIdLessThanOrEqualTo: 0,
	contattoIdNotEqualTo: 0,
	contattoIdBetween: 
	[
		0
	],
	contattoIdIn: 
	[
		0
	],
	tabella: String,
	tabellaStartsWith: String,
	tabellaEndsWith: String,
	tabellaContains: String,
	tabellaLike: String,
	tabellaBetween: 
	[
		String
	],
	tabellaIn: 
	[
		String
	],
	riferimentoId: 0,
	riferimentoIdGreaterThanOrEqualTo: 0,
	riferimentoIdGreaterThan: 0,
	riferimentoIdLessThan: 0,
	riferimentoIdLessThanOrEqualTo: 0,
	riferimentoIdNotEqualTo: 0,
	riferimentoIdBetween: 
	[
		0
	],
	riferimentoIdIn: 
	[
		0
	],
	notaTesto: String,
	notaTestoStartsWith: String,
	notaTestoEndsWith: String,
	notaTestoContains: String,
	notaTestoLike: String,
	notaTestoBetween: 
	[
		String
	],
	notaTestoIn: 
	[
		String
	],
	isPerVerbale: False,
	tagNotifiche: String,
	tagNotificheStartsWith: String,
	tagNotificheEndsWith: String,
	tagNotificheContains: String,
	tagNotificheLike: String,
	tagNotificheBetween: 
	[
		String
	],
	tagNotificheIn: 
	[
		String
	],
	testoVerbaleId: 0,
	testoVerbaleIdGreaterThanOrEqualTo: 0,
	testoVerbaleIdGreaterThan: 0,
	testoVerbaleIdLessThan: 0,
	testoVerbaleIdLessThanOrEqualTo: 0,
	testoVerbaleIdNotEqualTo: 0,
	testoVerbaleIdBetween: 
	[
		0
	],
	testoVerbaleIdIn: 
	[
		0
	],
	isNotaAutomatica: False,
	isEvidenziata: False,
	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,
			utenteId: 0,
			contattoId: 0,
			tabella: String,
			riferimentoId: 0,
			notaTesto: String,
			isPerVerbale: False,
			tagNotifiche: String,
			testoVerbaleId: 0,
			isNotaAutomatica: False,
			isEvidenziata: False
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}