Différences entre les versions de « Music sender api »
(→Music) |
(→Image) |
||
| Ligne 507 : | Ligne 507 : | ||
|} | |} | ||
==Image== | ==Image== | ||
| + | L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} } | ||
| + | {|class="wikitable" width="100%" | ||
| + | |-valign=top | ||
| + | ! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée | ||
| + | |- | ||
| + | || | ||
| + | /api/images | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | GET | ||
| + | || | ||
| + | Retourne un tableau avec tous les objets image | ||
| + | || | ||
| + | *200 | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/image/info/$$ID$$ | ||
| + | *$$ID$$ : un id d'image | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | GET | ||
| + | || | ||
| + | Retourne un objet image | ||
| + | || | ||
| + | *200 : si l'objet existe | ||
| + | *404 : si l'objet n'existe pas | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/image/content/$$ID$$ | ||
| + | *$$ID$$ : un id d'image | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | 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 | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/image | ||
| + | || | ||
| + | *content : le contenu du fichier image | ||
| + | |align='center'| | ||
| + | POST | ||
| + | || | ||
| + | Créé un nouvel objet image | ||
| + | || | ||
| + | *200 : si la création réussie | ||
| + | *400 : si la création échoue | ||
| + | || | ||
| + | [[Fichier:implemented_red_cross.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/image/$$ID$$ | ||
| + | *$$ID$$ : un id d'image | ||
| + | || | ||
| + | *content : le contenu du fichier image | ||
| + | |align='center'| | ||
| + | PUT | ||
| + | || | ||
| + | Modifie l'image | ||
| + | || | ||
| + | *200 : si la modification réussie | ||
| + | *400 : si la modification échoue | ||
| + | || | ||
| + | [[Fichier:implemented_red_cross.png|center|40px]] | ||
| + | |- | ||
| + | || | ||
| + | /api/image/$$ID$$ | ||
| + | *$$ID$$ : un id de genre | ||
| + | || | ||
| + | *vide | ||
| + | |align='center'| | ||
| + | DELETE | ||
| + | || | ||
| + | Efface l'image | ||
| + | || | ||
| + | *200 : si l'effacement réussie | ||
| + | *400 : si l'effacement échoue | ||
| + | || | ||
| + | [[Fichier:implemented_green_tick.png|center|40px]] | ||
| + | |} | ||
Version du 21 juin 2018 à 09:25
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 |
|