To retrieve a profile entry, send a GET request to the appropriate resource of the Administration API.
Table 1. Atom API request details
You must provide one of the following parameters as part of the request:
Table 2. Input parameters
|email||Internet email address of the user whose profile you want to retrieve. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40.|
Note: Do not use this parameter if Connections is configured to prevent email addresses from being displayed. It will return an error code 400 for an invalid request. Use the key or userid parameters instead.
This parameter is ignored if the userid parameter is also specified.
|userid||Unique ID that represents a specific person. This value is specified in the <snx:userid> element. |
Atom entry document representing the profile. Only the fields in the profile which contain data will be included in the returned entry. For example, if no fax number is specified for the user profile, the element representing the fax field is not returned.
Returned HTTP headers
HTTP/1.1 200 OK
Indicates that the profile entry was successfully returned. If an error occurs, this header contains one of the error codes.Errors
Parent topic: Working with profiles using the Administration API
- HTTP/1.1 400 Bad Request
- HTTP/1.1 403 Unauthorized
- HTTP/1.1 200 Not Found