| GET POST | /api/documents |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Registrationprofile;
namespace IDB.API.DTO.Document.Operations
{
public partial class GetDocuments
{
public GetDocuments()
{
DependableFields = new List<RegistrationProfileFieldValue>{};
}
public virtual Guid? ViewID { get; set; }
public virtual int PageSize { get; set; }
public virtual int PageNumber { get; set; }
public virtual string SearchCriteria { get; set; }
public virtual Guid? ExplorerID { get; set; }
public virtual string Path { get; set; }
public virtual string ExternalNumber { get; set; }
public virtual DateTime? ModifiedSince { get; set; }
public virtual bool AllVersions { get; set; }
public virtual string OrderBy { get; set; }
public virtual bool? Archived { get; set; }
public virtual string FilterName { get; set; }
public virtual string ProgCode { get; set; }
public virtual Guid RegistrationProfileFieldID { get; set; }
public virtual List<RegistrationProfileFieldValue> DependableFields { get; set; }
public virtual bool IncludeCustomProperties { get; set; }
}
}
namespace IDB.API.DTO.Registrationprofile
{
public partial class RegistrationProfileFieldValue
{
public virtual Guid DocumentFieldID { get; set; }
public virtual string Value { get; set; }
public virtual string ShadowValue { get; set; }
public virtual bool IsModifiedByUser { get; set; }
}
}
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: doapigw.baasbv.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: {}
}
}
]