Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CodeDescription
200

Okay

201

Created

202

Accepted, Queued

400

Bad request

401

Auth Failure

403

Forbidden

404

Resource Not Found

405

Method Prohibited

409

Conflict/Other Error

Conflict ex: pid in use

Additional information for response included in JSON in the body as {status: Okay or ErrorCode, message: ""}

Open Issues:

  • Should we be strict with CRUD?  E.g. If an item exists and a post command, versus put, is issued should it update or return a code existing the item already exists?  Also if a PUT is attempted on an item that doesn't exist should we fail or just create the item?  Specifically when a user puts and there is no item to update, do they care?
  • Regarding the 202 Code, this may not be needed, but I put in place in the event we have to accept API requests and wait to go test streaming (make sure the derivatives are there).  This is a worst case if our file storage is too slow (which would be really bad of course).  
  • Should we let GET items/ return a list of all items?  List would be massive.

...