DigiOffice Gateway Web Services

<back to all web services

FinalizeCorporateIdentityMail

Requires Authentication
FinalizeCorporateIdentityMail Parameters:
NameParameterData TypeRequiredDescription
ModifiedFieldValuesqueryRegistrationValue[]No
EmailMessageHashquerystringNo
UpdateDraftCorporateIdentityMail Parameters:
NameParameterData TypeRequiredDescription
EmailHtmlformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/FinalizeCorporateIdentityMail HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ModifiedFieldValues":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"EmailMessageHash":"String","EmailHtml":"String","RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","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: application/json
Content-Length: length

{"DocumentId":"00000000-0000-0000-0000-000000000000","EmailHtml":"String","IsRegistered":false,"DocumentNr":"String","Values":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","RegisterAutomatically":false}