DigiOffice Gateway Web Services

<back to all web services

AddDocumentByEmailMessageId

Requires Authentication 
"use strict";
export class MetaDataField {
    /** @param {{ID?:string,DocumentVeldID?:string,Name?:string,Label?:string,Datatype?:string,PrintLabel?:string,Entity?:string,PrintValue?:string,RegistrationValue?:string,SPSiteColumnName?:string,ShadowName?:string,ShadowDatatype?:string,ShadowSPSiteColumnName?:string,ShadowSPSiteColumnRegistrationValue?:string,ShadowRegistrationValue?:string,IsKeyField?:boolean,KopierenBijNieuweVersie?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ID;
    /** @type {?string} */
    DocumentVeldID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Label;
    /** @type {string} */
    Datatype;
    /** @type {string} */
    PrintLabel;
    /** @type {string} */
    Entity;
    /** @type {string} */
    PrintValue;
    /** @type {string} */
    RegistrationValue;
    /** @type {string} */
    SPSiteColumnName;
    /** @type {string} */
    ShadowName;
    /** @type {string} */
    ShadowDatatype;
    /** @type {string} */
    ShadowSPSiteColumnName;
    /** @type {string} */
    ShadowSPSiteColumnRegistrationValue;
    /** @type {string} */
    ShadowRegistrationValue;
    /** @type {boolean} */
    IsKeyField;
    /** @type {boolean} */
    KopierenBijNieuweVersie;
}
export class Bookmark {
    /** @param {{RemoveLastBreak?:boolean,ReplaceOnChange?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?boolean} */
    RemoveLastBreak;
    /** @type {boolean} */
    ReplaceOnChange;
}
export class Mailings {
    constructor(init) { Object.assign(this, init) }
}
export class AttachmentMailing {
    constructor(init) { Object.assign(this, init) }
}
export class DocumentResponse {
    /** @param {{DocumentID?:string,DocumentNr?:string,RootDocumentID?:string,MetaData?:MetaDataField[],Bookmarks?:Bookmark[],Mailings?:Mailings,AttachmentsMailings?:AttachmentMailing[],Messages?:IInformationMessages,SourceDocumentPath?:string,DestinationDocumentPath?:string,SharePointContentTypeName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentID;
    /** @type {string} */
    DocumentNr;
    /** @type {string} */
    RootDocumentID;
    /** @type {MetaDataField[]} */
    MetaData;
    /** @type {Bookmark[]} */
    Bookmarks;
    /** @type {Mailings} */
    Mailings;
    /** @type {AttachmentMailing[]} */
    AttachmentsMailings;
    /** @type {IInformationMessages} */
    Messages;
    /** @type {string} */
    SourceDocumentPath;
    /** @type {string} */
    DestinationDocumentPath;
    /** @type {string} */
    SharePointContentTypeName;
}
/** @typedef {'Off'|'AllowUserInteraction'|'DoNotAllowUserInteraction'} */
export var DocInfoSilentMode;
(function (DocInfoSilentMode) {
    DocInfoSilentMode["Off"] = "Off"
    DocInfoSilentMode["AllowUserInteraction"] = "AllowUserInteraction"
    DocInfoSilentMode["DoNotAllowUserInteraction"] = "DoNotAllowUserInteraction"
})(DocInfoSilentMode || (DocInfoSilentMode = {}));
export class AddDocument {
    /** @param {{RegistrationProfileID?:string,DocumentID?:string,RootDocumentID?:string,AssignToUserID?:number,AssignToGroupID?:number,MetaData?:MetaDataField[],Mailings?:Mailings,AttachmentsMailings?:AttachmentMailing[],FileID?:string,SilentMode?:DocInfoSilentMode,updateStorageSystem?:boolean,MessageQueueId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RegistrationProfileID;
    /** @type {?string} */
    DocumentID;
    /** @type {?string} */
    RootDocumentID;
    /** @type {?number} */
    AssignToUserID;
    /** @type {?number} */
    AssignToGroupID;
    /** @type {MetaDataField[]} */
    MetaData;
    /** @type {Mailings} */
    Mailings;
    /** @type {AttachmentMailing[]} */
    AttachmentsMailings;
    /** @type {?string} */
    FileID;
    /** @type {DocInfoSilentMode} */
    SilentMode;
    /** @type {boolean} */
    updateStorageSystem;
    /** @type {?number} */
    MessageQueueId;
}
export class AddDocumentByEmailMessageId {
    /** @param {{ItemId?:string,EwsUrl?:string,Token?:string,DocumentId?:string,documentToAdd?:AddDocument}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ItemId;
    /** @type {string} */
    EwsUrl;
    /** @type {string} */
    Token;
    /** @type {string} */
    DocumentId;
    /** @type {AddDocument} */
    documentToAdd;
}

JavaScript AddDocumentByEmailMessageId 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/AddDocumentByEmailMessageId HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ItemId":"String","EwsUrl":"String","Token":"String","DocumentId":"String","documentToAdd":{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}],"FileID":"00000000-0000-0000-0000-000000000000","SilentMode":"Off","updateStorageSystem":false,"MessageQueueId":0}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","DocumentNr":"String","RootDocumentID":"00000000-0000-0000-0000-000000000000","MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Bookmarks":[{"RemoveLastBreak":false,"ReplaceOnChange":false}],"Mailings":{},"AttachmentsMailings":[{}],"Messages":null,"SourceDocumentPath":"String","DestinationDocumentPath":"String","SharePointContentTypeName":"String"}