DigiOffice Gateway Web Services

<back to all web services

AddFile

Requires Authentication
namespace IDB.API.DTO.Document.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AddFileResponse() = 
        member val FileID:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type AddFile() = 
        member val Link:String = null with get,set
        member val BlobID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Size:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsAttachment:Boolean = new Boolean() with get,set
        member val Data:Boolean = new Boolean() with get,set
        member val OCR:Boolean = new Boolean() with get,set
        member val Preview:Boolean = new Boolean() with get,set
        member val Type:String = null with get,set
        member val DateTimeLastModified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MetricHeight:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MetricWidth:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val OriginalFileName:String = null with get,set

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