DigiOffice Gateway Web Services

GetDocumentStorageSystemStatus

Check storagesystem status for a document and update if necessary.

The following routes are available for this service:
GET	/api/documents/{DocumentID}/checkstoragesystem

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Check storagesystem status for a document and update if necessary.
    */
    @Api(Description="Check storagesystem status for a document and update if necessary.")
    @ApiResponse(Description="Status of the document (Error,NotAvailable,IsAvailable,NotAvailableBeingUpdated) ", IsDefaultResponse=true, StatusCode=200)
    // @ApiResponse(Description="Document is moved to recycle bin", StatusCode=204)
    // @ApiResponse(Description="Unauthorized to read document", StatusCode=401)
    // @ApiResponse(Description="Document not found", StatusCode=410)
    public static class GetDocumentStorageSystemStatus
    {
        /**
        * DocumentID to be checked
        */
        @ApiMember(Description="DocumentID to be checked", IsRequired=true)
        public UUID DocumentID = null;
        
        public UUID getDocumentID() { return DocumentID; }
        public GetDocumentStorageSystemStatus setDocumentID(UUID value) { this.DocumentID = value; return this; }
    }

    public static class GetDocumentStorageSystemStatusResponse
    {
        public CheckStorageSystemStatus CheckStorageSystemStatus = null;
        
        public CheckStorageSystemStatus getCheckStorageSystemStatus() { return CheckStorageSystemStatus; }
        public GetDocumentStorageSystemStatusResponse setCheckStorageSystemStatus(CheckStorageSystemStatus value) { this.CheckStorageSystemStatus = value; return this; }
    }

    public static enum CheckStorageSystemStatus
    {
        Error,
        Waiting,
        NoAction,
        Busy;
    }

}

Java GetDocumentStorageSystemStatus DTOs

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 /api/documents/{DocumentID}/checkstoragesystem HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDocumentStorageSystemStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <CheckStorageSystemStatus>Error</CheckStorageSystemStatus>
</GetDocumentStorageSystemStatusResponse>