DigiOffice Gateway Web Services

<back to all web services

GetDocumentByFileUrl

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetDocumentByFileUrl
    {
        public String FileUrl = null;
        
        public String getFileUrl() { return FileUrl; }
        public GetDocumentByFileUrl setFileUrl(String value) { this.FileUrl = value; return this; }
    }

    public static class Document implements ICustomProperties
    {
        public UUID ID = null;
        public UUID RootDocumentID = null;
        public UUID RegistrationprofileID = null;
        public String Title = null;
        public String FullTitle = null;
        public String Number = null;
        public String Version = null;
        public String ExternalNumber = null;
        public String ExternalVersion = null;
        public String InternalNumber = null;
        public String InternalInvoiceNumber = null;
        public Integer PersonID = null;
        public Integer RelationID = null;
        public String RelationTitle = null;
        public Integer ProjectID = null;
        public String ProjectTitle = null;
        public String Extension = null;
        public Date Date = null;
        public Integer CommentsCount = null;
        public Boolean HasComments = null;
        public Boolean HasPreview = null;
        public String ExtraField = null;
        public Boolean IsFavorite = null;
        public String DocumentcategoryText = null;
        public Long FileSize = null;
        public Date FileDate = null;
        public String Hash = null;
        public String HashType = null;
        public String FileUrl = null;
        public String StandardDocumentUrl = null;
        public Boolean IsCorporateIdentity = null;
        public String UserTitle = null;
        public Boolean IsFrozen = null;
        public Integer InternalCompanyID = null;
        public String DirectUrl = null;
        public Boolean AllowDigitalSigningOnlyOnPrimaryVersions = null;
        public Boolean IsPrimaryVersion = null;
        public String FileExtension = null;
        public HashMap<String,Object> CustomProperties = null;
        
        public UUID getId() { return ID; }
        public Document setId(UUID value) { this.ID = value; return this; }
        public UUID getRootDocumentID() { return RootDocumentID; }
        public Document setRootDocumentID(UUID value) { this.RootDocumentID = value; return this; }
        public UUID getRegistrationprofileID() { return RegistrationprofileID; }
        public Document setRegistrationprofileID(UUID value) { this.RegistrationprofileID = value; return this; }
        public String getTitle() { return Title; }
        public Document setTitle(String value) { this.Title = value; return this; }
        public String getFullTitle() { return FullTitle; }
        public Document setFullTitle(String value) { this.FullTitle = value; return this; }
        public String getNumber() { return Number; }
        public Document setNumber(String value) { this.Number = value; return this; }
        public String getVersion() { return Version; }
        public Document setVersion(String value) { this.Version = value; return this; }
        public String getExternalNumber() { return ExternalNumber; }
        public Document setExternalNumber(String value) { this.ExternalNumber = value; return this; }
        public String getExternalVersion() { return ExternalVersion; }
        public Document setExternalVersion(String value) { this.ExternalVersion = value; return this; }
        public String getInternalNumber() { return InternalNumber; }
        public Document setInternalNumber(String value) { this.InternalNumber = value; return this; }
        public String getInternalInvoiceNumber() { return InternalInvoiceNumber; }
        public Document setInternalInvoiceNumber(String value) { this.InternalInvoiceNumber = value; return this; }
        public Integer getPersonID() { return PersonID; }
        public Document setPersonID(Integer value) { this.PersonID = value; return this; }
        public Integer getRelationID() { return RelationID; }
        public Document setRelationID(Integer value) { this.RelationID = value; return this; }
        public String getRelationTitle() { return RelationTitle; }
        public Document setRelationTitle(String value) { this.RelationTitle = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public Document setProjectID(Integer value) { this.ProjectID = value; return this; }
        public String getProjectTitle() { return ProjectTitle; }
        public Document setProjectTitle(String value) { this.ProjectTitle = value; return this; }
        public String getExtension() { return Extension; }
        public Document setExtension(String value) { this.Extension = value; return this; }
        public Date getDate() { return Date; }
        public Document setDate(Date value) { this.Date = value; return this; }
        public Integer getCommentsCount() { return CommentsCount; }
        public Document setCommentsCount(Integer value) { this.CommentsCount = value; return this; }
        public Boolean isHasComments() { return HasComments; }
        public Document setHasComments(Boolean value) { this.HasComments = value; return this; }
        public Boolean isHasPreview() { return HasPreview; }
        public Document setHasPreview(Boolean value) { this.HasPreview = value; return this; }
        public String getExtraField() { return ExtraField; }
        public Document setExtraField(String value) { this.ExtraField = value; return this; }
        public Boolean getIsFavorite() { return IsFavorite; }
        public Document setIsFavorite(Boolean value) { this.IsFavorite = value; return this; }
        public String getDocumentcategoryText() { return DocumentcategoryText; }
        public Document setDocumentcategoryText(String value) { this.DocumentcategoryText = value; return this; }
        public Long getFileSize() { return FileSize; }
        public Document setFileSize(Long value) { this.FileSize = value; return this; }
        public Date getFileDate() { return FileDate; }
        public Document setFileDate(Date value) { this.FileDate = value; return this; }
        public String getHash() { return Hash; }
        public Document setHash(String value) { this.Hash = value; return this; }
        public String getHashType() { return HashType; }
        public Document setHashType(String value) { this.HashType = value; return this; }
        public String getFileUrl() { return FileUrl; }
        public Document setFileUrl(String value) { this.FileUrl = value; return this; }
        public String getStandardDocumentUrl() { return StandardDocumentUrl; }
        public Document setStandardDocumentUrl(String value) { this.StandardDocumentUrl = value; return this; }
        public Boolean getIsCorporateIdentity() { return IsCorporateIdentity; }
        public Document setIsCorporateIdentity(Boolean value) { this.IsCorporateIdentity = value; return this; }
        public String getUserTitle() { return UserTitle; }
        public Document setUserTitle(String value) { this.UserTitle = value; return this; }
        public Boolean getIsFrozen() { return IsFrozen; }
        public Document setIsFrozen(Boolean value) { this.IsFrozen = value; return this; }
        public Integer getInternalCompanyID() { return InternalCompanyID; }
        public Document setInternalCompanyID(Integer value) { this.InternalCompanyID = value; return this; }
        public String getDirectUrl() { return DirectUrl; }
        public Document setDirectUrl(String value) { this.DirectUrl = value; return this; }
        public Boolean isAllowDigitalSigningOnlyOnPrimaryVersions() { return AllowDigitalSigningOnlyOnPrimaryVersions; }
        public Document setAllowDigitalSigningOnlyOnPrimaryVersions(Boolean value) { this.AllowDigitalSigningOnlyOnPrimaryVersions = value; return this; }
        public Boolean getIsPrimaryVersion() { return IsPrimaryVersion; }
        public Document setIsPrimaryVersion(Boolean value) { this.IsPrimaryVersion = value; return this; }
        public String getFileExtension() { return FileExtension; }
        public Document setFileExtension(String value) { this.FileExtension = value; return this; }
        public HashMap<String,Object> getCustomProperties() { return CustomProperties; }
        public Document setCustomProperties(HashMap<String,Object> value) { this.CustomProperties = value; return this; }
    }

}

Java GetDocumentByFileUrl DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetDocumentByFileUrl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentByFileUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <FileUrl>String</FileUrl>
</GetDocumentByFileUrl>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions>
  <CommentsCount>0</CommentsCount>
  <CustomProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1: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>