Resource reference#
An overview of what the API offers, by module.
The address#
Module and resource are written in lowercase with hyphens: product-set,
get-all, update-columns.
Modules#
| Module | Domain | Resources |
|---|---|---|
| Base | comments, ratings, polls, newsletter, ads | 10 |
| Bazaar | classifieds | 13 |
| Blog | articles, news, events | 13 |
| Comcat | company catalogue | 12 |
| Company | my business, bookings, jobs — administrators only | 15 |
| Discussion | forum | 6 |
| Eshop | goods and orders | 31 |
| Invoicer | invoicing | 10 |
| Store | warehouse — read-only | 10 |
| System | users, payments, settings | 43 |
Markers used in the reference#
| Marker | Meaning |
|---|---|
| tree | the resource has extra tree actions |
| event | the resource has register-event |
| public | reading works without signing in |
| owner | writing is tied to record ownership |
| ⛔ | unreachable from outside |
A list of resources is not a list of available operations
Many operations have no HTTP wrapper and return 404 even though the resource exists. See the CRUD pattern.