Gemma.WebApi

<back to all web services

NumeratoreQuery

Requires Authentication
Required role:Admin
NumeratoreQuery Parameters:
NameParameterData TypeRequiredDescription
IdNumeratorequerystringNo
IdNumeratoreStartsWithquerystringNo
IdNumeratoreEndsWithquerystringNo
IdNumeratoreContainsquerystringNo
IdNumeratoreLikequerystringNo
IdNumeratoreBetweenquerystring[]No
IdNumeratoreInquerystring[]No
Numeroqueryint?No
NumeroGreaterThanOrEqualToqueryint?No
NumeroGreaterThanqueryint?No
NumeroLessThanqueryint?No
NumeroLessThanOrEqualToqueryint?No
NumeroNotEqualToqueryint?No
NumeroBetweenqueryint[]No
NumeroInqueryint[]No
AziendaIdqueryint?No
AziendaIdGreaterThanOrEqualToqueryint?No
AziendaIdGreaterThanqueryint?No
AziendaIdLessThanqueryint?No
AziendaIdLessThanOrEqualToqueryint?No
AziendaIdNotEqualToqueryint?No
AziendaIdBetweenqueryint[]No
AziendaIdInqueryint[]No
EsercizioIdqueryint?No
EsercizioIdGreaterThanOrEqualToqueryint?No
EsercizioIdGreaterThanqueryint?No
EsercizioIdLessThanqueryint?No
EsercizioIdLessThanOrEqualToqueryint?No
EsercizioIdNotEqualToqueryint?No
EsercizioIdBetweenqueryint[]No
EsercizioIdInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Numeratore Parameters:
NameParameterData TypeRequiredDescription
IdNumeratoreformstringNo
NumeroformintNo
AziendaIdformintNo
EsercizioIdformintNo
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/NumeratoreQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	idNumeratore: String,
	idNumeratoreStartsWith: String,
	idNumeratoreEndsWith: String,
	idNumeratoreContains: String,
	idNumeratoreLike: String,
	idNumeratoreBetween: 
	[
		String
	],
	idNumeratoreIn: 
	[
		String
	],
	numero: 0,
	numeroGreaterThanOrEqualTo: 0,
	numeroGreaterThan: 0,
	numeroLessThan: 0,
	numeroLessThanOrEqualTo: 0,
	numeroNotEqualTo: 0,
	numeroBetween: 
	[
		0
	],
	numeroIn: 
	[
		0
	],
	aziendaId: 0,
	aziendaIdGreaterThanOrEqualTo: 0,
	aziendaIdGreaterThan: 0,
	aziendaIdLessThan: 0,
	aziendaIdLessThanOrEqualTo: 0,
	aziendaIdNotEqualTo: 0,
	aziendaIdBetween: 
	[
		0
	],
	aziendaIdIn: 
	[
		0
	],
	esercizioId: 0,
	esercizioIdGreaterThanOrEqualTo: 0,
	esercizioIdGreaterThan: 0,
	esercizioIdLessThan: 0,
	esercizioIdLessThanOrEqualTo: 0,
	esercizioIdNotEqualTo: 0,
	esercizioIdBetween: 
	[
		0
	],
	esercizioIdIn: 
	[
		0
	],
	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: 
	[
		{
			idNumeratore: String,
			numero: 0,
			aziendaId: 0,
			esercizioId: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}