DigiOffice Gateway Web Services

<back to all web services

GetDocumentStorageSystemStatus

Check storagesystem status for a document and update if necessary.

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/checkstoragesystem
GetDocumentStorageSystemStatus Parameters:
NameParameterData TypeRequiredDescription
DocumentIDpathGuidYesDocumentID to be checked
GetDocumentStorageSystemStatusResponse Parameters:
NameParameterData TypeRequiredDescription
CheckStorageSystemStatusformCheckStorageSystemStatusNo

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>