DigiOffice Gateway Web Services

<back to all web services

AddFile

Requires Authentication

export class AddFileResponse
{
    public FileID?: string;

    public constructor(init?: Partial<AddFileResponse>) { (Object as any).assign(this, init); }
}

export class AddFile
{
    public Link?: string;
    public BlobID?: string;
    public Size?: number;
    public IsAttachment?: boolean;
    public Data?: boolean;
    public OCR?: boolean;
    public Preview?: boolean;
    public Type?: string;
    public DateTimeLastModified?: string;
    public MetricHeight?: number;
    public MetricWidth?: number;
    public DocumentID?: string;
    public OriginalFileName?: string;

    public constructor(init?: Partial<AddFile>) { (Object as any).assign(this, init); }
}

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