Skip to content

API Response Codes

The Portfoleon API uses the following response and error codes:

Response Code Meaning
200 OK -- everything went fine
201 Created -- POST request to create an item went fine
204 Deleted -- DELETE request to delete an item went fine
400 Bad Request -- There was an error processing your request
401 Unauthorized -- You are not authorized, your token has expired or your credentials are wrong
403 Forbidden -- You do not have sufficient privileges to access the item
404 Not Found -- The specified item could not be found
429 Too Many Requests -- You have exceeded your rate limit
500 Internal Server Error -- We had a problem with our server. Please try again later.
503 Service Unavailable -- We're temporarially offline for maintanance. Please try again later.

Along with each error a detailed message list can be passed in a form:

{ "message" : { "context1": "message1", "context2": "message2" ... } }

contextN can be any string that refers to an object where an error occured. messageN is usually a desciption of the error that has occured.

Error messages may contain references to work items in a form of [work_item 1234] where 1234 is the work item id. The client UI should replace such references to hyperlinks to the respective work items.

See also the standard resource API.