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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/TipoDocumentoQuery HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TipoDocumentoQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <CauMagDefaultId>0</CauMagDefaultId>
  <CauMagDefaultIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CauMagDefaultIdBetween>
  <CauMagDefaultIdGreaterThan>0</CauMagDefaultIdGreaterThan>
  <CauMagDefaultIdGreaterThanOrEqualTo>0</CauMagDefaultIdGreaterThanOrEqualTo>
  <CauMagDefaultIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CauMagDefaultIdIn>
  <CauMagDefaultIdLessThan>0</CauMagDefaultIdLessThan>
  <CauMagDefaultIdLessThanOrEqualTo>0</CauMagDefaultIdLessThanOrEqualTo>
  <CauMagDefaultIdNotEqualTo>0</CauMagDefaultIdNotEqualTo>
  <CauMovDefaultId>0</CauMovDefaultId>
  <CauMovDefaultIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CauMovDefaultIdBetween>
  <CauMovDefaultIdGreaterThan>0</CauMovDefaultIdGreaterThan>
  <CauMovDefaultIdGreaterThanOrEqualTo>0</CauMovDefaultIdGreaterThanOrEqualTo>
  <CauMovDefaultIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CauMovDefaultIdIn>
  <CauMovDefaultIdLessThan>0</CauMovDefaultIdLessThan>
  <CauMovDefaultIdLessThanOrEqualTo>0</CauMovDefaultIdLessThanOrEqualTo>
  <CauMovDefaultIdNotEqualTo>0</CauMovDefaultIdNotEqualTo>
  <Codice>String</Codice>
  <CodiceBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CodiceBetween>
  <CodiceContains>String</CodiceContains>
  <CodiceEndsWith>String</CodiceEndsWith>
  <CodiceIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CodiceIn>
  <CodiceLike>String</CodiceLike>
  <CodiceStartsWith>String</CodiceStartsWith>
  <Descrizione>String</Descrizione>
  <DescrizioneBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizioneBetween>
  <DescrizioneBreve>String</DescrizioneBreve>
  <DescrizioneBreveBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizioneBreveBetween>
  <DescrizioneBreveContains>String</DescrizioneBreveContains>
  <DescrizioneBreveEndsWith>String</DescrizioneBreveEndsWith>
  <DescrizioneBreveIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizioneBreveIn>
  <DescrizioneBreveLike>String</DescrizioneBreveLike>
  <DescrizioneBreveStartsWith>String</DescrizioneBreveStartsWith>
  <DescrizioneContains>String</DescrizioneContains>
  <DescrizioneEndsWith>String</DescrizioneEndsWith>
  <DescrizioneIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizioneIn>
  <DescrizioneLike>String</DescrizioneLike>
  <DescrizionePlurale>String</DescrizionePlurale>
  <DescrizionePluraleBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizionePluraleBetween>
  <DescrizionePluraleContains>String</DescrizionePluraleContains>
  <DescrizionePluraleEndsWith>String</DescrizionePluraleEndsWith>
  <DescrizionePluraleIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescrizionePluraleIn>
  <DescrizionePluraleLike>String</DescrizionePluraleLike>
  <DescrizionePluraleStartsWith>String</DescrizionePluraleStartsWith>
  <DescrizioneStartsWith>String</DescrizioneStartsWith>
  <GruppoId>0</GruppoId>
  <GruppoIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </GruppoIdBetween>
  <GruppoIdGreaterThan>0</GruppoIdGreaterThan>
  <GruppoIdGreaterThanOrEqualTo>0</GruppoIdGreaterThanOrEqualTo>
  <GruppoIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </GruppoIdIn>
  <GruppoIdLessThan>0</GruppoIdLessThan>
  <GruppoIdLessThanOrEqualTo>0</GruppoIdLessThanOrEqualTo>
  <GruppoIdNotEqualTo>0</GruppoIdNotEqualTo>
  <Id>0</Id>
  <IdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdBetween>
  <IdGreaterThan>0</IdGreaterThan>
  <IdGreaterThanOrEqualTo>0</IdGreaterThanOrEqualTo>
  <IdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </IdIn>
  <IdLessThan>0</IdLessThan>
  <IdLessThanOrEqualTo>0</IdLessThanOrEqualTo>
  <IdNotEqualTo>0</IdNotEqualTo>
  <IsDisattiva>false</IsDisattiva>
  <IsDiventaDefinitivo>false</IsDiventaDefinitivo>
  <IsGestisciDataScadenza>false</IsGestisciDataScadenza>
  <IsInterno>false</IsInterno>
  <IsNecessitaApprovazione>false</IsNecessitaApprovazione>
  <IsNumeratoManualmente>false</IsNumeratoManualmente>
  <IsUscita>false</IsUscita>
  <StatoPredefinitoId>0</StatoPredefinitoId>
  <StatoPredefinitoIdBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </StatoPredefinitoIdBetween>
  <StatoPredefinitoIdGreaterThan>0</StatoPredefinitoIdGreaterThan>
  <StatoPredefinitoIdGreaterThanOrEqualTo>0</StatoPredefinitoIdGreaterThanOrEqualTo>
  <StatoPredefinitoIdIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </StatoPredefinitoIdIn>
  <StatoPredefinitoIdLessThan>0</StatoPredefinitoIdLessThan>
  <StatoPredefinitoIdLessThanOrEqualTo>0</StatoPredefinitoIdLessThanOrEqualTo>
  <StatoPredefinitoIdNotEqualTo>0</StatoPredefinitoIdNotEqualTo>
</TipoDocumentoQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfTipoDocumentoCYQkyN_Pr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
    <d2p1:TipoDocumento>
      <d2p1:CauMagDefaultId>0</d2p1:CauMagDefaultId>
      <d2p1:CauMovDefaultId>0</d2p1:CauMovDefaultId>
      <d2p1:Codice>String</d2p1:Codice>
      <d2p1:Descrizione>String</d2p1:Descrizione>
      <d2p1:DescrizioneBreve>String</d2p1:DescrizioneBreve>
      <d2p1:DescrizionePlurale>String</d2p1:DescrizionePlurale>
      <d2p1:GruppoId>0</d2p1:GruppoId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsDisattiva>false</d2p1:IsDisattiva>
      <d2p1:IsDiventaDefinitivo>false</d2p1:IsDiventaDefinitivo>
      <d2p1:IsGestisciDataScadenza>false</d2p1:IsGestisciDataScadenza>
      <d2p1:IsInterno>false</d2p1:IsInterno>
      <d2p1:IsNecessitaApprovazione>false</d2p1:IsNecessitaApprovazione>
      <d2p1:IsNumeratoManualmente>false</d2p1:IsNumeratoManualmente>
      <d2p1:IsUscita>false</d2p1:IsUscita>
      <d2p1:StatoPredefinitoId>0</d2p1:StatoPredefinitoId>
    </d2p1:TipoDocumento>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfTipoDocumentoCYQkyN_Pr>