Avatar
Use this resource to retrieve an avatar corresponding to the avatarId parameter or a default avatar, if the avatarId parameter is not found or not provided.
Method summary
| HTTP Method | Path | Description |
|---|---|---|
| GET | /scr/api/Avatar | Retrieves an avatar corresponding to the avatarId parameter or a default avatar, if the avatarId parameter is not found or not provided. |
GET /scr/api/Avatar
- Description
- Use this method to retrieve an avatar corresponding to the avatarId parameter or a default avatar, if the avatarId parameter is not found or not provided.
- Resource information
-
Requirements Description Response format Image data Requires authentication Yes Supports OAuth 2 client credentials Yes using a User Service ID containing User Management Category Rate limited Not yet
- Parameters
-
Name Location Description Required Type avatarId Query The ID of the avatar to download. A default avatar image is returned in the following cases:- When the avatarId is not provided
- When an avatarId is provided, but an avatar matching the ID is not found
No String location Query Indicates the location where the image is displayed in IBM Blueworks Live. Each location returns an avatar in a different image size. If the location value is not provided, then the image is returned in the default size of 85 x 85 pixels. The possible values include: chat(20 x 20 pixels)comments(30 x 30 pixels)news(40 x 40 pixels)settings(85 x 85 pixels)
No String
- Response
-
- Example input
-
- Using OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/Avatar?avatarId=a0777"
- Using OAuth 2 client
credentials:
- Example output
- Image data for the avatar.
- Response properties
- None
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
401 The user isn't authorized to make the request.