DigiOffice Gateway Web Services

GetDocumentStorageSystemStatus

Check storagesystem status for a document and update if necessary.

The following routes are available for this service:
GET	/api/documents/{DocumentID}/checkstoragesystem

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

enum CheckStorageSystemStatus
{
    Error,
    Waiting,
    NoAction,
    Busy,
}

class GetDocumentStorageSystemStatusResponse implements IConvertible
{
    CheckStorageSystemStatus? CheckStorageSystemStatus;

    GetDocumentStorageSystemStatusResponse({this.CheckStorageSystemStatus});
    GetDocumentStorageSystemStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CheckStorageSystemStatus = JsonConverters.fromJson(json['CheckStorageSystemStatus'],'CheckStorageSystemStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CheckStorageSystemStatus': JsonConverters.toJson(CheckStorageSystemStatus,'CheckStorageSystemStatus',context!)
    };

    getTypeName() => "GetDocumentStorageSystemStatusResponse";
    TypeContext? context = _ctx;
}

/**
* Check storagesystem status for a document and update if necessary.
*/
// @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)
class GetDocumentStorageSystemStatus implements IConvertible
{
    /**
    * DocumentID to be checked
    */
    // @ApiMember(Description="DocumentID to be checked", IsRequired=true)
    String? DocumentID;

    GetDocumentStorageSystemStatus({this.DocumentID});
    GetDocumentStorageSystemStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentID = json['DocumentID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentID': DocumentID
    };

    getTypeName() => "GetDocumentStorageSystemStatus";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'doapigw.baasbv.nl', types: <String, TypeInfo> {
    'CheckStorageSystemStatus': TypeInfo(TypeOf.Enum, enumValues:CheckStorageSystemStatus.values),
    'GetDocumentStorageSystemStatusResponse': TypeInfo(TypeOf.Class, create:() => GetDocumentStorageSystemStatusResponse()),
    'GetDocumentStorageSystemStatus': TypeInfo(TypeOf.Class, create:() => GetDocumentStorageSystemStatus()),
});

Dart 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: doapigw.baasbv.nl 
Accept: application/json

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

{"CheckStorageSystemStatus":"Error"}