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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromProgCode: String,
	TakeOverEmailAddresses: False,
	ShippingFormID: 0,
	LinkedDocumentIDs: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0
}