Gemma.WebApi

<back to all web services

ListinoQuery

Requires Authentication
Required role:Admin
ListinoQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
AziendaIdqueryint?No
AziendaIdGreaterThanOrEqualToqueryint?No
AziendaIdGreaterThanqueryint?No
AziendaIdLessThanqueryint?No
AziendaIdLessThanOrEqualToqueryint?No
AziendaIdNotEqualToqueryint?No
AziendaIdBetweenqueryNullable<Int32>[]No
AziendaIdInqueryNullable<Int32>[]No
NomequerystringNo
NomeStartsWithquerystringNo
NomeEndsWithquerystringNo
NomeContainsquerystringNo
NomeLikequerystringNo
NomeBetweenquerystring[]No
NomeInquerystring[]No
IsListinoBasequerybool?No
IsPredefinitoquerybool?No
DescrizionequerystringNo
DescrizioneStartsWithquerystringNo
DescrizioneEndsWithquerystringNo
DescrizioneContainsquerystringNo
DescrizioneLikequerystringNo
DescrizioneBetweenquerystring[]No
DescrizioneInquerystring[]No
DataModificaqueryDateTime?No
DataModificaGreaterThanOrEqualToqueryDateTime?No
DataModificaGreaterThanqueryDateTime?No
DataModificaLessThanqueryDateTime?No
DataModificaLessThanOrEqualToqueryDateTime?No
DataModificaNotEqualToqueryDateTime?No
DataModificaBetweenqueryDateTime[]No
DataModificaInqueryDateTime[]No
IsNascostoquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Listino Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AziendaIdformint?No
NomeformstringNo
IsListinoBaseformboolNo
IsPredefinitoformboolNo
DescrizioneformstringNo
DataModificaformDateTimeNo
IsNascostoformboolNo
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/ListinoQuery 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
	],
	aziendaId: 0,
	aziendaIdGreaterThanOrEqualTo: 0,
	aziendaIdGreaterThan: 0,
	aziendaIdLessThan: 0,
	aziendaIdLessThanOrEqualTo: 0,
	aziendaIdNotEqualTo: 0,
	aziendaIdBetween: 
	[
		0
	],
	aziendaIdIn: 
	[
		0
	],
	nome: String,
	nomeStartsWith: String,
	nomeEndsWith: String,
	nomeContains: String,
	nomeLike: String,
	nomeBetween: 
	[
		String
	],
	nomeIn: 
	[
		String
	],
	isListinoBase: False,
	isPredefinito: False,
	descrizione: String,
	descrizioneStartsWith: String,
	descrizioneEndsWith: String,
	descrizioneContains: String,
	descrizioneLike: String,
	descrizioneBetween: 
	[
		String
	],
	descrizioneIn: 
	[
		String
	],
	dataModifica: 0001-01-01T00:00:00,
	dataModificaGreaterThanOrEqualTo: 0001-01-01T00:00:00,
	dataModificaGreaterThan: 0001-01-01T00:00:00,
	dataModificaLessThan: 0001-01-01T00:00:00,
	dataModificaLessThanOrEqualTo: 0001-01-01T00:00:00,
	dataModificaNotEqualTo: 0001-01-01T00:00:00,
	dataModificaBetween: 
	[
		"0001-01-01T00: 00:00"
	],
	dataModificaIn: 
	[
		"0001-01-01T00: 00:00"
	],
	isNascosto: 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,
			aziendaId: 0,
			nome: String,
			isListinoBase: False,
			isPredefinito: False,
			descrizione: String,
			isNascosto: False
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}