DigiOffice Gateway Web Services

<back to all web services

GetDocumentComments

Requires Authentication
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GetDocumentComments implements IConvertible
{
    String? ID;

    GetDocumentComments({this.ID});
    GetDocumentComments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID
    };

    getTypeName() => "GetDocumentComments";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GetDocumentComments': TypeInfo(TypeOf.Class, create:() => GetDocumentComments()),
});

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

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

<ArrayOfDocumentComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentComment>
    <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>
</ArrayOfDocumentComment>