DigiOffice Gateway Web Services

<back to all web services

AddFileDocumentQueuedForRegistration

Requires Authentication
The following routes are available for this service:
POST/api/documentuploads
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 DocumentQueuedForRegistration
            Public Overridable Property DocumentuploadID As Integer
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class AddFileDocumentQueuedForRegistration
            Public Overridable Property Note As String
            Public Overridable Property Description As String
            Public Overridable Property UploadOrigin As String
            Public Overridable Property AssignToUserID As Nullable(Of Integer)
            Public Overridable Property AssignToGroupID As Nullable(Of Integer)
            Public Overridable Property DocumentInfo As String
        End Class
    End Namespace
End Namespace

VB.NET AddFileDocumentQueuedForRegistration 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 /api/documentuploads HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddFileDocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AssignToGroupID>0</AssignToGroupID>
  <AssignToUserID>0</AssignToUserID>
  <Description>String</Description>
  <DocumentInfo>String</DocumentInfo>
  <Note>String</Note>
  <UploadOrigin>String</UploadOrigin>
</AddFileDocumentQueuedForRegistration>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentuploadID>0</DocumentuploadID>
</DocumentQueuedForRegistration>