/
REST/MVC Categories Controller

REST/MVC Categories Controller


REST/MVC Path for Category definition
HTTP MethodPathDescriptionController Method
/rest/categories/{categoryKey}Retrieves category by category keygetCategory(categoryKey: String)
Parameters:
  • categoryKey: Category primary key  (Path parameter)

/rest/categories/Adds a new category

addCategory(category: CategoryDTO)

Parameters:
  • category: Category json (Multipart Body)
  • image: Category image  (Multipart Body)
/rest/categories/{categoryKey}Updates an existent categoryupdateCategory(category: CategoryDTO, categoryKey : String)
Parameters:
  • category: Category json (Multipart Body)
  • image: Category image  (Multipart Body)
  • categoryKey: Category primary key  (Path parameter)

(estrella) Defined as POST instead of PUT due incompatibilities between PUT / Multipart

/rest/categories/{categoryKey}Removes an existent categoryremoveCategory(categoryKey: String)
Parameters:
  • categoryKey: Category primary key  (Path parameter)
/rest/categories/{categoryKey}/changeVisibilityChanges category visibilitychangeVisibility(key: String, visible: boolean)
Parameters:
  • categoryKey: Category primary key (Path parameter)
  • visible: Indicates if category must be visible or not (Body param)
/rest/categories/{categoryKey}/productsSet associated products for a categoryupdateCategoryProducts(categoryKey : String, productKeys : String)
Parameters:
  • categoryKey: Category primary key (Path parameter)
  • productKeys: Lists of associated products of a category (Body param)
/rest/categories/Search for categories by criteria

findCategoriesByCriteria(criteria : CategoryCriteria)

Parameters:
  • criteria: Criteria filter json (Body parameter)



Related content

Avvale 2024