DigiOffice Gateway Web Services

<back to all web services

GetProcessDetailsRegistrationForm

Requires Authentication
The following routes are available for this service:
POST/api/processes/registrationform
namespace IDB.API.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserOrGroup() = 
        member val ID:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val IsChecked:Boolean = new Boolean() with get,set
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type User() = 
        inherit UserOrGroup()
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type Group() = 
        inherit UserOrGroup()
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskDelay() = 
        member val DelayDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Reason:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskReason() = 
        member val Reason:String = null with get,set
        member val Required:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskAdhocTransition() = 
        member val ID:Guid = new Guid() with get,set
        member val Title:String = null with get,set
        member val AssignmentAllowed:Boolean = new Boolean() with get,set
        member val AssignmentRequired:Boolean = new Boolean() with get,set
        member val UserEnvironment:Int32 = new Int32() with get,set
        member val Users:ResizeArray<User> = new ResizeArray<User>() with get,set
        member val Groups:ResizeArray<Group> = new ResizeArray<Group>() with get,set
        member val Delay:WorkflowTaskDelay = null with get,set
        member val Reason:WorkflowTaskReason = null with get,set
        member val UsersOrGroups:ResizeArray<UserOrGroup> = new ResizeArray<UserOrGroup>() with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type AdhocTransitionDetails() = 
        member val AdhocTransitions:ResizeArray<WorkflowTaskAdhocTransition> = new ResizeArray<WorkflowTaskAdhocTransition>() with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskActionComment() = 
        member val Comment:String = null with get,set
        member val Required:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SideStepDetails() = 
        inherit AdhocTransitionDetails()
        member val Coordinator:User = null with get,set
        member val Comment:WorkflowTaskActionComment = null with get,set
        member val Urgent:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ProcessDetails() = 
        inherit SideStepDetails()
        member val ShowCoordinatorField:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RegistrationProfileFieldValue() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set
        member val IsModifiedByUser:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetProcessDetailsRegistrationForm() = 
        member val ProcessID:Int32 = new Int32() with get,set
        member val RegistrationprofileID:Guid = new Guid() with get,set
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val CurrentRegistrationprofileFieldValues:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set
        member val IsOffice365Context:Boolean = new Boolean() with get,set
        member val PidTag:String = null with get,set

F# GetProcessDetailsRegistrationForm 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 /api/processes/registrationform HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProcessID: 0,
	DocumentID: 00000000-0000-0000-0000-000000000000,
	CurrentRegistrationprofileFieldValues: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	IsOffice365Context: False,
	PidTag: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ShowCoordinatorField: False,
	Coordinator: 
	{
		Image: Icons/User,
		ID: 0,
		Title: String,
		IsChecked: False
	},
	Comment: 
	{
		Comment: String,
		Required: False
	},
	Urgent: False,
	AdhocTransitions: 
	[
		{
			Title: String,
			AssignmentAllowed: False,
			AssignmentRequired: False,
			UserEnvironment: 0,
			Users: 
			[
				{
					Image: Icons/User,
					ID: 0,
					Title: String,
					IsChecked: False
				}
			],
			Groups: 
			[
				{
					Image: Icons/Group,
					ID: 0,
					Title: String,
					IsChecked: False
				}
			],
			Delay: 
			{
				DelayDate: 0001-01-01,
				Reason: String
			},
			Reason: 
			{
				Reason: String,
				Required: False
			},
			UsersOrGroups: 
			[
				{
					__type: "IDB.API.DTO.User, IDB.API.DTO",
					Image: Icons/User,
					ID: 0,
					Title: String,
					IsChecked: False
				},
				{
					__type: "IDB.API.DTO.Group, IDB.API.DTO",
					Image: Icons/Group,
					ID: 0,
					Title: String,
					IsChecked: False
				}
			],
			Value: "String
String"
		}
	]
}