DigiOffice Gateway Web Services

<back to all web services

FinalizeCorporateIdentityMail

Requires Authentication
"use strict";
export class Outlook365Properties {
    /** @param {{PidTag?:string,ItemId?:string,EwsUrl?:string,Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PidTag;
    /** @type {string} */
    ItemId;
    /** @type {string} */
    EwsUrl;
    /** @type {string} */
    Token;
}
export class FieldState {
    /** @param {{Required?:boolean,Visible?:boolean,Readonly?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Required;
    /** @type {boolean} */
    Visible;
    /** @type {boolean} */
    Readonly;
}
export class RegistrationProfileFieldStateBase extends FieldState {
    /** @param {{DocumentFieldID?:string,Required?:boolean,Visible?:boolean,Readonly?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
}
export class CorporateIdentityMail {
    /** @param {{DocumentId?:string,EmailHtml?:string,IsRegistered?:boolean,DocumentNr?:string,Values?:RegistrationProfileFieldStateBase[],RegistrationProfileID?:string,RegisterAutomatically?:boolean,RegistrationEmailadress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentId;
    /** @type {string} */
    EmailHtml;
    /** @type {boolean} */
    IsRegistered;
    /** @type {string} */
    DocumentNr;
    /** @type {RegistrationProfileFieldStateBase[]} */
    Values;
    /** @type {string} */
    RegistrationProfileID;
    /** @type {boolean} */
    RegisterAutomatically;
    /** @type {string} */
    RegistrationEmailadress;
}
export class RegistrationValue {
    /** @param {{Key?:string,Value?:string,ShadowValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
}
export class Transition {
    /** @param {{ID?:string,Reason?:string,DelayDate?:string,DelayReason?:string,UserIDs?:number[],GroupIDs?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Reason;
    /** @type {?string} */
    DelayDate;
    /** @type {string} */
    DelayReason;
    /** @type {number[]} */
    UserIDs;
    /** @type {number[]} */
    GroupIDs;
}
export class Process {
    /** @param {{ID?:number,Title?:string,Description?:string,Note?:string,Coordinator?:string,Urgent?:boolean,Transitions?:Transition[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    Note;
    /** @type {string} */
    Coordinator;
    /** @type {boolean} */
    Urgent;
    /** @type {Transition[]} */
    Transitions;
}
export class CreateDraftCorporateIdentityMail extends Outlook365Properties {
    /** @param {{RegistrationProfileID?:string,Values?:RegistrationValue[],Processes?:Process[],DocumentUploadId?:string,MessageQueueId?:string,ReplyEmailHtml?:string,NewEmailHtml?:string,PidTag?:string,ItemId?:string,EwsUrl?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RegistrationProfileID;
    /** @type {RegistrationValue[]} */
    Values;
    /** @type {Process[]} */
    Processes;
    /** @type {string} */
    DocumentUploadId;
    /** @type {string} */
    MessageQueueId;
    /** @type {string} */
    ReplyEmailHtml;
    /** @type {string} */
    NewEmailHtml;
}
export class UpdateDraftCorporateIdentityMail extends CreateDraftCorporateIdentityMail {
    /** @param {{EmailHtml?:string,RegistrationProfileID?:string,Values?:RegistrationValue[],Processes?:Process[],DocumentUploadId?:string,MessageQueueId?:string,ReplyEmailHtml?:string,NewEmailHtml?:string,PidTag?:string,ItemId?:string,EwsUrl?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    EmailHtml;
}
export class FinalizeCorporateIdentityMail extends UpdateDraftCorporateIdentityMail {
    /** @param {{ModifiedFieldValues?:RegistrationValue[],EmailMessageHash?:string,EmailHtml?:string,RegistrationProfileID?:string,Values?:RegistrationValue[],Processes?:Process[],DocumentUploadId?:string,MessageQueueId?:string,ReplyEmailHtml?:string,NewEmailHtml?:string,PidTag?:string,ItemId?:string,EwsUrl?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {RegistrationValue[]} */
    ModifiedFieldValues;
    /** @type {string} */
    EmailMessageHash;
}

JavaScript 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>