ProfileImage
ProfileImage Service
Core API endpoint for retrieving and managing profile images.
Create Temporary Image
POST /profileImages/temporary/{filename}Cause the specified temporary image to be cropped based on the specified characteristics.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| filename | String | true | the filename of the temporary image to be cropped |
Form Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| x | Integer | false | the x coordinate (in pixels) of the upper left corner of the area to be cropped |
| y | Integer | false | the y coordinate (in pixels) of the upper left corner of the area to be cropped |
| width | Integer | false | the width (in pixels) of the area to be cropped |
| height | Integer | false | the height (in pixels) of the area to be cropped |
Takes:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 201 (Created) | Request was successful |
| 404 (Not Found) | The specified temporary image cannot be found |
Get Temporary Image
GET /profileImages/temporary/{filename}Return the binary content of the specified temporary image.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| filename | String | true | the filename of the temporary image to be retrieved |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | The specified temporary image cannot be found |
Upload New Temporary Image
POST /profileImages/temporaryUpload a profile image and store it temporarily. Return a 201 (Created) status with a
Location header containing the URI of the newly created image.
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 201 (Created) | Request was successful |