DigiOffice Gateway Web Services

AddBlobFile

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 AddBlobFileResponse:
    blob_file_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddBlobFile:
    file_name: Optional[str] = None
    type: Optional[str] = None
    image: Optional[bytes] = None
    external_i_d: Optional[str] = None

Python AddBlobFile 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/AddBlobFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddBlobFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <ExternalID>String</ExternalID>
  <FileName>String</FileName>
  <Image>AA==</Image>
  <Type>String</Type>
</AddBlobFile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddBlobFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <BlobFileID>00000000-0000-0000-0000-000000000000</BlobFileID>
</AddBlobFileResponse>