DigiOffice Gateway Web Services

<back to all web services

GetFavoriteDocuments

Requires Authentication
The following routes are available for this service:
GET/api/me/documents/favorites
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GetFavoriteDocuments implements IConvertible
{
    int? PageNumber;
    int? PageSize;
    List<String>? FileExtensions;

    GetFavoriteDocuments({this.PageNumber,this.PageSize,this.FileExtensions});
    GetFavoriteDocuments.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'PageNumber': PageNumber,
        'PageSize': PageSize,
        'FileExtensions': JsonConverters.toJson(FileExtensions,'List<String>',context!)
    };

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

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

Dart GetFavoriteDocuments DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/me/documents/favorites HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Document":{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}},"Date":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000"}]