DigiOffice Gateway Web Services

<back to all web services

SetDocumentComment

Requires Authentication
"use strict";
export class DocumentComment {
    /** @param {{ID?:number,DocumentID?:string,UserID?:number,Username?:string,Text?:string,Date?:string,IsMine?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    DocumentID;
    /** @type {number} */
    UserID;
    /** @type {string} */
    Username;
    /** @type {string} */
    Text;
    /** @type {string} */
    Date;
    /** @type {boolean} */
    IsMine;
}
export class SetDocumentComment {
    /** @param {{ID?:string,Comment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Comment;
}

JavaScript 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: dogw.klokgroep.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>