pp108 : requestMessage

requestMessage

This API sends a message to a destination and waits on the inbound destination for a response.

SOAP request

Example request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP:Body>
    <requestMessage xmlns="http://schemas.cordys.com/1.0/jms">
      <destination>MyDestinationManager.MyDestination</destination>
      <message>Test message</message>
    </requestMessage>
  </SOAP:Body>
</SOAP:Envelope>

Request parameters

Parameter Description Mandatory Accepted input values
destination Destination identifier to which the message is sent Y  
reply2destination Destination identifier to which the recipient replies Y The request message must have reply2destination. This API follows the request-reply mechanism.
persistentdelivery Attribute on the API node N The default value is false.
expiration Attribute on the API node N

The default is no expiration.

Note: The message expiration is in milliseconds.

jmstype JMS type to be used N  
properties Properties for this message N  
messageformat Contains base64 (if the message node content is Base64 encoded) or the name of one of the configured BTC protocol names. N If not set or empty, the message is sent as plain text.
message

Message to send

Y If the binary transformation is configured, the message is expected as XML. Otherwise, you can have the following situations:
  • The message node contains plain text, and the message is sent as is.
  • The message node contains XML, and the XML is converted to string and sent as plain text.
responsemessageformat Determines how the response message is converted to the SOAP response XML N
  • The message format of the response can be base64, xmlMessage, or one of the configured BTC protocol names.
  • If not set, the message is returned as plain text.

SOAP response

No response is returned by this API.