Gemma.WebApi

<back to all web services

LinguaQuery

Requires Authentication
Required role:Admin
LinguaQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
DescrizionequerystringNo
DescrizioneStartsWithquerystringNo
DescrizioneEndsWithquerystringNo
DescrizioneContainsquerystringNo
DescrizioneLikequerystringNo
DescrizioneBetweenquerystring[]No
DescrizioneInquerystring[]No
DescrizioneCnIdqueryint?No
DescrizioneCnIdGreaterThanOrEqualToqueryint?No
DescrizioneCnIdGreaterThanqueryint?No
DescrizioneCnIdLessThanqueryint?No
DescrizioneCnIdLessThanOrEqualToqueryint?No
DescrizioneCnIdNotEqualToqueryint?No
DescrizioneCnIdBetweenqueryint[]No
DescrizioneCnIdInqueryint[]No
IsVisibilequerybool?No
CodiceLinguaquerystringNo
CodiceLinguaStartsWithquerystringNo
CodiceLinguaEndsWithquerystringNo
CodiceLinguaContainsquerystringNo
CodiceLinguaLikequerystringNo
CodiceLinguaBetweenquerystring[]No
CodiceLinguaInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Lingua Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescrizioneformstringNo
DescrizioneCnIdformintNo
IsVisibileformboolNo
CodiceLinguaformstringNo
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/LinguaQuery 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
	],
	descrizione: String,
	descrizioneStartsWith: String,
	descrizioneEndsWith: String,
	descrizioneContains: String,
	descrizioneLike: String,
	descrizioneBetween: 
	[
		String
	],
	descrizioneIn: 
	[
		String
	],
	descrizioneCnId: 0,
	descrizioneCnIdGreaterThanOrEqualTo: 0,
	descrizioneCnIdGreaterThan: 0,
	descrizioneCnIdLessThan: 0,
	descrizioneCnIdLessThanOrEqualTo: 0,
	descrizioneCnIdNotEqualTo: 0,
	descrizioneCnIdBetween: 
	[
		0
	],
	descrizioneCnIdIn: 
	[
		0
	],
	isVisibile: False,
	codiceLingua: String,
	codiceLinguaStartsWith: String,
	codiceLinguaEndsWith: String,
	codiceLinguaContains: String,
	codiceLinguaLike: String,
	codiceLinguaBetween: 
	[
		String
	],
	codiceLinguaIn: 
	[
		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,
			descrizione: String,
			descrizioneCnId: 0,
			isVisibile: False,
			codiceLingua: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}