Différences entre les versions de « Music sender api »

De mydil
Aller à la navigation Aller à la recherche
Ligne 600 : Ligne 600 :
 
|}
 
|}
 
==Device==
 
==Device==
L'objet device est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
+
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 objets device
+
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 id de device
+
*$$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 id de device
+
*$$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/image
+
/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
 
||
 
||
*content : le contenu du fichier image
 
 
|align='center'|
 
|align='center'|
 
POST
 
POST
 
||
 
||
Créé un nouvel objet image
+
Monte le périphérique sur le système
 
||
 
||
*200 : si la création réussie
+
*200 : si le montage réussie
*400 : si la création échoue
+
*400 : si le montage échoue
 
||
 
||
[[Fichier:implemented_red_cross.png|center|40px]]
+
[[Fichier:implemented_green_tick.png|center|40px]]
 
|-
 
|-
 
||
 
||
/api/image/$$ID$$
+
/api/device/smb/$$SERVER$$
*$$ID$$ : un id d'image
+
*$$SERVER$$ : un nom d'hôte ou une adresse IP de serveur SMB/CIFS
 
||
 
||
*content : le contenu du fichier image
+
* 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'|
PUT
+
POST
 
||
 
||
Modifie l'image
+
Monte le partage SMB/CIFS sur le système
 
||
 
||
*200 : si la modification réussie
+
*200 : si le montage réussie
*400 : si la modification échoue
+
*400 : si le montage échoue
 
||
 
||
 
[[Fichier:implemented_red_cross.png|center|40px]]
 
[[Fichier:implemented_red_cross.png|center|40px]]
 
|-
 
|-
 
||
 
||
/api/image/$$ID$$
+
/api/device/$$UUID$$
*$$ID$$ : un id de genre
+
*$$UUID$$ : un UUID de périphérique
 
||
 
||
*vide
 
 
|align='center'|
 
|align='center'|
 
DELETE
 
DELETE
 
||
 
||
Efface l'image
+
Démonte le périphérique du système
 
||
 
||
*200 : si l'effacement réussie
+
*200 : si le démontage réussie
*400 : si l'effacement échoue
+
*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

  • vide

GET

Retourne un tableau avec tous les objets utilisateur

  • 200 : si l'objet existe
  • 400 : si une erreur survient
Implemented green tick.png

/api/user/$$ID$$

  • $$ID$$ : un identifiant utilisateur
  • vide

GET

Retourne un objet utilisateur

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
  • 400 : si une erreur survient
Implemented green tick.png

/api/user/

  • pseudo : le pseudo de l'utilisateur
  • email : le mail de l'utilisateur
  • password : le mot de passe de l'utilisateur
  • image : l'identifiant de l'image

POST

Crée un nouvel utilisateur et renvoie son identifiant

  • 201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
  • 400 : si la création échoue
Implemented green tick.png

/api/user/email/$$ID$$

  • $$ID$$ : un identifiant utilisateur
  • email : le mail de l'utilisateur

PUT

Modifie l'email du compte

  • 200 : si la modification réussie
  • 400 : si une erreur survient
  • 404 : si l'utilisateur n'existe pas
Implemented green tick.png

/api/user/password/$$ID$$

  • $$ID$$ : un identifiant utilisateur
  • password : le nouveau mot de passe utilisateur

PUT

Modifie le mot de passe du compte

  • 200 : si la modification réussie
  • 400 : si une erreur survient
  • 404 : si l'utilisateur n'existe pas
Implemented green tick.png

/api/user/$$ID$$

  • $$ID$$ : un id de d'artiste
  • vide

DELETE

Efface l'utilisateur

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
  • 400 : si une erreur survient
Implemented red cross.png

Genre

L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}

URL Corps Verbe Action Code retour Implémentée

/api/genre

  • vide

GET

Retourne un tableau avec tous les objets genre

  • 200 : si l'objet existe
Implemented green tick.png

/api/genre/$$ID$$

  • $$ID$$ : un id de genre
  • vide

GET

