| 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 .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>