DigiOffice Gateway Web Services

<back to all web services

CreateOrUpdateEmailDraft

Requires Authentication

export class Outlook365Properties
{
    public PidTag: string;
    public ItemId: string;
    public EwsUrl: string;
    public Token: string;

    public constructor(init?: Partial<Outlook365Properties>) { (Object as any).assign(this, init); }
}

export class FieldState
{
    public Required: boolean;
    public Visible: boolean;
    public Readonly: boolean;

    public constructor(init?: Partial<FieldState>) { (Object as any).assign(this, init); }
}

export class RegistrationProfileFieldStateBase extends FieldState
{
    public DocumentFieldID: string;

    public constructor(init?: Partial<RegistrationProfileFieldStateBase>) { super(init); (Object as any).assign(this, init); }
}

export class CorporateIdentityMail
{
    public DocumentId: string;
    public EmailHtml: string;
    public IsRegistered: boolean;
    public DocumentNr: string;
    public Values: RegistrationProfileFieldStateBase[];
    public RegistrationProfileID: string;
    public RegisterAutomatically: boolean;

    public constructor(init?: Partial<CorporateIdentityMail>) { (Object as any).assign(this, init); }
}

export class RegistrationValue
{
    public Key: string;
    public Value: string;
    public ShadowValue: string;

    public constructor(init?: Partial<RegistrationValue>) { (Object as any).assign(this, init); }
}

export class Transition
{
    public ID: string;
    public Reason: string;
    public DelayDate?: string;
    public DelayReason: string;
    public UserIDs: number[];
    public GroupIDs: number[];

    public constructor(init?: Partial<Transition>) { (Object as any).assign(this, init); }
}

export class Process
{
    public ID: number;
    public Title: string;
    public Description: string;
    public Note: string;
    public Coordinator: string;
    public Urgent: boolean;
    public Transitions: Transition[];

    public constructor(init?: Partial<Process>) { (Object as any).assign(this, init); }
}

export class CreateDraftCorporateIdentityMail extends Outlook365Properties
{
    public RegistrationProfileID: string;
    public Values: RegistrationValue[];
    public Processes: Process[];
    public DocumentUploadId: string;
    public MessageQueueId: string;
    public ReplyEmailHtml: string;

    public constructor(init?: Partial<CreateDraftCorporateIdentityMail>) { super(init); (Object as any).assign(this, init); }
}

export class CreateOrUpdateEmailDraft extends CreateDraftCorporateIdentityMail
{

    public constructor(init?: Partial<CreateOrUpdateEmailDraft>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CreateOrUpdateEmailDraft 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/CreateOrUpdateEmailDraft HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateOrUpdateEmailDraft 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>
</CreateOrUpdateEmailDraft>
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>
      <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>