« Music sender api » : différence entre les versions
(→Image) |
(→Device) |
||
| Ligne 600 : | Ligne 600 : | ||
|} | |} | ||
==Device== | ==Device== | ||
L'objet | L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"} | ||
{|class="wikitable" width="100%" | {|class="wikitable" width="100%" | ||
|-valign=top | |-valign=top | ||
| Ligne 612 : | Ligne 612 : | ||
GET | GET | ||
|| | || | ||
Retourne un tableau avec tous les | Retourne un tableau avec tous les périphériques | ||
|| | || | ||
*200 | *200 | ||
| Ligne 620 : | Ligne 620 : | ||
|| | || | ||
/api/device/list/$$UUID$$[/$$EXTENSION$$] | /api/device/list/$$UUID$$[/$$EXTENSION$$] | ||
*$$UUID$$ : un | *$$UUID$$ : un UUID de périphérique | ||
*$$EXTENSION$$ : un filtre par extension de fichier (optionnel) | *$$EXTENSION$$ : un filtre par extension de fichier (optionnel) | ||
|| | || | ||
| Ligne 636 : | Ligne 636 : | ||
|| | || | ||
/api/device/explore/$$UUID$$[/$$EXTENSION$$] | /api/device/explore/$$UUID$$[/$$EXTENSION$$] | ||
*$$UUID$$ : un | *$$UUID$$ : un UUID de périphérique | ||
*$$EXTENSION$$ : un filtre par extension de fichier (optionnel) | *$$EXTENSION$$ : un filtre par extension de fichier (optionnel) | ||
|| | || | ||
| Ligne 651 : | Ligne 651 : | ||
|- | |- | ||
|| | || | ||
/api/ | /api/device/smb/$$SERVER$$ | ||
*$$SERVER$$ : un nom d'hôte ou une adresse IP de serveur SMB/CIFS | |||
|| | |||
*vide | |||
|align='center'| | |||
GET | |||
|| | |||
Retourne un tableau avec la liste des partages SMB/CIFS présent sur l'hôte | |||
|| | |||
*200 : si aucune erreur | |||
*400 : si une erreur survient | |||
|| | |||
[[Fichier:implemented_green_tick.png|center|40px]] | |||
|- | |||
|| | |||
/api/device/mounted | |||
|| | |||
*vide | |||
|align='center'| | |||
GET | |||
|| | |||
Retourne un tableau avec la liste des périphériques montés | |||
|| | |||
*200 : si aucune erreur | |||
*400 : si une erreur survient | |||
|| | |||
[[Fichier:implemented_green_tick.png|center|40px]] | |||
|- | |||
|| | |||
/api/device/umounted | |||
|| | |||
*vide | |||
|align='center'| | |||
GET | |||
|| | |||
Retourne un tableau avec la liste des périphériques démontés | |||
|| | |||
*200 : si aucune erreur | |||
*400 : si une erreur survient | |||
|| | |||
[[Fichier:implemented_green_tick.png|center|40px]] | |||
|- | |||
|| | |||
/api/device/$$UUID$$ | |||
*$$UUID$$ : un UUID de périphérique | |||
|| | || | ||
|align='center'| | |align='center'| | ||
POST | POST | ||
|| | || | ||
Monte le périphérique sur le système | |||
|| | || | ||
*200 : si | *200 : si le montage réussie | ||
*400 : si | *400 : si le montage échoue | ||
|| | || | ||
[[Fichier: | [[Fichier:implemented_green_tick.png|center|40px]] | ||
|- | |- | ||
|| | || | ||
/api/ | /api/device/smb/$$SERVER$$ | ||
*$$ | *$$SERVER$$ : un nom d'hôte ou une adresse IP de serveur SMB/CIFS | ||
|| | || | ||
* | * share : le nom d'hôte ou une adresse IP de serveur SMB/CIFS | ||
* login : le nom d'utilisateur (optionnel) | |||
* password : le mot de passe (optionnel si pas de login) | |||
|align='center'| | |align='center'| | ||
POST | |||
|| | || | ||
Monte le partage SMB/CIFS sur le système | |||
|| | || | ||
*200 : si | *200 : si le montage réussie | ||
*400 : si | *400 : si le montage échoue | ||
|| | || | ||
[[Fichier:implemented_red_cross.png|center|40px]] | [[Fichier:implemented_red_cross.png|center|40px]] | ||
|- | |- | ||
|| | || | ||
/api/ | /api/device/$$UUID$$ | ||
*$$ | *$$UUID$$ : un UUID de périphérique | ||
|| | || | ||
|align='center'| | |align='center'| | ||
DELETE | DELETE | ||
|| | || | ||
Démonte le périphérique du système | |||
|| | || | ||
*200 : si | *200 : si le démontage réussie | ||
*400 : si | *400 : si le démontage échoue | ||
|| | || | ||
[[Fichier:implemented_green_tick.png|center|40px]] | [[Fichier:implemented_green_tick.png|center|40px]] | ||
|- | |||
|| | |||
/api/device/smb/$$SERVER$$ | |||
*$$SERVER$$ : un nom d'hôte ou une adresse IP de serveur SMB/CIFS | |||
|| | |||
* share: le nom du partage SMB/CIFS | |||
|align='center'| | |||
DELETE | |||
|| | |||
Démonte le partage SMB/CIFS du système | |||
|| | |||
*200 : si le démontage réussie | |||
*400 : si le démontage échoue | |||
|| | |||
[[Fichier:implemented_red_cross.png|center|40px]] | |||
|} | |} | ||
Version du 24 juin 2018 à 16:52
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$$[/$$EXTENSION$$]
|
|
GET |
Retourne un tableau avec la liste récursive des fichiers |
|
|
|
/api/device/explore/$$UUID$$[/$$EXTENSION$$]
|
|
GET |
Retourne un tableau avec la liste des fichiers |
|
|
|
/api/device/smb/$$SERVER$$
|
|
GET |
Retourne un tableau avec la liste des partages SMB/CIFS présent sur l'hôte |
|
|
|
/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/smb/$$SERVER$$
|
|
POST |
Monte le partage SMB/CIFS sur le système |
|
|
|
/api/device/$$UUID$$
|
DELETE |
Démonte le périphérique du système |
|
||
|
/api/device/smb/$$SERVER$$
|
|
DELETE |
Démonte le partage SMB/CIFS du système |
|