DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail

export class AddMessageQueueResonse
{
    public ID?: number;

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

export class AddMessageQueueWithSendDocumentByEmail
{
    public FromProgCode?: string;
    public DocumentID?: string;
    public TakeOverEmailAddresses?: boolean;
    public ShippingFormID?: number;
    public LinkedDocumentIDs?: string[];

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

TypeScript AddMessageQueueWithSendDocumentByEmail DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"ID":0}