Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 185 lines (169 sloc) 6.36 kB
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
1 # Favorite Service : getUserFavorites
2
3 GET favorite/getUserFavorites
4
5 ## Description
6
7 Return the authenticated user or specified user_id favorites filtered by item type.
8
9 > NB : The favorites are inherently public.
10
11 ***
12
13 ## Requires authentication
14
15 __Requires a valid app_id__
16
17 ***
18
19 ## Parameters
20
21 > + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
22 > + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
23 > + `user_id` - _optional_ : The User ID to fetch the favorites from
af2c38a @tchapi Add article option for retrieval
tchapi authored
24 > + `type` - _optional_ : The favorites type (`tracks`, `albums`, `artists`, `articles`).
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
25
26 ***
27
28 ## Example
29 **Request**
30
31 http://www.qobuz.com/api.json/0.2/favorite/getUserFavorites?app_id=100000000&limit=2&type=albums&user_auth_token=MyAuThTokEn
32
33 **Return**
34
35 ```json
36 {
37 "albums": {
38 "offset": 0,
39 "limit": 2,
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
40 "total": 134,
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
41 "items": [
42 {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
43 "id": "5051083087698",
44 "genre": {
45 "path": [
46 64
47 ],
48 "id": 64,
49 "slug": "electro",
50 "color": "#5eabc1",
51 "name": "Electro"
52 },
53 "tracks_count": 16,
54 "title": "MG",
55 "released_at": 1430085600,
56 "duration": 3281,
57 "articles": [
58 {
59 "id": 58563444,
60 "label": "Qualité CD 16 bits",
61 "price": 9.99,
62 "type": "lls",
63 "url": "/order/58563444",
64 "description": "Lossless 16 bits 44,1 kHz (FLAC, ALAC, WMA, AIFF, WAV)",
65 "currency": "EUR"
66 }
67 ],
68 "media_count": 1,
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
69 "image": {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
70 "small": "http://static.qobuz.com/images/covers/98/76/5051083087698_230.jpg",
71 "back": null,
72 "large": "http://static.qobuz.com/images/covers/98/76/5051083087698_600.jpg",
73 "thumbnail": "http://static.qobuz.com/images/covers/98/76/5051083087698_50.jpg"
74 },
75 "label": {
76 "id": 46809,
77 "slug": "mute-2",
78 "supplier_id": 30,
79 "albums_count": 377,
80 "name": "Mute"
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
81 },
82 "artist": {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
83 "id": 561952,
84 "picture": null,
85 "image": null,
86 "slug": "mg",
87 "albums_count": 8,
88 "name": "MG"
89 },
90 "qobuz_id": 24114418,
91 "popularity": 0,
92 "purchasable": true,
93 "streamable": true,
94 "previewable": true,
95 "sampleable": true,
96 "downloadable": true,
97 "displayable": true,
98 "purchasable_at": 1430085600,
99 "streamable_at": 1430085600,
100 "maximum_sampling_rate": 44.1,
101 "maximum_bit_depth": 16,
102 "hires": false,
103 "favorited_at": 1431519420
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
104 },
105 {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
106 "id": "0808699111126",
107 "genre": {
108 "path": [
109 64
110 ],
111 "id": 64,
112 "slug": "electro",
113 "color": "#5eabc1",
114 "name": "Electro"
115 },
116 "tracks_count": 24,
117 "title": "The Demon Diaries",
118 "released_at": 1430431200,
119 "duration": 5607,
120 "articles": [
121 {
122 "id": 57177168,
123 "label": "Qualité CD 16 bits",
124 "price": 16.79,
125 "type": "lls",
126 "url": "/order/57177168",
127 "description": "Lossless 16 bits 44,1 kHz (FLAC, ALAC, WMA, AIFF, WAV)",
128 "currency": "EUR"
129 },
130 {
131 "id": 57177169,
132 "label": "Hi-Res",
133 "price": 20.99,
134 "type": "smr",
135 "url": "/order/57177169",
136 "description": "Jusqu'à 24 bits 96 kHz (FLAC, ALAC, WMA, AIFF, WAV)",
137 "currency": "EUR"
138 }
139 ],
140 "media_count": 2,
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
141 "image": {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
142 "small": "http://static.qobuz.com/images/covers/26/11/0808699111126_230.jpg",
143 "back": null,
144 "large": "http://static.qobuz.com/images/covers/26/11/0808699111126_600.jpg",
145 "thumbnail": "http://static.qobuz.com/images/covers/26/11/0808699111126_50.jpg"
146 },
147 "label": {
148 "id": 107193,
149 "slug": "etage-noir-recordings",
150 "supplier_id": 3,
151 "albums_count": 3,
152 "name": "Etage Noir Recordings"
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
153 },
154 "artist": {
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
155 "id": 31317,
156 "picture": null,
157 "image": null,
158 "slug": "parov-stelar",
159 "albums_count": 16,
160 "name": "Parov Stelar"
161 },
162 "qobuz_id": 23585993,
163 "popularity": 0,
164 "purchasable": true,
165 "streamable": true,
166 "previewable": true,
167 "sampleable": true,
168 "downloadable": true,
169 "displayable": true,
170 "purchasable_at": 1431295200,
171 "streamable_at": 1431295200,
172 "maximum_sampling_rate": 44.1,
173 "maximum_bit_depth": 24,
174 "hires": true,
175 "favorited_at": 1431334789
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
176 }
177 ]
e2a9507 @bastienhauville Update getUserFavorites.md
bastienhauville authored
178 },
179 "user": {
180 "id": 178905,
181 "login": "mylogin"
0b50201 @tchapi Dear API, you deserve a better documentation. KR.
tchapi authored
182 }
183 }
184 ```
Something went wrong with that request. Please try again.