DigiOffice Gateway Web Services

<back to all web services

GetDocumentBookmarks

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/bookmarks
import 'package:servicestack/servicestack.dart';

class GetDocumentBookmarks implements IConvertible
{
    String? DocumentID;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GetDocumentBookmarks': TypeInfo(TypeOf.Class, create:() => GetDocumentBookmarks()),
});

Dart GetDocumentBookmarks DTOs

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}/bookmarks HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

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

<ArrayOfBookmark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Bookmark>
    <Name>String</Name>
    <Order>0</Order>
  </Bookmark>
</ArrayOfBookmark>