diff options
| -rw-r--r-- | json/account.rst | 108 | ||||
| -rw-r--r-- | json/authentication.rst | 32 |
2 files changed, 101 insertions, 39 deletions
diff --git a/json/account.rst b/json/account.rst index 9e04bcd..ab897a4 100644 --- a/json/account.rst +++ b/json/account.rst @@ -1,11 +1,63 @@ Account ======= -.. _settingkeys: +.. _user-validateUsername: + +Validate username +----------------- -Available settings +:Method: user.validateUsername + +This method can be used before authenticating a user with +:ref:`auth-userLogin`, but requires a valid :ref:`auth-partnerLogin`. + +.. csv-table:: + :header: Name,Type,Description + + username,string, + +.. csv-table:: + :header: Name,Type,Description + + isValid,boolean, + isUnique,boolean, + +.. _user-createUser: + +Create new account ------------------ +:Method: user.createUser + +.. csv-table:: + :header: Name,Type,Description + + username,string, + password,string, + gender,string, + birthYear,int, + zipCode,int, + emailOptIn,boolean, + countryCode,string, + accountType,string,``registered``, + registeredType,string,``user``, + includePandoraOneInfo,boolean, + includeAccountMessage,boolean, + returnCollectTrackLifetimeStats,boolean, + returnIsSubscriber,boolean, + xplatformAdCapable,boolean, + includeFacebook,boolean, + includeGoogleplay,boolean, + includeShowUserRecommendations,boolean, + includeAdvertiserAttributes,boolean, + +.. TODO response? + +.. _settingkeys: + +Settings +-------- + The following settings are currently read/writeable: .. csv-table:: @@ -34,8 +86,8 @@ The following settings are currently read/writeable: .. _user-getSettings: -Retrieve settings ------------------ +Retrieve +^^^^^^^^ :Method: user.getSettings @@ -48,8 +100,8 @@ See :ref:`settingkeys` for return values. .. _user-changeSettings: -Change settings ---------------- +Modify +^^^^^^ :Method: user.changeSettings @@ -61,5 +113,47 @@ Change settings Additionally keys listed in :ref:`settingkeys` are permitted in the request body. -.. TODO: response? +.. TODO response? + +.. _user-emailPassword: + +Recover password +---------------- + +:Method: user.emailPassword + +.. csv-table:: + :header: Name,Type,Description + + username,string, + +.. TODO response? + +.. _user-canSubscribe: + +Get 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. + +This method has no request parameters. + +.. 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 + } + } diff --git a/json/authentication.rst b/json/authentication.rst index 4f1d1e4..a0bf072 100644 --- a/json/authentication.rst +++ b/json/authentication.rst @@ -178,35 +178,3 @@ 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 - } - } |