DigiOffice Gateway Web Services

<back to all web services

AddMessageQueue

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue
AddMessageQueue Parameters:
NameParameterData TypeRequiredDescription
FromProgCodebodystringNo
ToProgCodebodystringNo
XmlbodystringNo
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 HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddMessageQueue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Messaging.Operations">
  <FromProgCode>String</FromProgCode>
  <ToProgCode>String</ToProgCode>
  <Xml>String</Xml>
</AddMessageQueue>

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>