Gemma.WebApi

<back to all web services

TipoDocumentoQuery

Requires Authentication
Required role:Admin
TipoDocumentoQuery 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
IsNumeratoManualmentequerybool?No
CodicequerystringNo
CodiceStartsWithquerystringNo
CodiceEndsWithquerystringNo
CodiceContainsquerystringNo
CodiceLikequerystringNo
CodiceBetweenquerystring[]No
CodiceInquerystring[]No
IsUscitaquerybool?No
IsInternoquerybool?No
CauMovDefaultIdqueryint?No
CauMovDefaultIdGreaterThanOrEqualToqueryint?No
CauMovDefaultIdGreaterThanqueryint?No
CauMovDefaultIdLessThanqueryint?No
CauMovDefaultIdLessThanOrEqualToqueryint?No
CauMovDefaultIdNotEqualToqueryint?No
CauMovDefaultIdBetweenqueryint[]No
CauMovDefaultIdInqueryint[]No
CauMagDefaultIdqueryint?No
CauMagDefaultIdGreaterThanOrEqualToqueryint?No
CauMagDefaultIdGreaterThanqueryint?No
CauMagDefaultIdLessThanqueryint?No
CauMagDefaultIdLessThanOrEqualToqueryint?No
CauMagDefaultIdNotEqualToqueryint?No
CauMagDefaultIdBetweenqueryint[]No
CauMagDefaultIdInqueryint[]No
GruppoIdqueryint?No
GruppoIdGreaterThanOrEqualToqueryint?No
GruppoIdGreaterThanqueryint?No
GruppoIdLessThanqueryint?No
GruppoIdLessThanOrEqualToqueryint?No
GruppoIdNotEqualToqueryint?No
GruppoIdBetweenqueryint[]No
GruppoIdInqueryint[]No
DescrizioneBrevequerystringNo
DescrizioneBreveStartsWithquerystringNo
DescrizioneBreveEndsWithquerystringNo
DescrizioneBreveContainsquerystringNo
DescrizioneBreveLikequerystringNo
DescrizioneBreveBetweenquerystring[]No
DescrizioneBreveInquerystring[]No
DescrizionePluralequerystringNo
DescrizionePluraleStartsWithquerystringNo
DescrizionePluraleEndsWithquerystringNo
DescrizionePluraleContainsquerystringNo
DescrizionePluraleLikequerystringNo
DescrizionePluraleBetweenquerystring[]No
DescrizionePluraleInquerystring[]No
IsDisattivaquerybool?No
StatoPredefinitoIdqueryint?No
StatoPredefinitoIdGreaterThanOrEqualToqueryint?No
StatoPredefinitoIdGreaterThanqueryint?No
StatoPredefinitoIdLessThanqueryint?No
StatoPredefinitoIdLessThanOrEqualToqueryint?No
StatoPredefinitoIdNotEqualToqueryint?No
StatoPredefinitoIdBetweenqueryint[]No
StatoPredefinitoIdInqueryint[]No
IsNecessitaApprovazionequerybool?No
IsGestisciDataScadenzaquerybool?No
IsDiventaDefinitivoquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
TipoDocumento Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescrizioneformstringNo
IsNumeratoManualmenteformboolNo
CodiceformstringNo
IsUscitaformboolNo
IsInternoformboolNo
CauMovDefaultIdformintNo
CauMagDefaultIdformintNo
GruppoIdformintNo
DescrizioneBreveformstringNo
DescrizionePluraleformstringNo
IsDisattivaformboolNo
StatoPredefinitoIdformintNo
IsNecessitaApprovazioneformboolNo
IsGestisciDataScadenzaformboolNo
IsDiventaDefinitivoformboolNo
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/TipoDocumentoQuery 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
	],
	isNumeratoManualmente: False,
	codice: String,
	codiceStartsWith: String,
	codiceEndsWith: String,
	codiceContains: String,
	codiceLike: String,
	codiceBetween: 
	[
		String
	],
	codiceIn: 
	[
		String
	],
	isUscita: False,
	isInterno: False,
	cauMovDefaultId: 0,
	cauMovDefaultIdGreaterThanOrEqualTo: 0,
	cauMovDefaultIdGreaterThan: 0,
	cauMovDefaultIdLessThan: 0,
	cauMovDefaultIdLessThanOrEqualTo: 0,
	cauMovDefaultIdNotEqualTo: 0,
	cauMovDefaultIdBetween: 
	[
		0
	],
	cauMovDefaultIdIn: 
	[
		0
	],
	cauMagDefaultId: 0,
	cauMagDefaultIdGreaterThanOrEqualTo: 0,
	cauMagDefaultIdGreaterThan: 0,
	cauMagDefaultIdLessThan: 0,
	cauMagDefaultIdLessThanOrEqualTo: 0,
	cauMagDefaultIdNotEqualTo: 0,
	cauMagDefaultIdBetween: 
	[
		0
	],
	cauMagDefaultIdIn: 
	[
		0
	],
	gruppoId: 0,
	gruppoIdGreaterThanOrEqualTo: 0,
	gruppoIdGreaterThan: 0,
	gruppoIdLessThan: 0,
	gruppoIdLessThanOrEqualTo: 0,
	gruppoIdNotEqualTo: 0,
	gruppoIdBetween: 
	[
		0
	],
	gruppoIdIn: 
	[
		0
	],
	descrizioneBreve: String,
	descrizioneBreveStartsWith: String,
	descrizioneBreveEndsWith: String,
	descrizioneBreveContains: String,
	descrizioneBreveLike: String,
	descrizioneBreveBetween: 
	[
		String
	],
	descrizioneBreveIn: 
	[
		String
	],
	descrizionePlurale: String,
	descrizionePluraleStartsWith: String,
	descrizionePluraleEndsWith: String,
	descrizionePluraleContains: String,
	descrizionePluraleLike: String,
	descrizionePluraleBetween: 
	[
		String
	],
	descrizionePluraleIn: 
	[
		String
	],
	isDisattiva: False,
	statoPredefinitoId: 0,
	statoPredefinitoIdGreaterThanOrEqualTo: 0,
	statoPredefinitoIdGreaterThan: 0,
	statoPredefinitoIdLessThan: 0,
	statoPredefinitoIdLessThanOrEqualTo: 0,
	statoPredefinitoIdNotEqualTo: 0,
	statoPredefinitoIdBetween: 
	[
		0
	],
	statoPredefinitoIdIn: 
	[
		0
	],
	isNecessitaApprovazione: False,
	isGestisciDataScadenza: False,
	isDiventaDefinitivo: 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,
			descrizione: String,
			isNumeratoManualmente: False,
			codice: String,
			isUscita: False,
			isInterno: False,
			cauMovDefaultId: 0,
			cauMagDefaultId: 0,
			gruppoId: 0,
			descrizioneBreve: String,
			descrizionePlurale: String,
			isDisattiva: False,
			statoPredefinitoId: 0,
			isNecessitaApprovazione: False,
			isGestisciDataScadenza: False,
			isDiventaDefinitivo: False
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}