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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class CheckStorageSystemStatus(str, Enum):
    ERROR = 'Error'
    WAITING = 'Waiting'
    NO_ACTION = 'NoAction'
    BUSY = 'Busy'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentStorageSystemStatusResponse:
    check_storage_system_status: Optional[CheckStorageSystemStatus] = None


# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentStorageSystemStatus:
    """
    Check storagesystem status for a document and update if necessary.
    """

    # @ApiMember(Description="DocumentID to be checked", IsRequired=true)
    document_i_d: Optional[str] = None
    """
    DocumentID to be checked
    """

Python GetDocumentStorageSystemStatus DTOs

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"}