In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix:
Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs.
- GET will retrieve information about a element or retrieve all elements
- POST will create an element
- PUT will update a single element
- DELETE will remove a single element
All dates are in yyyy-MM-dd format. For example, 10th July 2014 is 2014-07-10
Currencies are specified in ISO 4217 format. For example, Euro is EUR
Information can be sent in the body as form urlencoded or JSON, but make sure the Content-Type header matches the body structure or the server gremlins will be angry.
When updating an element using the PUT method, you should put all the information of the element ( not just the information you are changing ) in the body.
Response Codes & Errors
Bullet uses standard HTTP response codes to indicate whether a request was successful or not. All errors return a JSON object describing the error.
|200||OK||Everything worked as expected|
|400||Bad Request||Often missing a required parameter|
|401||Unauthorized||The credential provided are not valid|
|404||Not Found||The requested item doesn't exist|
|500||Internal Server Error||Something went wrong on Bullet's end|