DigiOffice Gateway Web Services

<back to all web services

GetRegistrationProfileDetailsFromEmailDraft

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetRegistrationProfileDetailsFromEmailDraft
{
    var PidTag:String? = null
    var IsOffice365Context:Boolean? = null
}

open class RegistrationprofileDetails : Registrationprofile()
{
    var Steps:ArrayList<RegistrationprofileStep> = ArrayList<RegistrationprofileStep>()
    var Messages:ArrayList<InformationMessageBase> = ArrayList<InformationMessageBase>()
    var ReadOnly:Boolean? = null
}

open class Registrationprofile
{
    var ID:UUID? = null
    var Name:String? = null
    var Hint:String? = null
    var Order:Int? = null
    var RegisterAutomatically:Boolean? = null
    var RegisterInBackground:Boolean? = null
    var ThumbnailUrl:String? = null
    var ProgCode:String? = null
    var VersionControlType:Int? = null
    var WOPlaceLogo:Int? = null
    var WOPrinterBins:String? = null
    var SelectAllFiles:Boolean? = null
}

open class RegistrationprofileStep
{
    var ID:UUID? = null
    var Name:String? = null
    var Order:Int? = null
    var Layout:RegistrationprofileStepLayout? = null
    var Groups:ArrayList<RegistrationprofileGroup> = ArrayList<RegistrationprofileGroup>()
}

enum class RegistrationprofileStepLayout
{
    OneColumn12,
    TwoColumn66,
    TwoColumn75,
    ThreeColumn444,
}

open class RegistrationprofileGroup
{
    var ID:UUID? = null
    var Name:String? = null
    var Label:String? = null
    var Order:Int? = null
    var ColumnIndex:Int? = null
    var Fields:ArrayList<RegistrationprofileField> = ArrayList<RegistrationprofileField>()
    var LabelLayoutType:Int? = null
}

open class RegistrationprofileField
{
    var ID:UUID? = null
    var DocumentFieldID:UUID? = null
    var Label:String? = null
    var UserControlType:String? = null
    var UserControlProperties:ArrayList<SerializableKeyValuePair<String,Object>> = ArrayList<SerializableKeyValuePair<String,Object>>()
    var Hint:String? = null
    var Order:Int? = null
    var HasDependableFields:Boolean? = null
    var EntityName:String? = null
    var State:RegistrationProfileFieldStateBase? = null
}

open class RegistrationProfileFieldStateBase
{
    var DocumentFieldID:UUID? = null
    var Required:Boolean? = null
    var Visible:Boolean? = null
    var Readonly:Boolean? = null
}

open class InformationMessageBase : IInformationMessage
{
    var Type:MessageType? = null
    var Summary:String? = null
    var FullMessage:String? = null
    var FieldName:String? = null
    var KeepOpen:Boolean? = null
}

enum class MessageType(val value:Int)
{
    Information(1),
    Warning(2),
    Error(3),
    Success(4),
}

Kotlin 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
}