DigiOffice Gateway Web Services

<back to all web services

SetDocumentComment

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Document;

namespace IDB.API.DTO.Document
{
    public partial class DocumentComment
        : IComment
    {
        public virtual int ID { get; set; }
        public virtual Guid DocumentID { get; set; }
        public virtual int UserID { get; set; }
        public virtual string Username { get; set; }
        public virtual string Text { get; set; }
        public virtual DateTime Date { get; set; }
        public virtual bool IsMine { get; set; }
    }

}

namespace IDB.API.DTO.Document.Operations
{
    public partial class SetDocumentComment
    {
        public virtual Guid ID { get; set; }
        public virtual string Comment { get; set; }
    }

}

C# 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>