...
The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).
API Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response |
|---|---|---|---|---|---|---|---|
| POST | n | create | users::create | /users | Insert a new user entry. | users_create.json | |
| GET | y | read | users::read | /users/{id} | Returns a user details. | users_read.json | |
| PATCH | y | update | users::update | /users/{id} | Update an attribute of a user entry. | users_update.json | |
| DELETE | y | delete | users::delete | /users/{id} | Delete a user entry. | users_delete.json | |
| GET | n | collection | users::read | /users | Returns a list of users. | users_collection.json |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | users::create | /users/create | Displays a standard web form for submission to POST /users. |
| GET | y | update | update_form | users::update | /users/{id}/update | Show the user details with the option to update attributes using PATCH to /users/{id} |