DigiOffice Gateway Web Services

<back to all web services

GetRegistrationProfileDetailsFromEmailDraft

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Registrationprofile.Operations
Imports IDB.API.DTO.Registrationprofile
Imports IDB.Core.Diagnostics.Interfaces
Imports IDB.Core.Diagnostics

Namespace Global

    Namespace IDB.API.DTO.Registrationprofile

        Public Partial Class Registrationprofile
            Public Overridable Property ID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Hint As String
            Public Overridable Property Order As Integer
            Public Overridable Property RegisterAutomatically As Boolean
            Public Overridable Property RegisterInBackground As Boolean
            Public Overridable Property ThumbnailUrl As String
            Public Overridable Property ProgCode As String
            Public Overridable Property VersionControlType As Integer
            Public Overridable Property WOPlaceLogo As Integer
            Public Overridable Property WOPrinterBins As String
            Public Overridable Property SelectAllFiles As Boolean
        End Class

        Public Partial Class RegistrationprofileDetails
            Inherits Registrationprofile
            Public Sub New()
                Steps = New List(Of RegistrationprofileStep)
                Messages = New List(Of InformationMessageBase)
            End Sub

            Public Overridable Property Steps As List(Of RegistrationprofileStep)
            Public Overridable Property Messages As List(Of InformationMessageBase)
            Public Overridable Property ReadOnly As Boolean
        End Class

        Public Partial Class RegistrationprofileField
            Public Sub New()
                UserControlProperties = New List(Of SerializableKeyValuePair(Of String,Object))
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property DocumentFieldID As Guid
            Public Overridable Property Label As String
            Public Overridable Property UserControlType As String
            Public Overridable Property UserControlProperties As List(Of SerializableKeyValuePair(Of String,Object))
            Public Overridable Property Hint As String
            Public Overridable Property Order As Integer
            Public Overridable Property HasDependableFields As Boolean
            Public Overridable Property EntityName As String
            Public Overridable Property State As RegistrationProfileFieldStateBase
        End Class

        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 RegistrationprofileGroup
            Public Sub New()
                Fields = New List(Of RegistrationprofileField)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Label As String
            Public Overridable Property Order As Integer
            Public Overridable Property ColumnIndex As Integer
            Public Overridable Property Fields As List(Of RegistrationprofileField)
            Public Overridable Property LabelLayoutType As Integer
        End Class

        Public Partial Class RegistrationprofileStep
            Public Sub New()
                Groups = New List(Of RegistrationprofileGroup)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Order As Integer
            Public Overridable Property Layout As RegistrationprofileStep.RegistrationprofileStepLayout
            Public Overridable Property Groups As List(Of RegistrationprofileGroup)

            Public Enum RegistrationprofileStepLayout
                OneColumn_12
                TwoColumn_6_6
                TwoColumn_7_5
                ThreeColumn_4_4_4
            End Enum
        End Class
    End Namespace

    Namespace IDB.API.DTO.Registrationprofile.Operations

        Public Partial Class GetRegistrationProfileDetailsFromEmailDraft
            Public Overridable Property PidTag As String
            Public Overridable Property IsOffice365Context As Boolean
        End Class
    End Namespace

    Namespace IDB.Core.Diagnostics

        Public Enum MessageType
            Information = 1
            Warning = 2
            [Error] = 3
            Success = 4
        End Enum
    End Namespace

    Namespace IDB.Core.Diagnostics.Interfaces

        Public Partial Class InformationMessageBase
            Implements IInformationMessage
            Public Overridable Property Type As MessageType
            Public Overridable Property Summary As String
            Public Overridable Property FullMessage As String
            Public Overridable Property FieldName As String
            Public Overridable Property KeepOpen As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetRegistrationProfileDetailsFromEmailDraft DTOs

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

HTTP + JSV

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

POST /jsv/reply/GetRegistrationProfileDetailsFromEmailDraft HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PidTag: String,
	IsOffice365Context: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Steps: 
	[
		{
			Name: String,
			Order: 0,
			Layout: OneColumn_12,
			Groups: 
			[
				{
					Name: String,
					Label: String,
					Order: 0,
					ColumnIndex: 0,
					Fields: 
					[
						{
							Label: String,
							UserControlType: String,
							UserControlProperties: 
							[
								{
									
								}
							],
							Hint: String,
							Order: 0,
							HasDependableFields: False,
							EntityName: String,
							State: 
							{
								Required: False,
								Visible: False,
								Readonly: False
							}
						}
					],
					LabelLayoutType: 0
				}
			]
		}
	],
	Messages: 
	[
		{
			
		}
	],
	ReadOnly: False,
	Name: String,
	Hint: String,
	Order: 0,
	RegisterAutomatically: False,
	RegisterInBackground: False,
	ThumbnailUrl: String,
	ProgCode: String,
	VersionControlType: 0,
	WOPlaceLogo: 0,
	WOPrinterBins: String,
	SelectAllFiles: False
}