DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
"use strict";
export class AddMessageQueueResonse {
    /** @param {{ID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
}
export class AddMessageQueueWithSendDocumentByEmail {
    /** @param {{FromProgCode?:string,DocumentID?:string,TakeOverEmailAddresses?:boolean,ShippingFormID?:number,LinkedDocumentIDs?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FromProgCode;
    /** @type {string} */
    DocumentID;
    /** @type {boolean} */
    TakeOverEmailAddresses;
    /** @type {number} */
    ShippingFormID;
    /** @type {string[]} */
    LinkedDocumentIDs;
}

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

{"FromProgCode":"String","DocumentID":"00000000-0000-0000-0000-000000000000","TakeOverEmailAddresses":false,"ShippingFormID":0,"LinkedDocumentIDs":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":0}