Document the API error codes
Karel Ledru
I'm currently playing with the API and the documentation is lacking quite a bit! I would greatly appreciate that you document all the error codes for instance. I'm creating a task and get "Invalid Orderindex Type INDEX_014" which isn't informative especially since none of my code make any reference to an orderindex.
Log In
Ezequiel
Agree on this update.
I came across some API error code stating:
{'err': 'Team not found', 'ECODE': 'TIMEENTRY_052'}
Despite the Team actually existed and it was correct, After 2 hours of breaking my head I found that this issue was due to adding Time Entries with user ids that were previously deactivated from the platform, users ids still exists though at Task level. (There may be other test cases)
Properly documenting/rephrasing error messages will help quite a lot to API consumers,
Regards!
J
Jan Zalewski
this could be useful and potentially alevieate some work from support team.
I for example was greeted with error code ITEM_086 when trying to update a task,
it turned out I had wrong array structure and was able to repair it but not without frusstration delay and wasting some time of support team
all while the code was there just not very helpful
August Shah
In addition to this, the error message "Team not Authorized" is not a general error message, as your team has stated. It would be great to have documentation on the error messages, and more information error messages
T
Tiago
Adding to what has been said, you cannot really say you have a public API if you don't clarify what the responses mean and what to expect from the API.