DigiOffice Gateway Web Services

<back to all web services

SetDocumentComment

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 DocumentComment(IComment):
    id: Optional[int] = None
    document_i_d: Optional[str] = None
    user_i_d: Optional[int] = None
    username: Optional[str] = None
    text: Optional[str] = None
    date: Optional[datetime.datetime] = None
    is_mine: Optional[bool] = None


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

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

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

<DocumentComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Date>0001-01-01T00:00:00</Date>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <ID>0</ID>
  <IsMine>false</IsMine>
  <Text>String</Text>
  <UserID>0</UserID>
  <Username>String</Username>
</DocumentComment>