DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AddMessageQueueWithSendDocumentByEmail
    {
        public String FromProgCode = null;
        public UUID DocumentID = null;
        public Boolean TakeOverEmailAddresses = null;
        public Integer ShippingFormID = null;
        public ArrayList<String> LinkedDocumentIDs = null;
        
        public String getFromProgCode() { return FromProgCode; }
        public AddMessageQueueWithSendDocumentByEmail setFromProgCode(String value) { this.FromProgCode = value; return this; }
        public UUID getDocumentID() { return DocumentID; }
        public AddMessageQueueWithSendDocumentByEmail setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public Boolean isTakeOverEmailAddresses() { return TakeOverEmailAddresses; }
        public AddMessageQueueWithSendDocumentByEmail setTakeOverEmailAddresses(Boolean value) { this.TakeOverEmailAddresses = value; return this; }
        public Integer getShippingFormID() { return ShippingFormID; }
        public AddMessageQueueWithSendDocumentByEmail setShippingFormID(Integer value) { this.ShippingFormID = value; return this; }
        public ArrayList<String> getLinkedDocumentIDs() { return LinkedDocumentIDs; }
        public AddMessageQueueWithSendDocumentByEmail setLinkedDocumentIDs(ArrayList<String> value) { this.LinkedDocumentIDs = value; return this; }
    }

    public static class AddMessageQueueResonse
    {
        public Integer ID = null;
        
        public Integer getId() { return ID; }
        public AddMessageQueueResonse setId(Integer value) { this.ID = value; return this; }
    }

}

Java AddMessageQueueWithSendDocumentByEmail DTOs

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>