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

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

Namespace Global

    Namespace IDB.API.DTO.Document.Operations

        Public Enum CheckStorageSystemStatus
            [Error]
            Waiting
            NoAction
            Busy
        End Enum

        '''<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 Overridable Property DocumentID As Guid
        End Class

        Public Partial Class GetDocumentStorageSystemStatusResponse
            Public Overridable Property CheckStorageSystemStatus As CheckStorageSystemStatus
        End Class
    End Namespace
End Namespace

VB.NET 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: doapigw.baasbv.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>