| GET POST | /api/documents |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
class RegistrationProfileFieldValue implements IConvertible
{
String? DocumentFieldID;
String? Value;
String? ShadowValue;
bool? IsModifiedByUser;
RegistrationProfileFieldValue({this.DocumentFieldID,this.Value,this.ShadowValue,this.IsModifiedByUser});
RegistrationProfileFieldValue.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DocumentFieldID = json['DocumentFieldID'];
Value = json['Value'];
ShadowValue = json['ShadowValue'];
IsModifiedByUser = json['IsModifiedByUser'];
return this;
}
Map<String, dynamic> toJson() => {
'DocumentFieldID': DocumentFieldID,
'Value': Value,
'ShadowValue': ShadowValue,
'IsModifiedByUser': IsModifiedByUser
};
getTypeName() => "RegistrationProfileFieldValue";
TypeContext? context = _ctx;
}
class GetDocuments implements IConvertible
{
String? ViewID;
int? PageSize;
int? PageNumber;
String? SearchCriteria;
String? ExplorerID;
String? Path;
String? ExternalNumber;
DateTime? ModifiedSince;
bool? AllVersions;
String? OrderBy;
bool? Archived;
String? FilterName;
String? ProgCode;
String? RegistrationProfileFieldID;
List<RegistrationProfileFieldValue>? DependableFields;
bool? IncludeCustomProperties;
GetDocuments({this.ViewID,this.PageSize,this.PageNumber,this.SearchCriteria,this.ExplorerID,this.Path,this.ExternalNumber,this.ModifiedSince,this.AllVersions,this.OrderBy,this.Archived,this.FilterName,this.ProgCode,this.RegistrationProfileFieldID,this.DependableFields,this.IncludeCustomProperties});
GetDocuments.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ViewID = json['ViewID'];
PageSize = json['PageSize'];
PageNumber = json['PageNumber'];
SearchCriteria = json['SearchCriteria'];
ExplorerID = json['ExplorerID'];
Path = json['Path'];
ExternalNumber = json['ExternalNumber'];
ModifiedSince = JsonConverters.fromJson(json['ModifiedSince'],'DateTime',context!);
AllVersions = json['AllVersions'];
OrderBy = json['OrderBy'];
Archived = json['Archived'];
FilterName = json['FilterName'];
ProgCode = json['ProgCode'];
RegistrationProfileFieldID = json['RegistrationProfileFieldID'];
DependableFields = JsonConverters.fromJson(json['DependableFields'],'List<RegistrationProfileFieldValue>',context!);
IncludeCustomProperties = json['IncludeCustomProperties'];
return this;
}
Map<String, dynamic> toJson() => {
'ViewID': ViewID,
'PageSize': PageSize,
'PageNumber': PageNumber,
'SearchCriteria': SearchCriteria,
'ExplorerID': ExplorerID,
'Path': Path,
'ExternalNumber': ExternalNumber,
'ModifiedSince': JsonConverters.toJson(ModifiedSince,'DateTime',context!),
'AllVersions': AllVersions,
'OrderBy': OrderBy,
'Archived': Archived,
'FilterName': FilterName,
'ProgCode': ProgCode,
'RegistrationProfileFieldID': RegistrationProfileFieldID,
'DependableFields': JsonConverters.toJson(DependableFields,'List<RegistrationProfileFieldValue>',context!),
'IncludeCustomProperties': IncludeCustomProperties
};
getTypeName() => "GetDocuments";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
'RegistrationProfileFieldValue': TypeInfo(TypeOf.Class, create:() => RegistrationProfileFieldValue()),
'GetDocuments': TypeInfo(TypeOf.Class, create:() => GetDocuments()),
'List<RegistrationProfileFieldValue>': TypeInfo(TypeOf.Class, create:() => <RegistrationProfileFieldValue>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ViewID: 00000000-0000-0000-0000-000000000000,
PageSize: 0,
PageNumber: 0,
SearchCriteria: String,
ExplorerID: 00000000-0000-0000-0000-000000000000,
Path: String,
ExternalNumber: String,
ModifiedSince: 0001-01-01,
AllVersions: False,
OrderBy: String,
Archived: False,
FilterName: String,
ProgCode: String,
DependableFields:
[
{
Value: String,
ShadowValue: String,
IsModifiedByUser: False
}
],
IncludeCustomProperties: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
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-01,
CommentsCount: 0,
HasComments: False,
HasPreview: False,
ExtraField: String,
IsFavorite: False,
DocumentcategoryText: String,
FileSize: 0,
FileDate: 0001-01-01,
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: {}
}
}
]