...
This helps to reduce the potential for path conflicts in the system.
Endpoints
| Method | Sub Path | Purpose | Expectations |
|---|---|---|---|
| POST | / | Create a new record | If the new record is created, the server must respond with a 200 status code and a JSON representation of the record If the new record cannot be created, and the client can possible correct for that, then the server should respond with a 422 status code and standard validation error response (see another section, TBD) |
| GET | / | Fetch a (sub)set of records | |
| GET | /{id} | Fetch an individual record | If the record exists, the server must respond with a 200 status code and a JSON representation of the record If the record does not exist, the server must respond with a 404 status code |
| PUT | /{id} | Create or replace an individual record | |
| DELETE | /{id} | Delete an individual record |
References
The use of must, should, may etc is based upon RFC2119