DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
namespace IDB.API.DTO.Messaging

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AddMessageQueueResonse() = 
        member val ID:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type AddMessageQueueWithSendDocumentByEmail() = 
        member val FromProgCode:String = null with get,set
        member val DocumentID:Guid = new Guid() with get,set
        member val TakeOverEmailAddresses:Boolean = new Boolean() with get,set
        member val ShippingFormID:Int32 = new Int32() with get,set
        member val LinkedDocumentIDs:ResizeArray<String> = new ResizeArray<String>() with get,set

F# 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
}