DigiOffice Gateway Web Services

<back to all web services

UpdateDraftCorporateIdentityMail

Requires Authentication
UpdateDraftCorporateIdentityMail Parameters:
NameParameterData TypeRequiredDescription
EmailHtmlquerystringNo
CreateDraftCorporateIdentityMail Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileIDformGuidNo
ValuesformList<RegistrationValue>No
ProcessesformList<Process>No
DocumentUploadIdformstringNo
MessageQueueIdformstringNo
ReplyEmailHtmlformstringNo
Outlook365Properties Parameters:
NameParameterData TypeRequiredDescription
PidTagformstringNo
ItemIdformstringNo
EwsUrlformstringNo
TokenformstringNo
RegistrationValue Parameters:
NameParameterData TypeRequiredDescription
KeyformGuidNo
ValueformstringNo
ShadowValueformstringNo
Process Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
DescriptionformstringNo
NoteformstringNo
CoordinatorformstringNo
UrgentformboolNo
TransitionsformList<Transition>No
Transition Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
ReasonformstringNo
DelayDateformDateTime?No
DelayReasonformstringNo
UserIDsformList<int>No
GroupIDsformList<int>No
CorporateIdentityMail Parameters:
NameParameterData TypeRequiredDescription
DocumentIdformGuidNo
EmailHtmlformstringNo
IsRegisteredformboolNo
DocumentNrformstringNo
ValuesformList<RegistrationProfileFieldStateBase>No
RegistrationProfileIDformGuidNo
RegisterAutomaticallyformboolNo
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo

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/UpdateDraftCorporateIdentityMail HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EmailHtml: String,
	Values: 
	[
		{
			Value: String,
			ShadowValue: String
		}
	],
	Processes: 
	[
		{
			ID: 0,
			Title: String,
			Description: String,
			Note: String,
			Coordinator: String,
			Urgent: False,
			Transitions: 
			[
				{
					Reason: String,
					DelayDate: 0001-01-01,
					DelayReason: String,
					UserIDs: 
					[
						0
					],
					GroupIDs: 
					[
						0
					]
				}
			]
		}
	],
	DocumentUploadId: String,
	MessageQueueId: String,
	ReplyEmailHtml: String,
	PidTag: String,
	ItemId: String,
	EwsUrl: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EmailHtml: String,
	IsRegistered: False,
	DocumentNr: String,
	Values: 
	[
		{
			Required: False,
			Visible: False,
			Readonly: False
		}
	],
	RegisterAutomatically: False
}