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>()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocumentSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<AllVersions>false</AllVersions>
<Archived>false</Archived>
<ExcludeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ExcludeID>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<SearchCriteria>String</SearchCriteria>
</GetDocumentSearch>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SearchResultOfDocumentIdentifierguidGNR3VCgI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common"> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document"> <d2p1:DocumentIdentifier> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID> </d2p1:DocumentIdentifier> </Results> <Total>0</Total> </SearchResultOfDocumentIdentifierguidGNR3VCgI>