DigiOffice Gateway Web Services

<back to all web services

SetDocumentComment

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

Namespace Global

    Namespace IDB.API.DTO.Document

        Public Partial Class DocumentComment
            Implements IComment
            Public Overridable Property ID As Integer
            Public Overridable Property DocumentID As Guid
            Public Overridable Property UserID As Integer
            Public Overridable Property Username As String
            Public Overridable Property Text As String
            Public Overridable Property [Date] As Date
            Public Overridable Property IsMine As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class SetDocumentComment
            Public Overridable Property ID As Guid
            Public Overridable Property Comment As String
        End Class
    End Namespace
End Namespace

VB.NET 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>