Gemma.WebApi

<back to all web services

ArticoliCorrelatiRequest

Articoli
Requires Authentication
The following routes are available for this service:
GET/articoli/{ArticoloId}/correlatiRecupera gli articoli correlati (in ingresso e in uscita).
ArticoliCorrelatiRequest Parameters:
NameParameterData TypeRequiredDescription
ArticoloIdpathintYesID dell'articolo di cui cercare le correlazioni.
CodiceLinguaquerystringNoCodice ISO della lingua per i contenuti localizzati (es. IT, EN). Default: IT.
ArticoliCorrelatiResponse Parameters:
NameParameterData TypeRequiredDescription
ArticoliTargetformList<ArticoloCorrelatoDto>NoElenco degli articoli correlati in uscita (l'articolo richiesto funge da sorgente).
ArticoliSourceformList<ArticoloCorrelatoDto>NoElenco degli articoli correlati in ingresso (l'articolo richiesto funge da destinazione).
ResponseStatusformResponseStatusNoStato della risposta ed eventuali messaggi di errore.
ArticoloCorrelatoDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNoID univoco della relazione (chiave primaria della tabella di legame).
SourceIdformintNoID dell'articolo sorgente (punto di origine del legame).
TargetIdformintNoID dell'articolo destinazione (punto di arrivo del legame).
ArticoloIdformintNoID dell'articolo correlato (comodo per identificare l'entità target/source a seconda della direzione).
CodiceformstringNoCodice alfanumerico dell'articolo correlato.
DescrizioneformstringNoDescrizione principale dell'articolo correlato.
TipoRelazioneIdformintNoID del tipo di relazione.
TipoRelazioneNomeformstringNoNome predefinito del tipo di relazione (es. 'Sostituzione').
TipoRelazioneNomeLocalizzatoformstringNoNome del tipo di relazione tradotto nella lingua richiesta.
TipoRelazioneDescrizioneLocalizzataformstringNoDescrizione estesa del tipo di relazione tradotta nella lingua richiesta.

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 /articoli/{ArticoloId}/correlati HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArticoliCorrelatiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Responses">
  <ArticoliSource xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
    <d2p1:ArticoloCorrelatoDto>
      <d2p1:ArticoloId>0</d2p1:ArticoloId>
      <d2p1:Codice>String</d2p1:Codice>
      <d2p1:Descrizione>String</d2p1:Descrizione>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:SourceId>0</d2p1:SourceId>
      <d2p1:TargetId>0</d2p1:TargetId>
      <d2p1:TipoRelazioneDescrizioneLocalizzata>String</d2p1:TipoRelazioneDescrizioneLocalizzata>
      <d2p1:TipoRelazioneId>0</d2p1:TipoRelazioneId>
      <d2p1:TipoRelazioneNome>String</d2p1:TipoRelazioneNome>
      <d2p1:TipoRelazioneNomeLocalizzato>String</d2p1:TipoRelazioneNomeLocalizzato>
    </d2p1:ArticoloCorrelatoDto>
  </ArticoliSource>
  <ArticoliTarget xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Types">
    <d2p1:ArticoloCorrelatoDto>
      <d2p1:ArticoloId>0</d2p1:ArticoloId>
      <d2p1:Codice>String</d2p1:Codice>
      <d2p1:Descrizione>String</d2p1:Descrizione>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:SourceId>0</d2p1:SourceId>
      <d2p1:TargetId>0</d2p1:TargetId>
      <d2p1:TipoRelazioneDescrizioneLocalizzata>String</d2p1:TipoRelazioneDescrizioneLocalizzata>
      <d2p1:TipoRelazioneId>0</d2p1:TipoRelazioneId>
      <d2p1:TipoRelazioneNome>String</d2p1:TipoRelazioneNome>
      <d2p1:TipoRelazioneNomeLocalizzato>String</d2p1:TipoRelazioneNomeLocalizzato>
    </d2p1:ArticoloCorrelatoDto>
  </ArticoliTarget>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</ArticoliCorrelatiResponse>