DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
AddMessageQueueWithSendDocumentByEmail Parameters:
NameParameterData TypeRequiredDescription
FromProgCodebodystringNo
DocumentIDbodyGuidNo
TakeOverEmailAddressesbodyboolNo
ShippingFormIDbodyintNo
LinkedDocumentIDsbodyList<string>No
AddMessageQueueResonse Parameters:
NameParameterData TypeRequiredDescription
IDformintNo

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<AddMessageQueueWithSendDocumentByEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Messaging.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <FromProgCode>String</FromProgCode>
  <LinkedDocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkedDocumentIDs>
  <ShippingFormID>0</ShippingFormID>
  <TakeOverEmailAddresses>false</TakeOverEmailAddresses>
</AddMessageQueueWithSendDocumentByEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddMessageQueueResonse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Messaging">
  <ID>0</ID>
</AddMessageQueueResonse>