DigiOffice Gateway Web Services

GetProcessDetailsRegistrationForm

The following routes are available for this service:
POST	/api/processes/registrationform

**GetProcessDetailsRegistrationForm** Parameters:
Name	Parameter	Data Type	Required
ProcessID	body	int	No
RegistrationprofileID	body	Guid	No
DocumentID	body	Guid?	No
CurrentRegistrationprofileFieldValues	body	List<RegistrationProfileFieldValue>	No
IsOffice365Context	body	bool	No
PidTag	body	string	No

**RegistrationProfileFieldValue** Parameters:
Name	Parameter	Data Type	Required
DocumentFieldID	form	Guid	No
Value	form	string	No
ShadowValue	form	string	No
IsModifiedByUser	form	bool	No

**ProcessDetails** Parameters:
Name	Parameter	Data Type	Required	Description
ShowCoordinatorField	form	bool	No

**SideStepDetails** Parameters:
Name	Parameter	Data Type	Required
Coordinator	form	User	No
Comment	form	WorkflowTaskActionComment	No
Urgent	form	bool	No

**AdhocTransitionDetails** Parameters:
Name	Parameter	Data Type	Required	Description
AdhocTransitions	form	List<WorkflowTaskAdhocTransition>	No

**WorkflowTaskAdhocTransition** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
Title	form	string	No
AssignmentAllowed	form	bool	No
AssignmentRequired	form	bool	No
UserEnvironment	form	int	No
Users	form	List<User>	No
Groups	form	List<Group>	No
Delay	form	WorkflowTaskDelay	No
Reason	form	WorkflowTaskReason	No
UsersOrGroups	form	List<UserOrGroup>	No
Value	form	string	No

**User** Parameters:
Name	Parameter	Data Type	Required	Description
Image	form	string	No

**UserOrGroup** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Title	form	string	No
IsChecked	form	bool	No
Image	form	string	No

**Group** Parameters:
Name	Parameter	Data Type	Required	Description
Image	form	string	No

**WorkflowTaskDelay** Parameters:
Name	Parameter	Data Type	Required	Description
DelayDate	form	DateTime?	No
Reason	form	string	No

**WorkflowTaskReason** Parameters:
Name	Parameter	Data Type	Required	Description
Reason	form	string	No
Required	form	bool	No

**WorkflowTaskActionComment** Parameters:
Name	Parameter	Data Type	Required	Description
Comment	form	string	No
Required	form	bool	No

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: doapigw.baasbv.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"
		}
	]
}