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:
NameTypeRequiredDescription
filenameStringtruethe filename of the temporary image to be cropped
Form Parameters:
NameTypeRequiredDescription
xIntegerfalsethe x coordinate (in pixels) of the upper left corner of the area to be cropped
yIntegerfalsethe y coordinate (in pixels) of the upper left corner of the area to be cropped
widthIntegerfalsethe width (in pixels) of the area to be cropped
heightIntegerfalsethe height (in pixels) of the area to be cropped
Takes:
  • the x coordinate (in pixels) of the upper left corner of the area to be cropped
  • the y coordinate (in pixels) of the upper left corner of the area to be cropped
  • the width (in pixels) of the area to be cropped
  • the height (in pixels) of the area to be cropped
    • Return Status:
    HTTP Status CodeDescription
    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:
    NameTypeRequiredDescription
    filenameStringtruethe filename of the temporary image to be retrieved
    Retrieves:
  • Binary content of the specified temporary image
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    404 (Not Found)The specified temporary image cannot be found

    Upload New Temporary Image

    POST /profileImages/temporary

    Upload 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:
  • a multipart body that contains the profile image
    • Retrieves:
  • ProfileImage
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful