summaryrefslogtreecommitdiff
path: root/rest/stations.rst
diff options
context:
space:
mode:
authorMike Crute <mike@crute.us>2017-10-29 04:32:32 +0000
committerMike Crute <mike@crute.us>2017-10-29 04:34:16 +0000
commitcbbcd70463862c5aac1c2467d70895a77bdb96b3 (patch)
tree4b21d4eb6460c90a8fe115c5cb3f8fb8c7bd5e58 /rest/stations.rst
parent19f91a60a96d09584e666d5e2a9b8794e459215d (diff)
downloadpandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.tar.gz
pandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.tar.bz2
pandora-apidoc-cbbcd70463862c5aac1c2467d70895a77bdb96b3.zip
Stub out REST API docs
Diffstat (limited to 'rest/stations.rst')
-rw-r--r--rest/stations.rst178
1 files changed, 178 insertions, 0 deletions
diff --git a/rest/stations.rst b/rest/stations.rst
new file mode 100644
index 0000000..8d2324b
--- /dev/null
+++ b/rest/stations.rst
@@ -0,0 +1,178 @@
+.. _rest-stations:
+
+========
+Stations
+========
+
+.. _rest-v1-station-getStations:
+
+Get Stations
+============
+
+:Endpoint: /v1/station/getStations
+
+Request
+-------
+.. code:: json
+
+ {
+ "pageSize": 250
+ }
+
+Response
+--------
+.. code:: json
+
+ {
+ "totalStations": 2,
+ "sortedBy": "lastPlayedTime",
+ "index": 0,
+ "stations": [
+ {
+ "stationId": "12345",
+ "stationFactoryPandoraId": "SF:12345:123",
+ "pandoraId": "ST:12345",
+ "name": "Chill Out Radio",
+ "art": [
+ {
+ "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_90W_90H.jpg",
+ "size": 90
+ },
+ {
+ "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_130W_130H.jpg",
+ "size": 130
+ },
+ {
+ "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_500W_500H.jpg",
+ "size": 500
+ },
+ {
+ "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_640W_640H.jpg",
+ "size": 640
+ },
+ {
+ "url": "https://cont-2.p-cdn.com/images/public/int/9/2/0/5/634904045029_1080W_1080H.jpg",
+ "size": 1080
+ }
+ ],
+ "dateCreated": "2017-10-27T20:10:33.202-07:00",
+ "lastPlayed": "2017-10-27T21:36:04.426-07:00",
+ "totalPlayTime": 987,
+ "isNew": false,
+ "allowDelete": true,
+ "allowRename": false,
+ "allowEditDescription": false,
+ "allowAddSeed": false,
+ "isShared": false,
+ "isTransformAllowed": false,
+ "isOnDemandEditorialStation": false,
+ "isAdvertiserStation": false,
+ "canShuffleStation": true,
+ "canAutoshare": true,
+ "advertisingKey": "",
+ "isArtistMessagesEnabled": true,
+ "isThumbprint": false,
+ "isShuffle": false,
+ "genre": [
+ "Rock",
+ "Dance / Electronica"
+ ],
+ "genreSponsorship": "G464",
+ "adGenre": "electronica",
+ "antiTarget": false,
+ "initialSeed": {
+ "musicId": "G464",
+ "pandoraId": "GE:464",
+ "genre": {
+ "stationName": "Chill Out",
+ "isRedirect": false,
+ "isComedy": false
+ },
+ "listenerCount": 4165328,
+ "art": [
+ {
+ "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_90W_90H.jpg",
+ "size": 90
+ },
+ {
+ "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_130W_130H.jpg",
+ "size": 130
+ },
+ {
+ "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_500W_500H.jpg",
+ "size": 500
+ },
+ {
+ "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/int/9/2/0/5/634904045029_640W_640H.jpg",
+ "size": 640
+ },
+ {
+ "url": "https://cont-1.p-cdn.com/images/public/int/9/2/0/5/634904045029_1080W_1080H.jpg",
+ "size": 1080
+ }
+ ]
+ },
+ "adkv": {
+ "artist": "G464",
+ "genre": "electronica",
+ "clean": "0",
+ "gcat": "G464"
+ },
+ "creatorWebname": "example",
+ "artId": "images/public/int/9/2/0/5/634904045029"
+ },
+ {
+ "stationId": "12345",
+ "stationFactoryPandoraId": "SF:12345:0",
+ "pandoraId": "TT:0",
+ "name": "Thumbprint Radio",
+ "description": "Music inspired by your 999 thumbs from across all your stations.",
+ "art": [
+ {
+ "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartpralbumart_90W_90H.jpg",
+ "size": 90
+ },
+ {
+ "url": "https://cont-2.p-cdn.com/images/public/devicead/t/r/a/m/daartpralbumart_130W_130H.jpg",
+ "size": 130
+ },
+ {
+ "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartpralbumart_500W_500H.jpg",
+ "size": 500
+ }
+ ],
+ "dateCreated": "2017-10-27T20:10:33.202-07:00",
+ "lastPlayed": "2017-10-27T21:36:04.426-07:00",
+ "totalPlayTime": 99999,
+ "isNew": false,
+ "allowDelete": true,
+ "allowRename": false,
+ "allowEditDescription": false,
+ "allowAddSeed": false,
+ "isShared": false,
+ "isTransformAllowed": false,
+ "isOnDemandEditorialStation": false,
+ "isAdvertiserStation": false,
+ "canShuffleStation": false,
+ "canAutoshare": true,
+ "advertisingKey": "",
+ "isArtistMessagesEnabled": false,
+ "isThumbprint": true,
+ "thumbprintThumbCount": 999,
+ "thumbprintProcessSkips": true,
+ "thumbprintShareArt": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartprfbalbumart_1200W_630H.jpg",
+ "shareName": "example's Thumbprint Radio",
+ "isShuffle": false,
+ "genre": [],
+ "adkv": {
+ "artist": "",
+ "genre": "thumbprintradio",
+ "clean": "0",
+ "gcat": "thumbprintradio"
+ },
+ "creatorWebname": "example",
+ "artId": "images/public/devicead/t/r/a/m/daartpralbumart",
+ "dominantColor": "0c81c6"
+ }
+ ]
+ }