Gemma.WebApi

<back to all web services

ImmagineQuery

Requires Authentication
Requires any of the roles:Admin, ApiUser
The following routes are available for this service:
GET/immagini
ImmagineQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
NomequerystringNo
NomeStartsWithquerystringNo
NomeEndsWithquerystringNo
NomeContainsquerystringNo
NomeLikequerystringNo
NomeBetweenquerystring[]No
NomeInquerystring[]No
RefCountqueryint?No
RefCountGreaterThanOrEqualToqueryint?No
RefCountGreaterThanqueryint?No
RefCountLessThanqueryint?No
RefCountLessThanOrEqualToqueryint?No
RefCountNotEqualToqueryint?No
RefCountBetweenqueryint[]No
RefCountInqueryint[]No
IsCachedquerybool?No
DidascaliaCnIdqueryint?No
DidascaliaCnIdGreaterThanOrEqualToqueryint?No
DidascaliaCnIdGreaterThanqueryint?No
DidascaliaCnIdLessThanqueryint?No
DidascaliaCnIdLessThanOrEqualToqueryint?No
DidascaliaCnIdNotEqualToqueryint?No
DidascaliaCnIdBetweenqueryint[]No
DidascaliaCnIdInqueryint[]No
UrlquerystringNo
UrlStartsWithquerystringNo
UrlEndsWithquerystringNo
UrlContainsquerystringNo
UrlLikequerystringNo
UrlBetweenquerystring[]No
UrlInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Immagine Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
RefCountformintNo
IsCachedformboolNo
DidascaliaCnIdformintNo
UrlformstringNo
ImmagineCollegataIdformintNo
ImmagineCollegataformImmagineNo
TipoImmagineIdformintNo
TipoImmagineformTipoImmagineNo
TipoImmagine Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NomeformstringNo
AltezzaformintNo
LarghezzaformintNo
IsAlphaChannelformboolNo
AlphaColorformstringNo
IsKeyColorformboolNo
KeyColorformstringNo
PosizioneformintNo
AltezzaThumbformintNo
LarghezzaThumbformintNo
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.

GET /immagini HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			nome: String,
			refCount: 0,
			isCached: False,
			didascaliaCnId: 0,
			url: String,
			immagineCollegataId: 0,
			immagineCollegata: 
			{
				id: 0,
				nome: String,
				refCount: 0,
				isCached: False,
				didascaliaCnId: 0,
				url: String,
				immagineCollegataId: 0,
				immagineCollegata: 
				{
					id: 0,
					nome: String,
					refCount: 0,
					isCached: False,
					didascaliaCnId: 0,
					url: String,
					immagineCollegataId: 0,
					tipoImmagineId: 0,
					tipoImmagine: 
					{
						id: 0,
						nome: String,
						altezza: 0,
						larghezza: 0,
						isAlphaChannel: False,
						alphaColor: String,
						isKeyColor: False,
						keyColor: String,
						posizione: 0,
						altezzaThumb: 0,
						larghezzaThumb: 0
					}
				},
				tipoImmagineId: 0,
				tipoImmagine: 
				{
					id: 0,
					nome: String,
					altezza: 0,
					larghezza: 0,
					isAlphaChannel: False,
					alphaColor: String,
					isKeyColor: False,
					keyColor: String,
					posizione: 0,
					altezzaThumb: 0,
					larghezzaThumb: 0
				}
			},
			tipoImmagineId: 0,
			tipoImmagine: 
			{
				id: 0,
				nome: String,
				altezza: 0,
				larghezza: 0,
				isAlphaChannel: False,
				alphaColor: String,
				isKeyColor: False,
				keyColor: String,
				posizione: 0,
				altezzaThumb: 0,
				larghezzaThumb: 0
			}
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}