DigiOffice Gateway Web Services

<back to all web services

AddFile

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

public class dtos
{

    public static class AddFile
    {
        public String Link = null;
        public UUID BlobID = null;
        public Integer Size = null;
        public Boolean IsAttachment = null;
        public Boolean Data = null;
        public Boolean OCR = null;
        public Boolean Preview = null;
        public String Type = null;
        public Date DateTimeLastModified = null;
        public Integer MetricHeight = null;
        public Integer MetricWidth = null;
        public UUID DocumentID = null;
        public String OriginalFileName = null;
        
        public String getLink() { return Link; }
        public AddFile setLink(String value) { this.Link = value; return this; }
        public UUID getBlobID() { return BlobID; }
        public AddFile setBlobID(UUID value) { this.BlobID = value; return this; }
        public Integer getSize() { return Size; }
        public AddFile setSize(Integer value) { this.Size = value; return this; }
        public Boolean getIsAttachment() { return IsAttachment; }
        public AddFile setIsAttachment(Boolean value) { this.IsAttachment = value; return this; }
        public Boolean isData() { return Data; }
        public AddFile setData(Boolean value) { this.Data = value; return this; }
        public Boolean isOcr() { return OCR; }
        public AddFile setOcr(Boolean value) { this.OCR = value; return this; }
        public Boolean isPreview() { return Preview; }
        public AddFile setPreview(Boolean value) { this.Preview = value; return this; }
        public String getType() { return Type; }
        public AddFile setType(String value) { this.Type = value; return this; }
        public Date getDateTimeLastModified() { return DateTimeLastModified; }
        public AddFile setDateTimeLastModified(Date value) { this.DateTimeLastModified = value; return this; }
        public Integer getMetricHeight() { return MetricHeight; }
        public AddFile setMetricHeight(Integer value) { this.MetricHeight = value; return this; }
        public Integer getMetricWidth() { return MetricWidth; }
        public AddFile setMetricWidth(Integer value) { this.MetricWidth = value; return this; }
        public UUID getDocumentID() { return DocumentID; }
        public AddFile setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public String getOriginalFileName() { return OriginalFileName; }
        public AddFile setOriginalFileName(String value) { this.OriginalFileName = value; return this; }
    }

    public static class AddFileResponse
    {
        public UUID FileID = null;
        
        public UUID getFileID() { return FileID; }
        public AddFileResponse setFileID(UUID value) { this.FileID = value; return this; }
    }

}

Java AddFile 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/AddFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <BlobID>00000000-0000-0000-0000-000000000000</BlobID>
  <Data>false</Data>
  <DateTimeLastModified>0001-01-01T00:00:00</DateTimeLastModified>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <IsAttachment>false</IsAttachment>
  <Link>String</Link>
  <MetricHeight>0</MetricHeight>
  <MetricWidth>0</MetricWidth>
  <OCR>false</OCR>
  <OriginalFileName>String</OriginalFileName>
  <Preview>false</Preview>
  <Size>0</Size>
  <Type>String</Type>
</AddFile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <FileID>00000000-0000-0000-0000-000000000000</FileID>
</AddFileResponse>