Gemma.WebApi

<back to all web services

ContenutoQuery

Requires Authentication
Requires any of the roles:Admin, ApiUser
The following routes are available for this service:
GET/contenuti
ContenutoQuery Parameters:
NameParameterData TypeRequiredDescription
ContenutoIdqueryint?No
ContenutoIdGreaterThanOrEqualToqueryint?No
ContenutoIdGreaterThanqueryint?No
ContenutoIdLessThanqueryint?No
ContenutoIdLessThanOrEqualToqueryint?No
ContenutoIdNotEqualToqueryint?No
ContenutoIdBetweenqueryint[]No
ContenutoIdInqueryint[]No
LinguaIdqueryint?No
LinguaIdGreaterThanOrEqualToqueryint?No
LinguaIdGreaterThanqueryint?No
LinguaIdLessThanqueryint?No
LinguaIdLessThanOrEqualToqueryint?No
LinguaIdNotEqualToqueryint?No
LinguaIdBetweenqueryint[]No
LinguaIdInqueryint[]No
TipoqueryTipoContenuto?No
TipoGreaterThanOrEqualToqueryTipoContenuto?No
TipoGreaterThanqueryTipoContenuto?No
TipoLessThanqueryTipoContenuto?No
TipoLessThanOrEqualToqueryTipoContenuto?No
TipoNotEqualToqueryTipoContenuto?No
TipoBetweenqueryTipoContenuto[]No
TipoInqueryTipoContenuto[]No
TestoquerystringNo
TestoStartsWithquerystringNo
TestoEndsWithquerystringNo
TestoContainsquerystringNo
TestoLikequerystringNo
TestoBetweenquerystring[]No
TestoInquerystring[]No
IsVisibilequerybool?No
ChiavequerystringNo
ChiaveStartsWithquerystringNo
ChiaveEndsWithquerystringNo
ChiaveContainsquerystringNo
ChiaveLikequerystringNo
ChiaveBetweenquerystring[]No
ChiaveInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>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 .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.

GET /contenuti HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfContenutoCYQkyN_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:Contenuto>
      <d2p1:Chiave>String</d2p1:Chiave>
      <d2p1:ContenutoId>0</d2p1:ContenutoId>
      <d2p1:IsVisibile>false</d2p1:IsVisibile>
      <d2p1:Lingua>
        <d2p1:CodiceLingua>String</d2p1:CodiceLingua>
        <d2p1:Descrizione>String</d2p1:Descrizione>
        <d2p1:DescrizioneCnId>0</d2p1:DescrizioneCnId>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsVisibile>false</d2p1:IsVisibile>
      </d2p1:Lingua>
      <d2p1:LinguaId>0</d2p1:LinguaId>
      <d2p1:Testo>String</d2p1:Testo>
      <d2p1:Tipo>Unknown</d2p1:Tipo>
    </d2p1:Contenuto>
  </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>
</QueryResponseOfContenutoCYQkyN_Pr>