Gemma.WebApi

<back to all web services

CategoriaWebQuery

Requires Authentication
Requires any of the roles:Admin, ApiUser
The following routes are available for this service:
GET/categorie-web
CategoriaWebQuery Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
IdGreaterThanOrEqualToqueryint?No
IdGreaterThanqueryint?No
IdLessThanqueryint?No
IdLessThanOrEqualToqueryint?No
IdNotEqualToqueryint?No
IdBetweenqueryint[]No
IdInqueryint[]No
ParentCategoriaWebIdqueryint?No
ParentCategoriaWebIdGreaterThanOrEqualToqueryint?No
ParentCategoriaWebIdGreaterThanqueryint?No
ParentCategoriaWebIdLessThanqueryint?No
ParentCategoriaWebIdLessThanOrEqualToqueryint?No
ParentCategoriaWebIdNotEqualToqueryint?No
ParentCategoriaWebIdBetweenqueryint[]No
ParentCategoriaWebIdInqueryint[]No
NomequerystringNo
NomeStartsWithquerystringNo
NomeEndsWithquerystringNo
NomeContainsquerystringNo
NomeLikequerystringNo
NomeBetweenquerystring[]No
NomeInquerystring[]No
NomeCnIdqueryint?No
NomeCnIdGreaterThanOrEqualToqueryint?No
NomeCnIdGreaterThanqueryint?No
NomeCnIdLessThanqueryint?No
NomeCnIdLessThanOrEqualToqueryint?No
NomeCnIdNotEqualToqueryint?No
NomeCnIdBetweenqueryint[]No
NomeCnIdInqueryint[]No
PresentazioneCnIdqueryint?No
PresentazioneCnIdGreaterThanOrEqualToqueryint?No
PresentazioneCnIdGreaterThanqueryint?No
PresentazioneCnIdLessThanqueryint?No
PresentazioneCnIdLessThanOrEqualToqueryint?No
PresentazioneCnIdNotEqualToqueryint?No
PresentazioneCnIdBetweenqueryint[]No
PresentazioneCnIdInqueryint[]No
OrdineVistaqueryint?No
OrdineVistaGreaterThanOrEqualToqueryint?No
OrdineVistaGreaterThanqueryint?No
OrdineVistaLessThanqueryint?No
OrdineVistaLessThanOrEqualToqueryint?No
OrdineVistaNotEqualToqueryint?No
OrdineVistaBetweenqueryint[]No
OrdineVistaInqueryint[]No
ImmagineIdqueryint?No
ImmagineIdGreaterThanOrEqualToqueryint?No
ImmagineIdGreaterThanqueryint?No
ImmagineIdLessThanqueryint?No
ImmagineIdLessThanOrEqualToqueryint?No
ImmagineIdNotEqualToqueryint?No
ImmagineIdBetweenqueryint[]No
ImmagineIdInqueryint[]No
IsAccessorioquerybool?No
IsPubblicatoquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CategoriaWeb Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ParentCategoriaWebIdformintNo
NomeformstringNo
NomeCnIdformintNo
PresentazioneCnIdformintNo
OrdineVistaformintNo
ImmagineIdformintNo
IsAccessorioformboolNo
IsPubblicatoformboolNo
NomiformList<Contenuto>No
PresentazioniformList<Contenuto>No
Contenuto Parameters:
NameParameterData TypeRequiredDescription
ContenutoIdformintNo
LinguaIdformintNo
TipoformTipoContenutoNo
TestoformstringNo
IsVisibileformboolNo
ChiaveformstringNo
LinguaformLinguaNo
CodiceLinguaformstringNo
TipoContenuto Enum:
Unknown
PlainText
HtmlText
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.

GET /categorie-web 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,
			parentCategoriaWebId: 0,
			nome: String,
			nomeCnId: 0,
			presentazioneCnId: 0,
			ordineVista: 0,
			immagineId: 0,
			isAccessorio: False,
			isPubblicato: False,
			nomi: 
			[
				{
					contenutoId: 0,
					linguaId: 0,
					tipo: Unknown,
					testo: String,
					isVisibile: False,
					chiave: String,
					codiceLingua: String
				}
			],
			presentazioni: 
			[
				{
					contenutoId: 0,
					linguaId: 0,
					tipo: Unknown,
					testo: String,
					isVisibile: False,
					chiave: String,
					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
		}
	}
}