ποΈModifiers
This page provides a description of the available API routes for managing modifiers.
The data model for modifier is represented by Modifier
class.
API methods
Get modifiers
GET
http://{server-address}/modifiers
Returns all modifiers that matches query parameters. Result is of type QueryResult<Modifier>
.
Query Parameters
Id
string
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.
Name
string
Supports NData syntax.
Headers
Authorization*
string
Authorization header with authorization token.
Get modifier by ID
GET
http://{server-address}/modifiers/{id}
Result is of type Modifier
.
Path Parameters
id*
string
Unique modifier identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Create modifier
POST
http://{server-address}/modifiers
Creates new modifier. Result is of type Modifier
.
Required rights
Authorized user must have ModifierCreate
right assigned.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(body)*
Modifier
Model to create
Create or update modifier
PUT
http://{server-address}/modifiers/{id}
Updates existing or creates new modifier. Result is of type Modifier
.
Required rights
Authorized user must have assigned ModifierCreate
or ModifierUpdate
right.
Path Parameters
id*
string
Unique modifier identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(body)*
Modifier
Modifier model to create or update.
Delete modifier by ID
DELETE
http://{server-address}/modifiers/{id}
Required rights
Authorized user must have ModifierDelete
right assigned.
Path Parameters
id*
string
Unique modifier identifier.
Headers
Authorization*
string
Authorization header with authorization token.
Last updated