cwaResponses Element

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Holds the synchronous response to an HTTP POST request carried over through a command channel. It is used to inform the client of the initial status of a request.

Syntax

<cwaResponses requestProcessed="integer value" unexpectedElement="integer value"/>

Attributes

Attribute	Data Type	Description
requestProcessed	integer	The number of requests that were processed.
unexpectedElement	integer	The number of unexpected elements received in the method request.

Element Information

Child Elements

Element	Occurrences	Description
error	1 or more	Indicates the nature of an error resulting in an invalid request
requestAccepted	1 or more	Indicates the Communicator Web Access server has accepted a request for processing.
initiateImSessionAccepted	1 or more	Indicates that a request to initiate an IM session has been accepted.
signInData	0 or 1	Element contains sign in data such as a user's telephone numbers when response is associated with a logon request.
Uri	0 or 1	Uri of the local user who has logged on. This element is present when the response is associated with a logon request.

Remarks

This synchronous response can contain the following type of information indicating the status of a specified request as identified by the request ID, rid.

requestAccepted - This status indicates the request is formatted correctly and the server is performing the requested operation or operations asynchronously. Any outcome of the operations is put in the event queue for the client to retrieve as events in separated HTTP GET requests at a later time. An individual HTTP GET request on the data channel returns all events not previously sent by the Communicator Web Access server on the data channel.
requestRejected - This status indicates either the request is formatted incorrectly or there is immediate session or other error that has prevented the request being processed further. In this case, the Communicator Web Access server stops the request immediately. This status message comes with further explanations of the exceptions.

Examples

The following is an example of a synchronous response to an HTTP request from a command channel. It contains the status reports for two requests as identified by the two rid values. The first request was accepted to be executed on Communicator Web Access server while the second was not accepted due to the inclusion of an invalid element.

<cwaResponses sid="2" requestProcessed="1" unexpectedElement="1">
   <requestAccepted rid="4" />
   <error>
      <sipError code=""/>
      <exception>Unexpected element...</exception>
      <stackTrace>...</stackTrace>
   </error>
</cwaResponses>

Share via