| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"CheckStorageSystemStatus":"Error"}