1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-11-09 11:42:28 +01:00
polr/docs/developer-guide/api_errors.md
Chaoyi Zha 1fb607ba63
Bulk link creation API (#443)
* Add bulk shortening API endpoint & create controller methods
* Update documentation
* Remove space %20 mapping for bulk API
2018-04-20 21:35:45 -04:00

812 B

API Error Text Codes

To diagnose an unexpected or unhandled error, turn on the APP_DEBUG flag by setting it to true in .env

SERVER_ERROR: A generic, unhandled error has occured.

JSON_ONLY: Only JSON-encoded data is available for this endpoint.

MISSING_PARAMETERS: Invalid or missing parameters.

INVALID_PARAMETERS: Invalid parameters.

NOT_FOUND: Object not found.

ACCESS_DENIED: User is not authorized to access the object.

INVALID_ANALYTICS_TYPE: Invalid analytics type requested.

CREATION_ERROR: An error occurred while creating the object.

AUTH_ERROR: An error occured while attempting to authenticate the user to the API.

QUOTA_EXCEEDED: User's API usage has exceeded alloted quota.

ANALYTICS_ERROR: Invalid bounds or unexpected error while fetching analytics data.