Différences entre les versions de « Music sender api »
(→Device) |
(→Device) |
||
| Ligne 619 : | Ligne 619 : | ||
|- | |- | ||
|| | || | ||
| − | /api/device/list/$$UUID$$ | + | /api/device/list/$$UUID$$ |
*$$UUID$$ : un UUID de périphérique | *$$UUID$$ : un UUID de périphérique | ||
| − | |||
|| | || | ||
| − | * | + | * extension : un filtre par extension de fichier (optionnel) |
|align='center'| | |align='center'| | ||
GET | GET | ||
| Ligne 635 : | Ligne 634 : | ||
|- | |- | ||
|| | || | ||
| − | /api/device/explore/$$UUID$$ | + | /api/device/explore/$$UUID$$ |
*$$UUID$$ : un UUID de périphérique | *$$UUID$$ : un UUID de périphérique | ||
| − | |||
|| | || | ||
| − | * | + | * path : un chemin sur le périphérique |
| + | * extension : un filtre par extension de fichier (optionnel) | ||
|align='center'| | |align='center'| | ||
GET | GET | ||
| Ligne 651 : | Ligne 650 : | ||
|- | |- | ||
|| | || | ||
| − | /api/device/ | + | /api/device/mounted |
| − | |||
|| | || | ||
*vide | *vide | ||
| Ligne 658 : | Ligne 656 : | ||
GET | GET | ||
|| | || | ||
| − | Retourne un tableau avec la liste des | + | Retourne un tableau avec la liste des périphériques montés |
|| | || | ||
*200 : si aucune erreur | *200 : si aucune erreur | ||
| Ligne 666 : | Ligne 664 : | ||
|- | |- | ||
|| | || | ||
| − | /api/device/ | + | /api/device/umounted |
|| | || | ||
*vide | *vide | ||
| Ligne 672 : | Ligne 670 : | ||
GET | GET | ||
|| | || | ||
| − | Retourne un tableau avec la liste des périphériques | + | Retourne un tableau avec la liste des périphériques démontés |
|| | || | ||
*200 : si aucune erreur | *200 : si aucune erreur | ||
| Ligne 680 : | Ligne 678 : | ||
|- | |- | ||
|| | || | ||
| − | /api/device/ | + | /api/device/$$UUID$$ |
| + | *$$UUID$$ : un UUID de périphérique | ||
| + | || | ||
| + | |align='center'| | ||
| + | POST | ||
| + | || | ||
| + | Monte le périphérique sur le système | ||
| + | || | ||
| + | *200 : si le montage réussie | ||
| + | *400 : si le montage échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/device/$$UUID$$ | ||
| + | *$$UUID$$ : un UUID de périphérique | ||
| + | || | ||
| + | |align='center'| | ||
| + | DELETE | ||
| + | || | ||
| + | Démonte le périphérique du système | ||
| + | || | ||
| + | *200 : si le démontage réussie | ||
| + | *400 : si le démontage échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |} | ||
| + | ==Share== | ||
| + | L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"} | ||
| + | {|class="wikitable" width="100%" | ||
| + | |-valign=top | ||
| + | ! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée | ||
| + | |- | ||
| + | || | ||
| + | /api/share | ||
|| | || | ||
*vide | *vide | ||
| Ligne 686 : | Ligne 718 : | ||
GET | GET | ||
|| | || | ||
| − | Retourne un tableau avec la liste des | + | Retourne un tableau avec tous les partages montés |
| + | || | ||
| + | *200 | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/share/list/$$HOST$$ | ||
| + | *$$HOST$$ : un hôte supportant le protocole SMB/CIFS | ||
| + | || | ||
| + | * vide | ||
| + | |align='center'| | ||
| + | GET | ||
| + | || | ||
| + | Retourne un tableau avec la liste des partages disponibles sur l'hôte | ||
|| | || | ||
| − | *200 | + | *200 |
| − | |||
|| | || | ||
[[Fichier:implemented_green_tick.png|center|40px]] | [[Fichier:implemented_green_tick.png|center|40px]] | ||
|- | |- | ||
|| | || | ||
| − | /api/ | + | /api/share/list/$$HOST$$/$$SHARE$$ |
| − | *$$ | + | *$$HOST$$ : un hôte supportant le protocole SMB/CIFS |
| + | *$$SHARE$$ : le nom du partage sur cet hôte | ||
|| | || | ||
| + | * extension : filtre à appliquer sur les fichiers (optionnel) | ||
|align='center'| | |align='center'| | ||
| − | + | GET | |
|| | || | ||
| − | + | Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage | |
| + | |||
| + | Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers | ||
|| | || | ||
| − | *200 | + | *200 |
| − | |||
|| | || | ||
[[Fichier:implemented_green_tick.png|center|40px]] | [[Fichier:implemented_green_tick.png|center|40px]] | ||
|- | |- | ||
|| | || | ||
| − | /api/device/ | + | /api/device/explore/$$HOST$$/$$SHARE$$ |
| − | *$$ | + | *$$HOST$$ : un hôte supportant le protocole SMB/CIFS |
| + | *$$SHARE$$ : le nom du partage sur cet hôte | ||
|| | || | ||
| − | * | + | * path : un chemin sur le périphérique |
| − | * | + | * extension : un filtre par extension de fichier (optionnel) |
| − | |||
| − | |||
|align='center'| | |align='center'| | ||
| − | + | GET | |
|| | || | ||
| − | + | Retourne un tableau avec la liste des fichiers | |
|| | || | ||
| − | *200 : si le | + | *200 : si le partage existe |
| − | *400 : si le | + | *400 : si le partage n'existe pas |
|| | || | ||
| − | [[Fichier: | + | [[Fichier:implemented_green_tick.png|center|40px]] |
|- | |- | ||
|| | || | ||
| − | /api/device/$$ | + | /api/device/$$HOST$$/$$SHARE$$ |
| − | *$$ | + | *$$HOST$$ : un hôte supportant le protocole SMB/CIFS |
| + | *$$SHARE$$ : le nom du partage sur cet hôte | ||
|| | || | ||
| + | * login : le login à utiliser (optionnel) | ||
| + | * password : le mot de passe associé (optionnel) | ||
|align='center'| | |align='center'| | ||
| − | + | POST | |
|| | || | ||
| − | + | Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé | |
|| | || | ||
| − | *200 : si le | + | *200 : si le montage réussie |
| − | *400 : si le | + | *400 : si le montage échoue |
|| | || | ||
[[Fichier:implemented_green_tick.png|center|40px]] | [[Fichier:implemented_green_tick.png|center|40px]] | ||
|- | |- | ||
|| | || | ||
| − | /api/device/ | + | /api/device/$$HOST$$/$$SHARE$$ |
| − | *$$ | + | *$$HOST$$ : un hôte supportant le protocole SMB/CIFS |
| + | *$$SHARE$$ : le nom du partage sur cet hôte | ||
|| | || | ||
| − | |||
|align='center'| | |align='center'| | ||
DELETE | DELETE | ||
|| | || | ||
| − | Démonte le partage | + | Démonte le partage du système |
|| | || | ||
*200 : si le démontage réussie | *200 : si le démontage réussie | ||
*400 : si le démontage échoue | *400 : si le démontage échoue | ||
|| | || | ||
| − | [[Fichier: | + | [[Fichier:implemented_green_tick.png|center|40px]] |
|} | |} | ||
Version du 25 juin 2018 à 17:04
User
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/user |
|
GET |
Retourne un tableau avec tous les objets utilisateur |
|
|
|
/api/user/$$ID$$
|
|
GET |
Retourne un objet utilisateur |
|
|
|
/api/user/ |
|
POST |
Crée un nouvel utilisateur et renvoie son identifiant |
|
|
|
/api/user/email/$$ID$$
|
|
PUT |
Modifie l'email du compte |
|
|
|
/api/user/password/$$ID$$
|
|
PUT |
Modifie le mot de passe du compte |
|
|
|
/api/user/$$ID$$
|
|
DELETE |
Efface l'utilisateur |
|
Genre
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/genre |
|
GET |
Retourne un tableau avec tous les objets genre |
|
|
|
/api/genre/$$ID$$
|
|
GET |
Retourne un objet genre |
|
|
|
/api/genre/like/$$EXPR$$
|
|
GET |
Retourne un tableau d'objets genre |
|
|
|
/api/genre |
|
POST |
Créé un nouvel objet genre |
|
|
|
/api/genre/$$ID$$
|
|
PUT |
Modifie le nom du genre |
|
|
|
/api/genre/$$ID$$
|
|
DELETE |
Efface le genre |
|
Artist
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/artist |
|
GET |
Retourne un tableau avec tous les objets artiste |
|
|
|
/api/artist/$$ID$$
|
|
GET |
Retourne un objet artiste |
|
|
|
/api/artist/like/$$EXPR$$
|
|
GET |
Retourne un tableau d'objets artiste |
|
|
|
/api/artist |
|
POST |
Créé un nouvel objet artiste |
|
|
|
/api/artist/name/$$ID$$
|
|
PUT |
Modifie le nom de l'artiste |
|
|
|
/api/artist/image/$$ID$$
|
|
PUT |
Modifie l'image de l'artiste |
|
|
|
/api/genre/$$ID$$
|
|
DELETE |
Efface l'artiste |
|
Album
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/album |
|
GET |
Retourne un tableau avec tous les objets album |
|
|
|
/api/album/$$ID$$
|
|
GET |
Retourne un objet album |
|
|
|
/api/album/artist/$$ID$$
|
|
GET |
Retourne un tableau d'objets album |
|
|
|
/api/album/genre/$$ID$$
|
|
GET |
Retourne un tableau d'objets album |
|
|
|
/api/album/like/$$EXPR$$
|
|
GET |
Retourne un tableau d'objets album |
|
|
|
/api/album |
|
POST |
Créé un nouvel objet album |
|
|
|
/api/album/name/$$ID$$
|
|
PUT |
Modifie le nom de l'album |
|
|
|
/api/album/image/$$ID$$
|
|
PUT |
Modifie l'image de l'album |
|
|
|
/api/genre/$$ID$$
|
|
DELETE |
Efface l'album |
|
Music
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/music/info/$$ID$$
|
|
GET |
Retourne un objet musique au format Json |
|
|
|
/api/music/content/$$ID$$
|
|
GET |
Retourne le contenu de la musique (fichier son) |
|
|
|
/api/music/album/$$ID$$
|
|
GET |
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant |
|
|
|
/api/music/artist/$$ID$$
|
|
GET |
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant |
|
Image
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/images |
|
GET |
Retourne un tableau avec tous les objets image |
|
|
|
/api/image/info/$$ID$$
|
|
GET |
Retourne un objet image |
|
|
|
/api/image/content/$$ID$$
|
|
GET |
Retourne le contenu du fichier avec le type mime en entête |
|
|
|
/api/image |
|
POST |
Créé un nouvel objet image |
|
|
|
/api/image/$$ID$$
|
|
PUT |
Modifie l'image |
|
|
|
/api/image/$$ID$$
|
|
DELETE |
Efface l'image |
|
Device
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/device |
|
GET |
Retourne un tableau avec tous les périphériques |
|
|
|
/api/device/list/$$UUID$$
|
|
GET |
Retourne un tableau avec la liste récursive des fichiers |
|
|
|
/api/device/explore/$$UUID$$
|
|
GET |
Retourne un tableau avec la liste des fichiers |
|
|
|
/api/device/mounted |
|
GET |
Retourne un tableau avec la liste des périphériques montés |
|
|
|
/api/device/umounted |
|
GET |
Retourne un tableau avec la liste des périphériques démontés |
|
|
|
/api/device/$$UUID$$
|
POST |
Monte le périphérique sur le système |
|
||
|
/api/device/$$UUID$$
|
DELETE |
Démonte le périphérique du système |
|
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/share |
|
GET |
Retourne un tableau avec tous les partages montés |
|
|
|
/api/share/list/$$HOST$$
|
|
GET |
Retourne un tableau avec la liste des partages disponibles sur l'hôte |
|
|
|
/api/share/list/$$HOST$$/$$SHARE$$
|
|
GET |
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers |
|
|
|
/api/device/explore/$$HOST$$/$$SHARE$$
|
|
GET |
Retourne un tableau avec la liste des fichiers |
|
|
|
/api/device/$$HOST$$/$$SHARE$$
|
|
POST |
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, nobody sera utilisé |
|
|
|
/api/device/$$HOST$$/$$SHARE$$
|
DELETE |
Démonte le partage du système |
|