DigiOffice API Services Services

<back to all web services

CreateOrUpdateEmailDraft

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 CreateOrUpdateEmailDraft extends CreateDraftCorporateIdentityMail {
    /** @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) }
}

JavaScript CreateOrUpdateEmailDraft DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/CreateOrUpdateEmailDraft HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"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","NewEmailHtml":"String","PidTag":"String","ItemId":"String","EwsUrl":"String","Token":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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,"RegistrationEmailadress":"String"}