DigiOffice Gateway Web Services

<back to all web services

GetDocumentStorageSystemStatus

Check storagesystem status for a document and update if necessary.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;

namespace IDB.API.DTO.Document.Operations
{
    public enum CheckStorageSystemStatus
    {
        Error,
        Waiting,
        NoAction,
        Busy,
    }

    ///<summary>
    ///Check storagesystem status for a document and update if necessary.
    ///</summary>
    [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 partial class GetDocumentStorageSystemStatus
    {
        ///<summary>
        ///DocumentID to be checked
        ///</summary>
        [ApiMember(Description="DocumentID to be checked", IsRequired=true)]
        public virtual Guid DocumentID { get; set; }
    }

    public partial class GetDocumentStorageSystemStatusResponse
    {
        public virtual CheckStorageSystemStatus CheckStorageSystemStatus { get; set; }
    }

}

C# GetDocumentStorageSystemStatus DTOs

GET /api/documents/{DocumentID}/checkstoragesystem HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CheckStorageSystemStatus":"Error"}