DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

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

Namespace Global

    Namespace IDB.API.DMS

        Public Partial Class AttachmentMailing
        End Class

        Public Partial Class Mailings
        End Class

        <DataContract>
        Public Partial Class MetaDataField
            <DataMember>
            Public Overridable Property ID As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property DocumentVeldID As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Label As String

            <DataMember>
            Public Overridable Property Datatype As String

            <DataMember>
            Public Overridable Property PrintLabel As String

            <DataMember>
            Public Overridable Property Entity As String

            <DataMember>
            Public Overridable Property PrintValue As String

            <DataMember>
            Public Overridable Property RegistrationValue As String

            <DataMember>
            Public Overridable Property SPSiteColumnName As String

            <DataMember>
            Public Overridable Property ShadowName As String

            <DataMember>
            Public Overridable Property ShadowDatatype As String

            <DataMember>
            Public Overridable Property ShadowSPSiteColumnName As String

            <DataMember>
            Public Overridable Property ShadowSPSiteColumnRegistrationValue As String

            <DataMember>
            Public Overridable Property ShadowRegistrationValue As String

            <DataMember>
            Public Overridable Property IsKeyField As Boolean

            <DataMember>
            Public Overridable Property KopierenBijNieuweVersie As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DMS.Operations

        Public Partial Class AddDocumentQueuedForRegistration
            Public Sub New()
                MetaData = New List(Of MetaDataField)
                AttachmentsMailings = New List(Of AttachmentMailing)
            End Sub

            Public Overridable Property RegistrationProfileID As Nullable(Of Guid)
            Public Overridable Property FileID As Nullable(Of Guid)
            Public Overridable Property Description As String
            Public Overridable Property Note As String
            Public Overridable Property UploadOrigin As String
            Public Overridable Property DocumentID As Nullable(Of Guid)
            Public Overridable Property RootDocumentID As Nullable(Of Guid)
            Public Overridable Property AssignToUserID As Nullable(Of Integer)
            Public Overridable Property AssignToGroupID As Nullable(Of Integer)
            Public Overridable Property MetaData As List(Of MetaDataField)
            Public Overridable Property Mailings As Mailings
            Public Overridable Property AttachmentsMailings As List(Of AttachmentMailing)
        End Class

        Public Partial Class DocumentQueuedForRegistrationResponse
            Public Overridable Property DocumentQueuedForRegistrationID As Integer
        End Class
    End Namespace
End Namespace

VB.NET AddDocumentQueuedForRegistration DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/AddDocumentQueuedForRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","FileID":"00000000-0000-0000-0000-000000000000","Description":"String","Note":"String","UploadOrigin":"String","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}]}

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

{"DocumentQueuedForRegistrationID":0}