Web Services API | User web services | Add Image to User
Modified on: Thu, 13 Apr 2023 4:30 PMAdd an image to an user.
- Url: /integration/ws/management/rest/users/<id_or_externalId_or_commonId_or_username>/image
- Method: POST
-
Headers:
- Accept: version/format header
- X-Cloud-Auth-Token*: authorization header
- X-Cloud-Synchronization: synchronization header
- Content-Type*: application/json
-
Parameters:
-
image*:
- base64Image * : image_data, as a base64 encoded string
- mimeType * : image mimeType
-
image*:
-
Responses:
-
200: OK. Content:
- status: generic status
- location: generic location of the resultant resource, if any
- message: generic success or error message, if any
-
responsePlatforms: response for every platform it concerns. Each one with the content:
- status: status in the platform
- location: location of the resultant resource in the platform, if any
- message: success or error message in the platform, if any
-
200: OK. Content:
- Url example by user id: http://netex.dev.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015572136a250012/image
- Url example by username: http://netex.dev.learningcloud.me/integration/ws/management/rest/users/restuser.netex/image
- Response example (synchronous):
{ "location": null, "message": "", "responsePlatforms": { "training": { "location": null, "message": null, "status": 200 }, "social": { "location": null, "message": null, "status": 204 }, "play": { "location": null, "message": null, "status": 204 }, "management": { "location": null, "message": null, "status": 204 } }, "status": 204 }
Response example (asynchronous):
{ "location": null, "message": "", "responsePlatforms": { "training": { "location": null, "message": null, "status": 202 }, "social": { "location": null, "message": null, "status": 202 }, "play": { "location": null, "message": null, "status": 204 }, "management": { "location": null, "message": null, "status": 204 } }, "status": 204 }