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 .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 HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocuments 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>
<DependableFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
<d2p1:RegistrationProfileFieldValue>
<d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
<d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
<d2p1:ShadowValue>String</d2p1:ShadowValue>
<d2p1:Value>String</d2p1:Value>
</d2p1:RegistrationProfileFieldValue>
</DependableFields>
<ExplorerID>00000000-0000-0000-0000-000000000000</ExplorerID>
<ExternalNumber>String</ExternalNumber>
<FilterName>String</FilterName>
<IncludeCustomProperties>false</IncludeCustomProperties>
<ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
<OrderBy>String</OrderBy>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<Path>String</Path>
<ProgCode>String</ProgCode>
<RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
<SearchCriteria>String</SearchCriteria>
<ViewID>00000000-0000-0000-0000-000000000000</ViewID>
</GetDocuments>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document"> <Document> <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions> <CommentsCount>0</CommentsCount> <CustomProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>String</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </CustomProperties> <Date>0001-01-01T00:00:00</Date> <DirectUrl>String</DirectUrl> <DocumentcategoryText>String</DocumentcategoryText> <Extension>String</Extension> <ExternalNumber>String</ExternalNumber> <ExternalVersion>String</ExternalVersion> <ExtraField>String</ExtraField> <FileDate>0001-01-01T00:00:00</FileDate> <FileExtension>String</FileExtension> <FileSize>0</FileSize> <FileUrl>String</FileUrl> <FullTitle>String</FullTitle> <HasPreview>false</HasPreview> <Hash>String</Hash> <HashType>String</HashType> <ID>00000000-0000-0000-0000-000000000000</ID> <InternalCompanyID>0</InternalCompanyID> <InternalInvoiceNumber>String</InternalInvoiceNumber> <InternalNumber>String</InternalNumber> <IsCorporateIdentity>false</IsCorporateIdentity> <IsFavorite>false</IsFavorite> <IsFrozen>false</IsFrozen> <IsPrimaryVersion>false</IsPrimaryVersion> <Number>String</Number> <PersonID>0</PersonID> <ProjectID>0</ProjectID> <ProjectTitle>String</ProjectTitle> <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID> <RelationID>0</RelationID> <RelationTitle>String</RelationTitle> <RootDocumentID>00000000-0000-0000-0000-000000000000</RootDocumentID> <StandardDocumentUrl>String</StandardDocumentUrl> <Title>String</Title> <UserTitle>String</UserTitle> <Version>String</Version> </Document> </ArrayOfDocument>