GET | /api/documents/{DocumentID}/checkstoragesystem |
---|
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>