Commit f1b8c8d2 authored by Nigel Kukard's avatar Nigel Kukard
Browse files

Added HTTP 1.1 method descriptions

parent 842425b6
# AWIT JSON Format Standard
This is best illustrated by example...
# HTTP Methods
Make sure during implementation you read [RFC7231](https://tools.ietf.org/html/rfc7231).
## POST
Create a record.
### Return Codes
* 201 (Created)
* 'Location' header with link to /record/{id} containing new resource ID.
* 404 (Not Found)
* 409 (Conflict)
* If resource already exists.
## GET
Retrieve a record.
* 200 (OK)
* List of records. Use pagination, sorting and filtering to navigate big lists.
* 200 (OK)
* Single record.
* 404 (Not Found)
* If ID not found or invalid.
## PUT
Replace a record.
* 404 (Not Found)
* WIP: Unless you want to update/replace every resource in the entire collection.
* 200 (OK)
* 204 (No Content)
* 404 (Not Found)
* If ID not found or invalid.
## PATCH
Modify a record.
* 404 (Not Found)
* WIP: Unless you want to modify the collection itself.
* 200 (OK)
* 204 (No Content)
* 404 (Not Found)
* If ID not found or invalid.
## DELETE
Delete a record.
* 404 (Not Found)
* Unless you want to delete the whole collection, not often desirable.
* 200 (OK)
* 404 (Not Found)
* If ID not found or invalid.
# Format
## The 'status' field
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment