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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/AddFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Link":"String","BlobID":"00000000-0000-0000-0000-000000000000","Size":0,"IsAttachment":false,"Data":false,"OCR":false,"Preview":false,"Type":"String","DateTimeLastModified":"0001-01-01T00:00:00.0000000","MetricHeight":0,"MetricWidth":0,"DocumentID":"00000000-0000-0000-0000-000000000000","OriginalFileName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FileID":"00000000-0000-0000-0000-000000000000"}