adapted routes for hal conform api

- [x] new route for api
- [x] gather feedback for my changes
- [x] submit changes to the documentation

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tests pass?   | yes
| Fixed tickets | none
| Doc           | [url to doc|none]