Gemma.WebApi

<back to all web services

CambiaStatoDocumentoRequest

Documenti
Requires Authentication
The following routes are available for this service:
POST/documenti/{Id}/azioni/cambio-stato
CambiaStatoDocumentoRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintYesID del documento
NuovoStatobodystringNoID numerico dello stato (es. 10 per ANNULLATO) o stringa mnemonica
NoteGiustificativebodystringYesMotivazione del cambio di stato
CambiaStatoDocumentoResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
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 /documenti/{Id}/azioni/cambio-stato HTTP/1.1 
Host: gemma.api.kerberos.energy 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CambiaStatoDocumentoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Requests">
  <Id>0</Id>
  <NoteGiustificative>String</NoteGiustificative>
  <NuovoStato>String</NuovoStato>
</CambiaStatoDocumentoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CambiaStatoDocumentoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gemma.WebApi.ServiceModel.Responses">
  <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>
  <Success>false</Success>
</CambiaStatoDocumentoResponse>