DigiOffice Gateway Web Services

GetDocumentSearch

The following routes are available for this service:
POST	/api/documents/search

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

class DocumentIdentifier implements IConvertible
{
    String? ID;
    String? DisplayName;

    DocumentIdentifier({this.ID,this.DisplayName});
    DocumentIdentifier.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class GetDocumentSearch implements IDocumentSearchCriteria, IConvertible
{
    String? SearchCriteria;
    int? PageNumber;
    int? PageSize;
    List<String>? ExcludeID;
    bool? AllVersions;
    bool? Archived;

    GetDocumentSearch({this.SearchCriteria,this.PageNumber,this.PageSize,this.ExcludeID,this.AllVersions,this.Archived});
    GetDocumentSearch.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class SearchResult<DocumentIdentifier,String> implements IConvertible
{
    List<DocumentIdentifier>? Results;
    int? Total;

    SearchResult({this.Results,this.Total});
    SearchResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Total = json['Total'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Results': JsonConverters.toJson(Results,'List<DocumentIdentifier>',context!),
        'Total': Total
    };

    getTypeName() => "SearchResult<$DocumentIdentifier,$Guid>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'doapigw.baasbv.nl', types: <String, TypeInfo> {
    'DocumentIdentifier': TypeInfo(TypeOf.Class, create:() => DocumentIdentifier()),
    'GetDocumentSearch': TypeInfo(TypeOf.Class, create:() => GetDocumentSearch()),
    'SearchResult<DocumentIdentifier,String>': TypeInfo(TypeOf.Class, create:() => SearchResult<DocumentIdentifier,String>()),
});

Dart GetDocumentSearch DTOs

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

HTTP + OTHER

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

POST /api/documents/search HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SearchCriteria":"String","PageNumber":0,"PageSize":0,"ExcludeID":["00000000-0000-0000-0000-000000000000"],"AllVersions":false,"Archived":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Results":[{"ID":"00000000-0000-0000-0000-000000000000","DisplayName":"String"}],"Total":0}