WebSphere brand IBM WebSphere Presence Server, Version 7.0

IBM® WebSphere® Presence Server REST interface

Presence Server exposes a representational state transfer (REST) interface for presence operations over HTTP, allowing for fetch and publish presence operations using a Web client.

The REST interface permits Web clients to perform HTTP GET, PUT, POST, and DELETE requests.

Using the REST interface it is possible for SIP clients and clients that use the REST interface to operate together, when all of the clients are connected to the same server. In particular, presence authorization rules are respected and applied both for fetch operations by HTTP clients and for information published by HTTP clients.

The Telecom Application Enablement Feature contains sample Web client code. For more information about the Web client sample and developing Web clients for use with the REST interface, refer to the IBM WebSphere Telecom Application Enablement Feature information center.

Fetch interface component

To fetch presence information about a resource, the client sends an HTTP GET request. The HTTP address consists of the server address, the presence prefix, and the presentity URI, for example, the email address.

An example of an address is http://ps.example.com/presence/user@example.com. The presence prefix is configurable, and can be changed by the administrator by changing the context root of the Presence Servlet in the application.xml file.

The HTTP response to a GET request adheres to the following characteristics:
  • When successful the body of the response:
    • returns as a pidf document in a case of get request on single user
    • returns as a multipart related rlmi document if a list is requested
  • When unsuccessful the body of the response:
    • returns as empty in a case of get request on single user, if the user information is not found.
    • returns the response code 404 document not found if a requested list is not found.

Publish interface component

Presence Server allows Web clients to create, modify, and delete their presence information using HTTP POST, PUT and DELETE operations. The HTTP address for these operations is the same as in the fetch operation, that is, the presence prefix and the presentity URI, for example, http://ps.example.com/presence/user@example.com




Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.