User resource
Get user avatar
Get user avatar
OVERVIEW
This API method is supported from Collaborate 4.1.4 and above
This is an API method to get the user avatar.
Method : GET
URL : /users/{id}/avatar
id parameter is the User id of the user, whose avatar is to be obtained.
Parameters
| Name | Value | Description |
|---|---|---|
| size | numeric |
The API supports avatar of the following sizes. 16,32,48,64,96,128,256,512 |
Response
The API response is a multipart stream of data. If the avatar has not been uploaded then a place holder default system avatar is returned. In the case of an error, an error object is returned with the appropriate error message.
Error codes
| Code | Meaning |
|---|---|
| 200 | Avatar was returned successfully |
| 400 | Problem with parsing XML or JSON object (Bad Request) |
| 401 | Unauthorized |
| 403 | Validation failed/ Forbidden |
| 404 | Avatar does not exist in the system |
| 405 | Method not allowed (calling API with the wrong method) |
| 500 | Internal error occurred |
Last Updated: Nov 08,2024
Thank you
Your review has been submitted.
Comments
0 Comments