summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--index.rst2
-rw-r--r--json/play.rst48
-rw-r--r--json/stations.rst250
3 files changed, 299 insertions, 1 deletions
diff --git a/index.rst b/index.rst
index c7dcc78..02e7eca 100644
--- a/index.rst
+++ b/index.rst
@@ -15,7 +15,7 @@ The source code of this documentation is available at `github`_ or `here`_.
Suggestions and patches are welcome.
.. _github: http://github.com/promyloph/pandora-apidoc/
-.. _here: http://6xq.net/git/pandora-apidoc.git
+.. _here: http://6xq.net/git/lars/pandora-apidoc.git
.. toctree::
:maxdepth: 2
diff --git a/json/play.rst b/json/play.rst
index 4766f2f..7c51680 100644
--- a/json/play.rst
+++ b/json/play.rst
@@ -133,8 +133,56 @@ station. Banned songs are never played again on this particular station.
stationToken,string,
trackToken,string,
+ isPositive,boolean,``false`` bans track
+
+.. code:: json
+
+ {
+ "stationToken": "374145764047334893",
+ "trackToken": "fcc2298ec4b1c93e73ad4b2813ceca0dba565bbbe03d8a78bad65ee89a7aaf4d0b3b11954fe6ab08794283f8ef1d44bfc32ce9f8e0513bec",
+ "isPositive": false,
+ "userAuthToken": "XXX",
+ "syncTime": 1404911036
+ }
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ dateCreated,object,
+ musicToken,string,
+ songName,string,
+ totalThumbsUp,int,
+ feedbackId,string,See :ref:`station-deleteFeedback`
isPositive,boolean,
+.. code:: json
+
+ {
+ "stat": "ok",
+ "result": {
+ "totalThumbsDown": 4,
+ "stationPersonalizationPercent": 57,
+ "dateCreated": {
+ "date": 9,
+ "day": 3,
+ "hours": 6,
+ "minutes": 3,
+ "month": 6,
+ "seconds": 56,
+ "time": 1404911036840,
+ "timezoneOffset": 420,
+ "year": 114
+ },
+ "albumArtUrl": "http://cont-sv5-2.pandora.com/images/public/amz/2/2/9/5/094632175922_130W_130H.jpg",
+ "musicToken": "23234b0abdbeb37d",
+ "songName": "Nothing Compares 2 U",
+ "artistName": "Sinead O'Connor",
+ "totalThumbsUp": 20,
+ "feedbackId": "21955050420286614",
+ "isPositive": false
+ }
+ }
+
.. _user-sleepSong:
diff --git a/json/stations.rst b/json/stations.rst
index b8e7821..ba3b1bd 100644
--- a/json/stations.rst
+++ b/json/stations.rst
@@ -203,6 +203,72 @@ station.
stationToken,string,"Existing station, see :ref:`user-getStationList`"
musicToken,string,"See :ref:`music-search`"
+.. code:: json
+
+ {
+ "musicToken": "R1119",
+ "stationToken": "1181753543028256237",
+ "userAuthToken": "XXX",
+ "syncTime": 1404912202
+ }
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ seedId,string,Can be used to remove seed with :ref:`station-deleteMusic`
+
+.. code:: json
+
+ {
+ "stat": "ok",
+ "result": {
+ "artistName": "Foo Fighters",
+ "musicToken": "3bcf3f314419f974",
+ "seedId": "2123197691273031149",
+ "artUrl": "http://cont-dc6-1.pandora.com/images/public/amg/portrait/pic200/drP900/P972/P97242B3S6P.jpg",
+ "dateCreated": {
+ "date": 9,
+ "day": 3,
+ "hours": 6,
+ "minutes": 23,
+ "month": 6,
+ "seconds": 22,
+ "time": 1404912202722,
+ "timezoneOffset": 420,
+ "year": 114
+ }
+ }
+ }
+
+.. _station-deleteMusic:
+
+Remove seed
+-----------
+
+:Method: station.deleteMusic
+
+Seeds can be removed from a station, except for the last one.
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ seedId,string,See :ref:`station-getStation` and :ref:`station-addMusic`
+
+.. code:: json
+
+ {
+ "seedId": "1230715903914683885",
+ "userAuthToken": "XXX",
+ "syncTime": 1404912023
+ }
+
+This method does not return data.
+
+.. csv-table::
+ :header: Code,Description
+
+ 1032,Last seed cannot be removed
+
.. _station-renameStation:
Rename station
@@ -228,6 +294,175 @@ Delete station
stationToken,string,"Existing station, see :ref:`user-getStationList`"
+.. code:: json
+
+ {
+ "stationToken": "374145764047334893",
+ "userAuthToken": "XXX",
+ "syncTime": 1404911699
+ }
+
+No data is returned in response.
+
+.. _station-getStation:
+
+Retrieve extended station information
+-------------------------------------
+
+:Method: station.getStation
+
+Extended station information includes seeds and feedback.
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ stationToken,string,
+ includeExtendedAttributes,bool,
+
+.. code:: json
+
+ {
+ "stationToken": "374145764047334893",
+ "includeExtendedAttributes": true,
+ "userAuthToken": "XXX",
+ "syncTime": 1404910732
+ }
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ music,object,"Station seeds, see :ref:`station-addMusic`"
+ music.songs,list,Song seeds
+ music.artists,list,Artist seeds
+ feedback,object,Feedback added by :ref:`station-addFeedback`
+ feedback.thumbsUp,list,
+ feedback.thumbsDown,list,
+
+.. code:: json
+
+ {
+ "stat": "ok",
+ "result": {
+ "suppressVideoAds": false,
+ "stationId": "374145764047334893",
+ "allowAddMusic": true,
+ "dateCreated": {
+ "date": 15,
+ "day": 6,
+ "hours": 7,
+ "minutes": 34,
+ "month": 0,
+ "nanos": 874000000,
+ "seconds": 21,
+ "time": 1295105661874,
+ "timezoneOffset": 480,
+ "year": 111
+ },
+ "stationDetailUrl": "https://www.pandora.com/login?target=%2Fstations%2Fc644756145fc3f5df1916901125ee697495159685ae39575",
+ "artUrl": "http://cont-1.p-cdn.com/images/public/amz/5/2/8/5/075678235825_500W_498H.jpg",
+ "requiresCleanAds": false,
+ "stationToken": "374145764047334893",
+ "stationName": "Winter Radio",
+ "music": {
+ "songs": [{
+ "seedId": "428301990230109677",
+ "artistName": "Tori Amos",
+ "dateCreated": {
+ "date": 15,
+ "day": 6,
+ "hours": 7,
+ "minutes": 34,
+ "month": 0,
+ "nanos": 873000000,
+ "seconds": 21,
+ "time": 1295105661873,
+ "timezoneOffset": 480,
+ "year": 111
+ },
+ "artUrl": "http://cont-sjl-1.pandora.com/images/public/amz/5/2/8/5/075678235825_130W_130H.jpg",
+ "songName": "Winter",
+ "musicToken": "87ef9db1c3f04330"
+ }],
+ "artists": []
+ },
+ "isShared": false,
+ "allowDelete": true,
+ "genre": ["Rock"],
+ "isQuickMix": false,
+ "allowRename": true,
+ "stationSharingUrl": "https://www.pandora.com/login?target=%2Fshare%2Fstation%2Fc644756145fc3f5df1916901125ee697495159685ae39575",
+ "feedback": {
+ "thumbsUp": [{
+ "dateCreated": {
+ "date": 28,
+ "day": 5,
+ "hours": 13,
+ "minutes": 57,
+ "month": 2,
+ "nanos": 760000000,
+ "seconds": 49,
+ "time": 1396040269760,
+ "timezoneOffset": 420,
+ "year": 114
+ },
+ "albumArtUrl": "http://cont-1.p-cdn.com/images/public/amz/9/7/1/4/900004179_130W_130H.jpg",
+ "musicToken": "d33dd0c199ebaf28425ba2910f7abf8b",
+ "songName": "Hey Lover",
+ "artistName": "Keri Noble",
+ "feedbackId": "-7239441039566426643",
+ "isPositive": true
+ }],
+ "totalThumbsUp": 20,
+ "totalThumbsDown": 5,
+ "thumbsDown": [{
+ "dateCreated": {
+ "date": 28,
+ "day": 5,
+ "hours": 10,
+ "minutes": 43,
+ "month": 2,
+ "nanos": 637000000,
+ "seconds": 30,
+ "time": 1396028610637,
+ "timezoneOffset": 420,
+ "year": 114
+ },
+ "albumArtUrl": "http://cont-ch1-1.pandora.com/images/public/amz/9/0/5/1/724383771509_130W_130H.jpg",
+ "musicToken": "5a0018da7876f6e7",
+ "songName": "Talk Show Host",
+ "artistName": "Radiohead",
+ "feedbackId": "-7241622182873125395",
+ "isPositive": false
+ }]
+ }
+ }
+ }
+
+
+.. _station-deleteFeedback:
+
+Remove feedback
+---------------
+
+:Method: station.deleteFeedback
+
+Feedback added by :ref:`station-addFeedback` can be removed from the station.
+
+.. csv-table::
+ :header: Name,Type,Description
+
+ feedbackId,string,See :ref:`station-getStation`
+
+.. code:: json
+
+ {
+ "feedbackId": "3738252050522320365",
+ "userAuthToken": "XXX",
+ "syncTime": 1404910760
+ }
+
+This method has does not return data.
+
.. _station-getGenreStations:
Predefined stations
@@ -265,6 +500,21 @@ used as musicToken to create a new station with :ref:`station-createStation`.
}
}
+.. _station-transformSharedStation:
+
+Transform shared station
+------------------------
+
+:Method: station.transformSharedStation
+
+Stations created by other users are added as reference to the user’s station
+list. These stations cannot be modified (i.e. rate tracks) unless transformed.
+
+.. csv-table::
+ :header: Name ,Type ,Description
+
+ stationToken,string,See :ref:`user-getStationList`
+
.. _user-setQuickMix:
Modify QuickMix
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 08:28:43 +0000