diff options
author | Winston Weinert <winston@ml1.net> | 2014-07-09 15:07:09 -0500 |
---|---|---|
committer | Winston Weinert <winston@ml1.net> | 2014-07-09 15:07:09 -0500 |
commit | 9b7bf126205da00d44280f6e11748d86d299a55c (patch) | |
tree | fd7cedded43156068ff792101bfbfa96ee083298 | |
parent | f4e0d002be82ec9a75a4833520f92dae13da8394 (diff) | |
download | pandora-apidoc-9b7bf126205da00d44280f6e11748d86d299a55c.tar.gz pandora-apidoc-9b7bf126205da00d44280f6e11748d86d299a55c.tar.bz2 pandora-apidoc-9b7bf126205da00d44280f6e11748d86d299a55c.zip |
Document user.canSubscribe
-rw-r--r-- | json/authentication.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/json/authentication.rst b/json/authentication.rst index 67f5879..4f1d1e4 100644 --- a/json/authentication.rst +++ b/json/authentication.rst @@ -177,3 +177,36 @@ The returned userAuthToken is used to authenticate access to other API methods. 1002,Wrong user credentials. + +.. _user-canSubscribe: + +Get user subscriber status +-------------------------- + +:Method: user.canSubscribe + +Returns whether a user is subscribed or if they can subscribe to Pandora One. +Can be useful to determine which :ref:`Partner password<partners>` to use. + +.. code:: json + + { + "userAuthToken": "XXX", + "syncTime": XXX + } + +.. csv-table:: + :header: Name,Type,Description + + canSubscribe,boolean,false if user is a Pandora One subscriber + isSubscriber,boolean,true if user is a Pandora One Subscriber + +.. code:: json + + { + "stat": "ok", + "result": { + "canSubscribe": false, + "isSubscriber": true + } + } |