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 .xml suffix or ?format=xml

HTTP + XML

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

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

<FinalizeCorporateIdentityMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Outlook.Operations">
  <EwsUrl>String</EwsUrl>
  <ItemId>String</ItemId>
  <PidTag>String</PidTag>
  <Token>String</Token>
  <DocumentUploadId>String</DocumentUploadId>
  <MessageQueueId>String</MessageQueueId>
  <Processes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
    <d2p1:Process>
      <d2p1:Coordinator>String</d2p1:Coordinator>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Transitions>
        <d2p1:Transition>
          <d2p1:DelayDate>0001-01-01T00:00:00</d2p1:DelayDate>
          <d2p1:DelayReason>String</d2p1:DelayReason>
          <d2p1:GroupIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:GroupIDs>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:UserIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:UserIDs>
        </d2p1:Transition>
      </d2p1:Transitions>
      <d2p1:Urgent>false</d2p1:Urgent>
    </d2p1:Process>
  </Processes>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <ReplyEmailHtml>String</ReplyEmailHtml>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationValue>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationValue>
  </Values>
  <EmailHtml>String</EmailHtml>
  <EmailMessageHash>String</EmailMessageHash>
  <ModifiedFieldValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationValue>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationValue>
  </ModifiedFieldValues>
</FinalizeCorporateIdentityMail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CorporateIdentityMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Outlook">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <DocumentNr>String</DocumentNr>
  <EmailHtml>String</EmailHtml>
  <IsRegistered>false</IsRegistered>
  <RegisterAutomatically>false</RegisterAutomatically>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldStateBase>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:Readonly>false</d2p1:Readonly>
      <d2p1:Required>false</d2p1:Required>
      <d2p1:Visible>false</d2p1:Visible>
    </d2p1:RegistrationProfileFieldStateBase>
  </Values>
</CorporateIdentityMail>