Class CategoryImagesApiV2Controller
Class CategoryImagesApiV2Controller
This controller handles the Category Image file operations. The clients of the API can list, upload, rename or delete
files that exist in the server.
-
AbstractApiV2Controller
-
HttpApiV2Controller
-
AbstractImagesApiV2Controller
-
CategoryImagesApiV2Controller
Methods summary
protected
|
#
__initialize( )
Initializes API Controller
Initializes API Controller
|
protected
string
|
#
_getImageFolderName( )
Returns the absolute path where the image files are located.
Returns the absolute path where the image files are located.
Returns
string
Image folder name.
|
public
|
#
post( )
Api
{post} /category_images Upload Category Image
Apidescription
Uploads an icon image for the categories. Make this request without the "Content-Type: application/json". Except
from the file the POST request must also contain a "filename" value with the final file name.
Apierror
400-BadRequest No image file was provided or the "filename" parameter was not provided.
Apierrorexample
Error-Response (Missing image file)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "No image file was provided."
}
Error-Response (Missing filename parameter)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "The 'filename' parameter is required and was not provided with the request."
}
Apigroup
Categories
Apiname
UploadCategoryImage
Apisuccess
(Success 201) Response-Body Contains information about the uploaded file.
Apisuccessexample
{json} Success-Response
{
"code": 201,
"status": "success",
"action": "upload",
"filename": "my-image-file.png"
}
Apiversion
2.1.0
|
public
|
#
put( )
Api
{put} /category_images Rename Image File
Apidescription
Use this method to rename an existing image file.
Apierror
400-BadRequest The body of the request was empty or the request body did not contain the
oldFilename or newFilename properties, or their values were invalid.
Apierrorexample
Error-Response (Empty request body)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Category image data were not provided."
}
Error-Response (Missing parameters)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "This operation requires a JSON object with 'oldFilename' and 'newFilename' properties set."
}
Apiexample
{json} Request-Body
{
"oldFilename": "my-old-image.png",
"newFilename": "my-new-image.png"
}
Apigroup
Categories
Apiname
RenameImageFile
Apisuccess
Response-Body Contains information about the executed operation.
Apisuccessexample
{json} Response-Body
{
"code": 200,
"status": "success",
"action": "rename",
"oldFilename": "my-old-image.png",
"newFilename": "my-new-image.png"
}
Apiversion
2.1.0
|
public
|
#
delete( )
Api
{delete} /category_images Delete Category Image
Apidescription
Removes the category image file from the server. This method will always provide a successful response even if
the image file was not found.
Apierror
400-BadRequest The body of the request was empty or the request body did not contain the
filename or its value was invalid.
Apierrorexample
Error-Response (Empty request body)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Category image data were not provided."
}
Error-Response (Missing parameter)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "This operation requires a JSON object with 'filename' properties set."
}
Apiexample
{json} Request-Body
{
"filename": "file-to-be-deleted.png"
}
Apigroup
Categories
Apiname
DeleteCategoryImage
Apisuccessexample
{json} Success-Response
{
"code": 200,
"status": "success",
"action": "delete",
"filename": "file-to-be-deleted.png"
}
Apiversion
2.1.0
|
public
|
#
get( )
Api
{get} /category_images Get Category Images
Apidescription
Get a list of all category image files which exists in the server's filesystem through a GET request.
Apiexample
{curl} Get All Category Images
curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/category_images
Apigroup
Categories
Apiname
GetCategoryImages
Apiversion
2.1.0
Overrides
|