GET api/clients/{clientId}/streamedProfileImage?width={width}&height={height}&preserveAspectRatio={preserveAspectRatio}
Gets the profile image of the provided client.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
parameter to pass the client id. |
integer |
Required |
| width |
optional parameter; the width in pixels for the requested image. |
integer |
None. |
| height |
optional parameter; the height in pixels for the requested image. |
integer |
None. |
| preserveAspectRatio |
optional parameter; set it to TRUE to keep the aspect ratio of the image (will prevent distortion; this will take the smaller of the provided dimensions and will calculate the other appropriately). |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
An Http response message with the folliwing status codes: 200 = success (includes the profile image found), 400 = bad request (the request is malformed or with invalid data), 404 = not found (this is returned when there is no profile image or the client does not exists) 500 = something went wrong (the request was not processed).
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |