- POST - signup
- input: {username, password, email}
- output:
- success: 201 Created (with cookie)
- fail: 409 Conflict, 400 Bad Request
- PUT - update user setting *
- input: {password} or {email}
- output:
- success: 200 OK
- fail: 400 Bad Request
- POST - signin
- input: {username, password}
- output:
- success: 200 OK (with cookie)
- fail: 401 Unauthorized
- GET - signout *
- output: 200 OK
- GET - list deliveries *
- output: [{}]
- PUT - create delivery *
- input: {company, alias, isPinned, isReceived}
- output:
- success: 201 Created
- fail: 409 Conflict, 400 Bad Request
- PUT - edit delivery *#
- input: {isPinned} or {isReceived} or {alias} (you can edit only one field at a time)
- output:
- success: 200 OK
- fail: 400 Bad Request, 404 Not Found
- DELETE - remove favourite *#
- output:
- success: 200 OK
- fail: 404 Not Found
- output:
Starred (*) APIs need authentication, the others do not. If these APIs are called without credentials (session), the server will return a 401 Unauthorized.
APIs with a #
simbol support batch operations. Simply put a semicolon ;
between the objects that you want to perform the batch operation on. E.g.
DELETE /delivery/${delivery-id-0};${delivery-id-1};...