DigiOffice Gateway Web Services

<back to all web services

GetRegistrationProfileDetailsFromEmailDraft

Requires Authentication
GetRegistrationProfileDetailsFromEmailDraft Parameters:
NameParameterData TypeRequiredDescription
PidTagquerystringNo
IsOffice365ContextqueryboolNo
RegistrationprofileDetails Parameters:
NameParameterData TypeRequiredDescription
StepsformList<RegistrationprofileStep>No
MessagesformList<InformationMessageBase>No
ReadOnlyformboolNo
Registrationprofile Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
HintformstringNo
OrderformintNo
RegisterAutomaticallyformboolNo
RegisterInBackgroundformboolNo
ThumbnailUrlformstringNo
ProgCodeformstringNo
VersionControlTypeformintNo
WOPlaceLogoformintNo
WOPrinterBinsformstringNo
SelectAllFilesformboolNo
RegistrationprofileStep Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
OrderformintNo
LayoutformRegistrationprofileStepLayoutNo
GroupsformList<RegistrationprofileGroup>No
RegistrationprofileStepLayout Enum:
OneColumn_12
TwoColumn_6_6
TwoColumn_7_5
ThreeColumn_4_4_4
RegistrationprofileGroup Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
LabelformstringNo
OrderformintNo
ColumnIndexformintNo
FieldsformList<RegistrationprofileField>No
LabelLayoutTypeformintNo
RegistrationprofileField Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
DocumentFieldIDformGuidNo
LabelformstringNo
UserControlTypeformstringNo
UserControlPropertiesformList<SerializableKeyValuePair<String,Object>>No
HintformstringNo
OrderformintNo
HasDependableFieldsformboolNo
EntityNameformstringNo
StateformRegistrationProfileFieldStateBaseNo
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo
MessageType Enum:
NameValue
Information1
Warning2
Error3
Success4

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
}