Différences entre les versions de « Music sender api »
(→Music) |
(→User) |
||
| Ligne 1 : | Ligne 1 : | ||
==User== | ==User== | ||
| + | ==Music== | ||
| + | L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com"} | ||
| + | {|class="wikitable" width="100%" | ||
| + | |-valign=top | ||
| + | ! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée | ||
| + | |- | ||
| + | || | ||
| + | /api/user/$$ID$$ | ||
| + | * $$ID$$ : un identifiant utilisateur | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | GET | ||
| + | || | ||
| + | Retourne un objet utilisateur au format Json | ||
| + | || | ||
| + | *200 : si l'objet existe | ||
| + | *404 : si l'objet n'existe pas | ||
| + | *400 : si une erreur survient | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /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 | ||
| + | |align='center'| | ||
| + | POST | ||
| + | || | ||
| + | Créer un nouvel utilisateur et renvoie son identifiant | ||
| + | || | ||
| + | *200 : si l'objet existe | ||
| + | *400 : si une erreur survient | ||
| + | *500 : si la création échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/user/email/$$ID$$ | ||
| + | * $$ID$$ : un identifiant utilisateur | ||
| + | || | ||
| + | * email : le mail de l'utilisateur | ||
| + | |align='center'| | ||
| + | PUT | ||
| + | || | ||
| + | Modifie l'email du compte | ||
| + | || | ||
| + | *200 : si la modification réussie; | ||
| + | *400 : si une erreur survient; | ||
| + | *404 : si l'utilisateur n'existe pas; | ||
| + | *500 : si la modification échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/user/password/$$ID$$ | ||
| + | * $$ID$$ : un identifiant utilisateur | ||
| + | || | ||
| + | * password : le nouveau mot de passe utilisateur | ||
| + | |align='center'| | ||
| + | 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; | ||
| + | *500 : si la modification échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/user/$$ID$$ | ||
| + | *$$ID$$ : un id de d'artiste | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | DELETE | ||
| + | || | ||
| + | Efface l'utilisateur | ||
| + | || | ||
| + | *200 : si l'objet existe; | ||
| + | *404 : si l'objet n'existe pas; | ||
| + | *400 : si une erreur survient; | ||
| + | || | ||
| + | [[Fichier:implemented_red_cross.png|center|40px]] | ||
| + | |} | ||
==Album== | ==Album== | ||
Version du 18 juin 2018 à 21:45
User
Music
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com"}
| URL | Corps | Verbe | Action | Code retour | Implémentée |
|---|---|---|---|---|---|
|
/api/user/$$ID$$
|
|
GET |
Retourne un objet utilisateur au format Json |
|
|
|
/api/user/ |
|
POST |
Créer 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 |
|
Album
Genre
Artist
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 | Verbe | Action | Code retour |
|---|---|---|---|
|
/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 |
|