Endpoints Specifications

Type	Endpoint	Description	Auth	Function	Parameters	Return Type
GET	/categories/all	Retrieves all categories from the database.	API Key	GetCategories	none	Category[]
GET	/categories/get/:id	Retrieves the category from the database with the given ID.	API Key	GetCategory	Category ID
Type: Integer	Category
GET	/categories/subcategories/all	Retrieves all sub-categories from the database.	API Key	GetSubCategories	none	SubCategory[]
GET	/categories/subcategories/get/:id	Retrieves the sub-category from the database with the given ID.	API Key	GetSubCategory	Subcategory ID
Type: Integer	SubCategory
GET	/categories/subcategories/category/:id	Retrieves all sub-categories from the database by category.	API Key	GetSubCategoriesByCategory	Category ID
Type: Integer	SubCategory[]

Endpoints Return Data Specifications

GET /categories/all

GET /categories/get/:id

GET /categories/subcategories/all

GET /categories/subcategories/get/:id

GET /categories/subcategories/category/:id

Error Schema

Client Code Helpers

This section providers some helpers for designing the client-side code to consume the Categories service from the Plamatio backend REST API.

Endpoints Text Summary

Can use this as a prompt for a code-completion AI model.

GET
/categories/all
Retrieves all categories from the database.

GET
/categories/get/:id
Retrieves the category from the database with the given ID.

GET
/categories/subcategories/all
Retrieves all sub-categories from the database.

GET
/categories/subcategories/get/:id
Retrieves the sub-category from the database with the given ID.

GET
/categories/subcategories/category/:id
Retrieves all sub-categories from the database by category

Endpoint Definitions

Endpoint definitions to store Categories service endpoints in a central location.