DigiOffice Gateway Web Services

<back to all web services

FinalizeCorporateIdentityMail

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Outlook.Operations
Imports IDB.API.DTO.Registrationprofile
Imports IDB.API.DTO.Workflow
Imports IDB.API.DTO.Outlook

Namespace Global

    Namespace IDB.API.DTO.Outlook

        Public Partial Class CorporateIdentityMail
            Public Sub New()
                Values = New List(Of RegistrationProfileFieldStateBase)
            End Sub

            Public Overridable Property DocumentId As Guid
            Public Overridable Property EmailHtml As String
            Public Overridable Property IsRegistered As Boolean
            Public Overridable Property DocumentNr As String
            Public Overridable Property Values As List(Of RegistrationProfileFieldStateBase)
            Public Overridable Property RegistrationProfileID As Guid
            Public Overridable Property RegisterAutomatically As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.Outlook.Operations

        Public Partial Class CreateDraftCorporateIdentityMail
            Inherits Outlook365Properties
            Public Sub New()
                Values = New List(Of RegistrationValue)
                Processes = New List(Of Process)
            End Sub

            Public Overridable Property RegistrationProfileID As Guid
            Public Overridable Property Values As List(Of RegistrationValue)
            Public Overridable Property Processes As List(Of Process)
            Public Overridable Property DocumentUploadId As String
            Public Overridable Property MessageQueueId As String
            Public Overridable Property ReplyEmailHtml As String
        End Class

        Public Partial Class FinalizeCorporateIdentityMail
            Inherits UpdateDraftCorporateIdentityMail
            Public Sub New()
                ModifiedFieldValues = New RegistrationValue(){}
            End Sub

            Public Overridable Property ModifiedFieldValues As RegistrationValue()
            Public Overridable Property EmailMessageHash As String
        End Class

        Public Partial Class Outlook365Properties
            Public Overridable Property PidTag As String
            Public Overridable Property ItemId As String
            Public Overridable Property EwsUrl As String
            Public Overridable Property Token As String
        End Class

        Public Partial Class UpdateDraftCorporateIdentityMail
            Inherits CreateDraftCorporateIdentityMail
            Public Overridable Property EmailHtml As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Registrationprofile

        Public Partial Class RegistrationProfileFieldStateBase
            Public Overridable Property DocumentFieldID As Guid
            Public Overridable Property Required As Boolean
            Public Overridable Property Visible As Boolean
            Public Overridable Property Readonly As Boolean
        End Class

        Public Partial Class RegistrationValue
            Public Overridable Property Key As Guid
            Public Overridable Property Value As String
            Public Overridable Property ShadowValue As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Workflow

        Public Partial Class Process
            Public Sub New()
                Transitions = New List(Of Transition)
            End Sub

            Public Overridable Property ID As Integer
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property Note As String
            Public Overridable Property Coordinator As String
            Public Overridable Property Urgent As Boolean
            Public Overridable Property Transitions As List(Of Transition)
        End Class

        Public Partial Class Transition
            Public Sub New()
                UserIDs = New List(Of Integer)
                GroupIDs = New List(Of Integer)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property Reason As String
            Public Overridable Property DelayDate As Nullable(Of Date)
            Public Overridable Property DelayReason As String
            Public Overridable Property UserIDs As List(Of Integer)
            Public Overridable Property GroupIDs As List(Of Integer)
        End Class
    End Namespace
End Namespace

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

{"ModifiedFieldValues":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"EmailMessageHash":"String","EmailHtml":"String","RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"DocumentUploadId":"String","MessageQueueId":"String","ReplyEmailHtml":"String","PidTag":"String","ItemId":"String","EwsUrl":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DocumentId":"00000000-0000-0000-0000-000000000000","EmailHtml":"String","IsRegistered":false,"DocumentNr":"String","Values":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","RegisterAutomatically":false}