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
CheckStorageSystemStatus Enum:
Error
Waiting
NoAction
Busy

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CheckStorageSystemStatus":"Error"}