Home

 

Retrieving the Profiles service document

The first step perform if you plan to update resources made available through the Atom APIs is to retrieve the service document for the feature.

The Profiles feature provides a service document for each person with a profile. The service document defines a single workspace containing one collection. The collection address provides a reference to the feed of the user's profile. It also defines the profile fields that can be updated with the snx:editableFields element.


Atom API request details

Method Resource URI Description
GET Service Document /atom/profileService.do Retrieves the Profiles service document for the user whose credentials are used to authenticate the request. Tip: Use this URI to discover the name and other profile information of the currently authenticated user.
GET Service Document /atom/profileService.do?userid={snx:userid} Retrieves the Profiles service document for the user specified by the user ID.
GET Service Document /atom/profileService.do?email={emailaddress} Retrieves the Profiles service document for the user specified by the e-mail address.

Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40. Do not use this email parameter option if Lotus Connections is configured to prevent e-mail addresses from being displayed.

 

Example

To retrieve the service document for the Profiles feature, send the following HTTP request:

The HTTP response would look as follows:

The service document for Profiles is returned by the server. For example:


Profiles API

 

Related tasks

Authenticating requests


+

Search Tips   |   Advanced Search