DigiOffice Gateway Web Services

<back to all web services

AddFile

Requires Authentication 
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddFileResponse:
    file_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddFile:
    link: Optional[str] = None
    blob_i_d: Optional[str] = None
    size: Optional[int] = None
    is_attachment: Optional[bool] = None
    data: Optional[bool] = None
    ocr: Optional[bool] = None
    preview: Optional[bool] = None
    type: Optional[str] = None
    date_time_last_modified: Optional[datetime.datetime] = None
    metric_height: Optional[int] = None
    metric_width: Optional[int] = None
    document_i_d: Optional[str] = None
    original_file_name: Optional[str] = None

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