| GET | /api/documents/{DocumentID}/checkstoragesystem |
|---|
namespace IDB.API.DTO.Document.Operations
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type CheckStorageSystemStatus =
| Error = 0
| Waiting = 1
| NoAction = 2
| Busy = 3
[<AllowNullLiteral>]
type GetDocumentStorageSystemStatusResponse() =
member val CheckStorageSystemStatus:CheckStorageSystemStatus = new CheckStorageSystemStatus() with get,set
///<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)>]
[<AllowNullLiteral>]
type GetDocumentStorageSystemStatus() =
///<summary>
///DocumentID to be checked
///</summary>
[<ApiMember(Description="DocumentID to be checked", IsRequired=true)>]
member val DocumentID:Guid = new Guid() with get,set
F# GetDocumentStorageSystemStatus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CheckStorageSystemStatus: Error
}