Retourne un objet genre

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
Implemented green tick.png

/api/genre/like/$$EXPR$$

  • $$EXPR$$ : une expression contenu dans un genre
  • vide

GET

Retourne un tableau d'objets genre

  • 200
Implemented green tick.png

/api/genre

  • genre : le nom du genre

POST

Créé un nouvel objet genre

  • 201 : si la création réussie
  • 400 : si la création échoue
Implemented green tick.png

/api/genre/$$ID$$

  • $$ID$$ : un id de genre
  • genre : le nom du genre

PUT

Modifie le nom du genre

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented green tick.png

/api/genre/$$ID$$

  • $$ID$$ : un id de genre
  • vide

DELETE

Efface le genre

  • 200 : si l'effacement réussie
  • 400 : si l'effacement échoue
Implemented green tick.png

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

  • vide

GET

Retourne un tableau avec tous les objets artiste

  • 200 : si l'objet existe
Implemented green tick.png

/api/artist/$$ID$$

  • $$ID$$ : un id d'artiste
  • vide

GET

Retourne un objet artiste

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
Implemented green tick.png

/api/artist/like/$$EXPR$$

  • $$EXPR$$ : une expression contenu dans un nom d'artiste
  • vide

GET

Retourne un tableau d'objets artiste

  • 200
Implemented green tick.png

/api/artist

  • name : le nom de l'artist
  • image : l'identifiant d'une image (optionnel)

POST

Créé un nouvel objet artiste

  • 201 : si la création réussie
  • 400 : si la création échoue
Implemented green tick.png

/api/artist/name/$$ID$$

  • $$ID$$ : un id d'artiste
  • name: le nom de l’artiste

PUT

Modifie le nom de l'artiste

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented green tick.png

/api/artist/image/$$ID$$

  • $$ID$$ : un id d'artiste
  • image: l'identifiant de l'image

PUT

Modifie l'image de l'artiste

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented green tick.png

/api/genre/$$ID$$

  • $$ID$$ : un id d'artiste
  • vide

DELETE

Efface l'artiste

  • 200 : si l'effacement réussie
  • 400 : si l'effacement échoue
Implemented green tick.png

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

  • vide

GET

Retourne un tableau avec tous les objets album

  • 200
Implemented green tick.png

/api/album/$$ID$$

  • $$ID$$ : un id d'album
  • vide

GET

Retourne un objet album

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
Implemented green tick.png

/api/album/artist/$$ID$$

  • $$ID$$ : l'identifiant d'un artiste
  • vide

GET

Retourne un tableau d'objets album

  • 200
Implemented green tick.png

/api/album/genre/$$ID$$

  • $$ID$$ : l'identifiant d'un genre
  • vide

GET

Retourne un tableau d'objets album

  • 200
Implemented green tick.png

/api/album/like/$$EXPR$$

  • $$EXPR$$ : une expression contenu dans un nom d'album
  • vide

GET

Retourne un tableau d'objets album

  • 200
Implemented green tick.png

/api/album

  • name : le nom de l'album
  • image : l'identifiant d'une image (optionnel)

POST

Créé un nouvel objet album

  • 201 : si la création réussie
  • 400 : si la création échoue
Implemented green tick.png

/api/album/name/$$ID$$

  • $$ID$$ : un id d'album
  • name: le nom de l’album

PUT

Modifie le nom de l'album

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented green tick.png

/api/album/image/$$ID$$

  • $$ID$$ : un id d'album
  • image: l'identifiant de l'image

PUT

Modifie l'image de l'album

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented green tick.png

/api/genre/$$ID$$

  • $$ID$$ : un id d'album
  • vide

DELETE

Efface l'album

  • 200 : si l'effacement réussie
  • 400 : si l'effacement échoue
Implemented green tick.png

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$$

  • $$ID$$ : un identifiant de musique
  • vide

GET

Retourne un objet musique au format Json

  • 200 : si l'objet existe;
  • 400 : si une erreur survient;
Implemented green tick.png

