| GET POST | /api/documents |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
public static class GetDocuments
{
public UUID ViewID = null;
public Integer PageSize = null;
public Integer PageNumber = null;
public String SearchCriteria = null;
public UUID ExplorerID = null;
public String Path = null;
public String ExternalNumber = null;
public Date ModifiedSince = null;
public Boolean AllVersions = null;
public String OrderBy = null;
public Boolean Archived = null;
public String FilterName = null;
public String ProgCode = null;
public UUID RegistrationProfileFieldID = null;
public ArrayList<RegistrationProfileFieldValue> DependableFields = null;
public Boolean IncludeCustomProperties = null;
public UUID getViewID() { return ViewID; }
public GetDocuments setViewID(UUID value) { this.ViewID = value; return this; }
public Integer getPageSize() { return PageSize; }
public GetDocuments setPageSize(Integer value) { this.PageSize = value; return this; }
public Integer getPageNumber() { return PageNumber; }
public GetDocuments setPageNumber(Integer value) { this.PageNumber = value; return this; }
public String getSearchCriteria() { return SearchCriteria; }
public GetDocuments setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
public UUID getExplorerID() { return ExplorerID; }
public GetDocuments setExplorerID(UUID value) { this.ExplorerID = value; return this; }
public String getPath() { return Path; }
public GetDocuments setPath(String value) { this.Path = value; return this; }
public String getExternalNumber() { return ExternalNumber; }
public GetDocuments setExternalNumber(String value) { this.ExternalNumber = value; return this; }
public Date getModifiedSince() { return ModifiedSince; }
public GetDocuments setModifiedSince(Date value) { this.ModifiedSince = value; return this; }
public Boolean isAllVersions() { return AllVersions; }
public GetDocuments setAllVersions(Boolean value) { this.AllVersions = value; return this; }
public String getOrderBy() { return OrderBy; }
public GetDocuments setOrderBy(String value) { this.OrderBy = value; return this; }
public Boolean isArchived() { return Archived; }
public GetDocuments setArchived(Boolean value) { this.Archived = value; return this; }
public String getFilterName() { return FilterName; }
public GetDocuments setFilterName(String value) { this.FilterName = value; return this; }
public String getProgCode() { return ProgCode; }
public GetDocuments setProgCode(String value) { this.ProgCode = value; return this; }
public UUID getRegistrationProfileFieldID() { return RegistrationProfileFieldID; }
public GetDocuments setRegistrationProfileFieldID(UUID value) { this.RegistrationProfileFieldID = value; return this; }
public ArrayList<RegistrationProfileFieldValue> getDependableFields() { return DependableFields; }
public GetDocuments setDependableFields(ArrayList<RegistrationProfileFieldValue> value) { this.DependableFields = value; return this; }
public Boolean isIncludeCustomProperties() { return IncludeCustomProperties; }
public GetDocuments setIncludeCustomProperties(Boolean value) { this.IncludeCustomProperties = value; return this; }
}
public static class RegistrationProfileFieldValue
{
public UUID DocumentFieldID = null;
public String Value = null;
public String ShadowValue = null;
public Boolean IsModifiedByUser = null;
public UUID getDocumentFieldID() { return DocumentFieldID; }
public RegistrationProfileFieldValue setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
public String getValue() { return Value; }
public RegistrationProfileFieldValue setValue(String value) { this.Value = value; return this; }
public String getShadowValue() { return ShadowValue; }
public RegistrationProfileFieldValue setShadowValue(String value) { this.ShadowValue = value; return this; }
public Boolean getIsModifiedByUser() { return IsModifiedByUser; }
public RegistrationProfileFieldValue setIsModifiedByUser(Boolean value) { this.IsModifiedByUser = value; return this; }
}
}
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: {}
}
}
]