From cbbcd70463862c5aac1c2467d70895a77bdb96b3 Mon Sep 17 00:00:00 2001 From: Mike Crute Date: Sun, 29 Oct 2017 04:32:32 +0000 Subject: Stub out REST API docs --- rest/errorcodes.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 rest/errorcodes.rst (limited to 'rest/errorcodes.rst') diff --git a/rest/errorcodes.rst b/rest/errorcodes.rst new file mode 100644 index 0000000..13d8a59 --- /dev/null +++ b/rest/errorcodes.rst @@ -0,0 +1,41 @@ +=================== +List of Error Codes +=================== + +.. index:: + single: REST Error codes + +.. note:: + + This page is incomplete. The error enumeration should be complete but codes + and descriptions are guesses. + +These error codes can be returned by all endpoints: + +.. code:: json + + { + "errorCode": 0, + "errorString": "INVALID_REQUEST", + "message": "The request could not be validated" + } + +========== ============================= =========== +Error Code Error String Description +========== ============================= =========== +0 INVALID_REQUEST General bad request error. Often means authentication was invalid +? STREAM_VIOLATION Unable to stream to this region? +? STATION_LIMIT_REACHED Stream minutes limit or skip count reached? +? THUMBPRINT_RADIO_NOT_ELIGIBLE Not enough feedback to construct a Thumbprint station? +? LISTENER_NOT_AUTHORIZED Current user is not able to access shared content? +? PLAYLIST_END End of playlist? +? READONLY_MODE Pandora back-end maintenance? +? STATION_CODE_INVALID Invalid station +? STATION_DOES_NOT_EXIST Station does not exist +? LISTENER_SUSPENDED Account has been suspended +? CREDIT_CARD_NO_RECORD_FOUND No credit card on file? +? CONTENT_HAS_EXPIRED Audio link for song has expired? +? SERVER_ERROR Generic server error +? NOT_FOUND Content not found +? UNPLAYABLE_SHUFFLE_STATION Unable to play shuffle station? +========== ============================= =========== -- cgit v1.2.3