1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
Account
=======
.. _user-validateUsername:
Validate username
-----------------
: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::
:header: Name,Type,Description
gender,string,``Male`` or ``Female``
birthYear,int,
zipCode,string,
isProfilePrivate,boolean,
enableComments,boolean,
emailOptIn,boolean,
emailComments,boolean,
emailNewFollowers,boolean,
isExplicitContentFilterEnabled,boolean,
isExplicitContentFilterPINProtected,boolean,
currentUsername,string,
currentPassword,string,
newUsername,string,
newPassword,string,
facebookAutoShareEnabled,boolean,
autoShareTrackPlay,boolean,
autoShareLikes,boolean,
autoShareFollows,boolean,
facebookSettingChecksum,boolean,
userInitiatedChange,boolean,
.. _user-getSettings:
Retrieve
^^^^^^^^
:Method: user.getSettings
.. csv-table::
:header: Name,Type,Description
includeFacebook,boolean,
See :ref:`settingkeys` for return values.
.. _user-changeSettings:
Modify
^^^^^^
:Method: user.changeSettings
.. csv-table::
:header: Name,Type,Description
includeFacebook,boolean,
Additionally keys listed in :ref:`settingkeys` are permitted in the request
body.
.. 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
}
}
|
