DigiOffice Gateway Web Services

<back to all web services

AddFile

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;

namespace IDB.API.DTO.Document.Operations
{
    public partial class AddFile
    {
        public virtual string Link { get; set; }
        public virtual Guid? BlobID { get; set; }
        public virtual int? Size { get; set; }
        public virtual bool IsAttachment { get; set; }
        public virtual bool Data { get; set; }
        public virtual bool OCR { get; set; }
        public virtual bool Preview { get; set; }
        public virtual string Type { get; set; }
        public virtual DateTime? DateTimeLastModified { get; set; }
        public virtual int? MetricHeight { get; set; }
        public virtual int? MetricWidth { get; set; }
        public virtual Guid? DocumentID { get; set; }
        public virtual string OriginalFileName { get; set; }
    }

    public partial class AddFileResponse
    {
        public virtual Guid FileID { get; set; }
    }

}

C# 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>