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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SetDocumentComment HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","Comment":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":0,"DocumentID":"00000000-0000-0000-0000-000000000000","UserID":0,"Username":"String","Text":"String","Date":"0001-01-01T00:00:00.0000000","IsMine":false}