| GET POST | /api/documents |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class GetDocuments
{
var ViewID:UUID? = null
var PageSize:Int? = null
var PageNumber:Int? = null
var SearchCriteria:String? = null
var ExplorerID:UUID? = null
var Path:String? = null
var ExternalNumber:String? = null
var ModifiedSince:Date? = null
var AllVersions:Boolean? = null
var OrderBy:String? = null
var Archived:Boolean? = null
var FilterName:String? = null
var ProgCode:String? = null
var RegistrationProfileFieldID:UUID? = null
var DependableFields:ArrayList<RegistrationProfileFieldValue> = ArrayList<RegistrationProfileFieldValue>()
var IncludeCustomProperties:Boolean? = null
}
open class RegistrationProfileFieldValue
{
var DocumentFieldID:UUID? = null
var Value:String? = null
var ShadowValue:String? = null
var IsModifiedByUser:Boolean? = null
}
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: {}
}
}
]