/api/music/content/$$ID$$

  • $$ID$$ : un identifiant de musique
  • vide

GET

Retourne le contenu de la musique (fichier son)

  • 200 : si l'objet existe;
  • 400 : si une erreur survient;
Implemented green tick.png

/api/music/album/$$ID$$

  • $$ID$$ : un id d'album
  • vide

GET

Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant

  • 200 : si l'objet existe;
  • 400 : si une erreur survient;
Implemented green tick.png

/api/music/artist/$$ID$$

  • $$ID$$ : un id d'artiste
  • vide

GET

Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant

  • 200 : si l'objet existe;
  • 400 : si une erreur survient;
Implemented green tick.png

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

  • vide

GET

Retourne un tableau avec tous les objets image

  • 200
Implemented green tick.png

/api/image/info/$$ID$$

  • $$ID$$ : un id d'image
  • vide

GET

Retourne un objet image

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
Implemented green tick.png

/api/image/content/$$ID$$

  • $$ID$$ : un id d'image
  • vide

GET

Retourne le contenu du fichier avec le type mime en entête

  • 200 : si l'objet existe
  • 404 : si l'objet n'existe pas
Implemented green tick.png

/api/image

  • content : le contenu du fichier image

POST

Créé un nouvel objet image

  • 200 : si la création réussie
  • 400 : si la création échoue
Implemented red cross.png

/api/image/$$ID$$

  • $$ID$$ : un id d'image
  • content : le contenu du fichier image

PUT

Modifie l'image

  • 200 : si la modification réussie
  • 400 : si la modification échoue
Implemented red cross.png

/api/image/$$ID$$

  • $$ID$$ : un id de genre
  • vide

DELETE

Efface l'image

  • 200 : si l'effacement réussie
  • 400 : si l'effacement échoue
Implemented green tick.png

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

  • vide

GET

Retourne un tableau avec tous les périphériques

  • 200
Implemented green tick.png

/api/device/list/$$UUID$$[/$$EXTENSION$$]

  • $$UUID$$ : un UUID de périphérique
  • $$EXTENSION$$ : un filtre par extension de fichier (optionnel)
  • vide

GET

Retourne un tableau avec la liste récursive des fichiers

  • 200 : si l'UUID existe
  • 400 : si l'UUID n'existe pas
Implemented green tick.png

/api/device/explore/$$UUID$$[/$$EXTENSION$$]

  • $$UUID$$ : un UUID de périphérique
  • $$EXTENSION$$ : un filtre par extension de fichier (optionnel)
  • vide

GET

Retourne un tableau avec la liste des fichiers

  • 200 : si l'UUID existe
  • 400 : si l'UUID n'existe pas
Implemented green tick.png

/api/device/smb/$$SERVER$$

  • $$SERVER$$ : un nom d'hôte ou une adresse IP de serveur SMB/CIFS
  • vide

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
Implemented green tick.png

/api/device/mounted

  • vide

GET

Retourne un tableau avec la liste des périphériques montés

  • 200 : si aucune erreur
  • 400 : si une erreur survient
Implemented green tick.png

/api/device/umounted

  • vide

GET

Retourne un tableau avec la liste des périphériques démontés

  • 200 : si aucune erreur
  • 400 : si une erreur survient
Implemented green tick.png

/api/device/$$UUID$$

  • $$UUID$$ : un UUID de périphérique

POST

Monte le périphérique sur le système

  • 200 : si le montage réussie
  • 400 : si le montage échoue
Implemented green tick.png

/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)

POST

Monte le partage SMB/CIFS sur le système

  • 200 : si le montage réussie
  • 400 : si le montage échoue
Implemented red cross.png

/api/device/$$UUID$$

  • $$UUID$$ : un UUID de périphérique

DELETE

Démonte le périphérique du système

  • 200 : si le démontage réussie
  • 400 : si le démontage échoue
Implemented green tick.png

/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

DELETE

Démonte le partage SMB/CIFS du système

  • 200 : si le démontage réussie
  • 400 : si le démontage échoue
Implemented red cross.png