DigiOffice Gateway Web Services

<back to all web services

FinalizeCorporateIdentityMail

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FinalizeCorporateIdentityMail : UpdateDraftCorporateIdentityMail()
{
    open var ModifiedFieldValues:ArrayList<RegistrationValue>? = null
    open var EmailMessageHash:String? = null
}

open class UpdateDraftCorporateIdentityMail : CreateDraftCorporateIdentityMail()
{
    open var EmailHtml:String? = null
}

open class CreateDraftCorporateIdentityMail : Outlook365Properties()
{
    open var RegistrationProfileID:UUID? = null
    open var Values:ArrayList<RegistrationValue>? = null
    open var Processes:ArrayList<Process>? = null
    open var DocumentUploadId:String? = null
    open var MessageQueueId:String? = null
    open var ReplyEmailHtml:String? = null
    open var NewEmailHtml:String? = null
}

open class Outlook365Properties
{
    open var PidTag:String? = null
    open var ItemId:String? = null
    open var EwsUrl:String? = null
    open var Token:String? = null
}

open class RegistrationValue
{
    open var Key:UUID? = null
    open var Value:String? = null
    open var ShadowValue:String? = null
}

open class Process
{
    open var ID:Int? = null
    open var Title:String? = null
    open var Description:String? = null
    open var Note:String? = null
    open var Coordinator:String? = null
    open var Urgent:Boolean? = null
    open var Transitions:ArrayList<Transition>? = null
}

open class Transition
{
    open var ID:UUID? = null
    open var Reason:String? = null
    open var DelayDate:Date? = null
    open var DelayReason:String? = null
    open var UserIDs:ArrayList<Int>? = null
    open var GroupIDs:ArrayList<Int>? = null
}

open class CorporateIdentityMail
{
    open var DocumentId:UUID? = null
    open var EmailHtml:String? = null
    open var IsRegistered:Boolean? = null
    open var DocumentNr:String? = null
    open var Values:ArrayList<RegistrationProfileFieldStateBase>? = null
    open var RegistrationProfileID:UUID? = null
    open var RegisterAutomatically:Boolean? = null
    open var RegistrationEmailadress:String? = null
}

open class RegistrationProfileFieldStateBase : FieldState()
{
    open var DocumentFieldID:UUID? = null
}

open class FieldState
{
    open var Required:Boolean? = null
    open var Visible:Boolean? = null
    open var Readonly:Boolean? = null
}

Kotlin FinalizeCorporateIdentityMail DTOs

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: test-dogw.klokgroep.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>
  <NewEmailHtml>String</NewEmailHtml>
  <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>
  <RegistrationEmailadress>String</RegistrationEmailadress>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldStateBase>
      <Readonly xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Readonly>
      <Required xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Required>
      <Visible xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Visible>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
    </d2p1:RegistrationProfileFieldStateBase>
  </Values>
</CorporateIdentityMail>