Article categories
This page provides a description of the available API routes for managing article category.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing article category.
Last updated
Was this helpful?
Each product or service within the PORTOS system is linked to a specific category (e.g. desserts, soups, meals, ...), which is referred to as the article category. This categorization helps in organizing and classifying items, allowing for efficient management and navigation within the system.
Article category is represented by class.
GET
http://{server-address}/articlecategories
Returns all article categories that matches query parameters. Result is of type .
color
string
Supports NData syntax.
courseNumber
int
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
label
string
Supports NData syn
Authorization*
string
Authorization header with authorization token.
GET
http://{server-address}/articlecategories/{label}
label*
string
Unique article category label.
Authorization*
string
Authorization header with authorization token.
POST
http://{server-address}/articlecategories
Required rights
Authorization*
string
Authorization header with authorization token.
(body)*
ArticleCategory
Model to create.
PUT
http://{server-address}/articlecategories/{label}
Required rights
label*
string
Unique article category label.
Authorization*
string
Authorization header with authorization token.
(body)*
ArticleCategory
Model to create or update.
DELETE
http://{server-address}/articlecategories/{label}
Required rights
label*
string
Unique article category label.
Authorization*
string
Authorization header with authorization token.
Result is of type .
Creates new article category. Result is of type .
Authorized user must have ArticleCategoryCreate
assigned.
Creates new or updates existing article category. Result is of type .
Authorized user must have assigned ArticleCategoryCreate
or ArticleCategoryUpdate
.
Authorized user must have ArticleCategoryDelete
assigned.