« Music sender api » : différence entre les versions

De mydil
Aller à la navigation Aller à la recherche
Ligne 304 : Ligne 304 :


==Album==
==Album==
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
{|class="wikitable" width="100%"
|-valign=top
|-valign=top
Ligne 310 : Ligne 310 :
|-
|-
||
||
/api/artist
/api/album
||
||
*vide
*vide
Ligne 316 : Ligne 316 :
GET
GET
||
||
Retourne un tableau avec tous les objets artiste
Retourne un tableau avec tous les objets album
||
||
*200 : si l'objet existe
*200
||
||
[[Fichier:implemented_green_tick.png|center|40px]]
[[Fichier:implemented_green_tick.png|center|40px]]
|-
|-
||
||
/api/artist/$$ID$$
/api/album/$$ID$$
*$$ID$$ : un id d'artiste
*$$ID$$ : un id d'album
||
||
*vide
*vide
Ligne 330 : Ligne 330 :
GET
GET
||
||
Retourne un objet artiste
Retourne un objet album
||
||
*200 : si l'objet existe
*200 : si l'objet existe
Ligne 338 : Ligne 338 :
|-
|-
||
||
/api/artist/like/$$EXPR$$
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
*$$EXPR$$ : une expression contenu dans un nom d'album
||
||
*vide
*vide
Ligne 345 : Ligne 345 :
GET
GET
||
||
Retourne un tableau d'objets artiste
Retourne un tableau d'objets album
||
||
*200
*200
Ligne 352 : Ligne 352 :
|-
|-
||
||
/api/artist
/api/album
||
||
*name : le nom de l'artist
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
*image : l'identifiant d'une image (optionnel)
|align='center'|
|align='center'|
POST
POST
||
||
Créé un nouvel objet artiste
Créé un nouvel objet album
||
||
*200 : si la création réussie
*200 : si la création réussie
Ligne 367 : Ligne 367 :
|-
|-
||
||
/api/artist/name/$$ID$$
/api/album/name/$$ID$$
*$$ID$$ : un id d'artiste
*$$ID$$ : un id d'album
||
||
*name: le nom de l’artiste
*name: le nom de l’album
|align='center'|
|align='center'|
PUT
PUT
||
||
Modifie le nom de l'artiste
Modifie le nom de l'album
||
||
*200 : si la modification réussie
*200 : si la modification réussie
Ligne 382 : Ligne 382 :
|-
|-
||
||
/api/artist/image/$$ID$$
/api/album/image/$$ID$$
*$$ID$$ : un id d'artiste
*$$ID$$ : un id d'album
||
||
*image: l'identifiant de l'image
*image: l'identifiant de l'image
Ligne 389 : Ligne 389 :
PUT
PUT
||
||
Modifie l'image de l'artiste
Modifie l'image de l'album
||
||
*200 : si la modification réussie
*200 : si la modification réussie

Version du 19 juin 2018 à 14:40

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

  • 200 : 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

  • 200 : 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

  • 200 : 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/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

  • 200 : 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