DigiOffice Gateway Web Services

<back to all web services

CreateDocument

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 CreateDocumentResponse:
    is_succes: Optional[bool] = None
    name: Optional[str] = None
    url: Optional[str] = None
    webpreview_url: Optional[str] = None
    error_messages: Optional[List[str]] = None


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

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

<CreateDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</CreateDocument>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <IsSucces>false</IsSucces>
  <Name>String</Name>
  <Url>String</Url>
  <WebpreviewUrl>String</WebpreviewUrl>
</CreateDocumentResponse>