Skip to content
This repository has been archived by the owner on Sep 10, 2020. It is now read-only.

2.5 Utilisateurs

Vincent Séguin edited this page Oct 10, 2019 · 13 revisions

GET /users

Permet de lister tous les utilisateurs enregistrés dans le service UBeat

Entrée

Token d'authentification nécessaire

Aucun paramètres

Sortie

Retourne la liste de tous les utilisateurs

[
    {
        "email": "john.smith@mail.com",
        "name": "John Smith",
        "id": "53ec122d27aafe77d8c37b8"
    }
]

GET /users/:id

Permet d'afficher l'utilisateur à l'id demandé ainsi que ses amis.

Entrée

Token d'authentification nécessaire

Aucun paramètres

Sortie

Retourne l'utilisateur et ses amis

{
    "email": "john.smith@mail.com",
    "name": "John Smith",
    "id": "53ec122d27aafe77d8c37b8",
    "following": [{
            "id": "53ec12122121afe77d8c37b8",
            "name": "Walter White",
            "email": "walter.white@mail.com"
    }]
}

GET /search/users

Permet de trouver un utilisateur par son nom ou une partie de son nom

Entrée

Token d'authentification nécessaire

Paramètres obligatoires

q est le paramètre de recherche dans l'URL. Par exemple pour rechercher pour l'utilisateur John Smith l'URL sera /search/users?q=John%20Smith.

La requête doit être URL encodée (Comment URL encoder en JavaScript)

Sortie

Retourne une liste d'utilisateurs correspondants à la requête.

[
    {
        "email": "john.smith@mail.com",
        "name": "John Smith",
        "id": "53ec122d27aafe77d8c37b8"
    }
]

POST /follow

Permet de suivre un utilisateur.

Entrée body

Le content-type doit être application/json

id: String

id est l'id de l'utilisateur que vous désirer suivre.

Token d'authentification nécessaire

Sortie

Retourne une liste d'utilisateurs correspondants à la requête.

[
    {
        "email": "john.smith@mail.com",
        "name": "John Smith",
        "id": "53ec122d27aafe77d8c37b8",
        "following": [{
             "id": "53ec12122121afe77d8c37b8",
             "name": "Walter White",
             "email": "walter.white@mail.com"
        }]
    }
]

DELETE /follow/:id

Permet d'arrêter de suivre un utilisateur.

Entrée url

Remplacer :id par l'id de l'utilisateur que vous désirer arrêter de suivre.

Token d'authentification nécessaire

Sortie
[
    {
        "email": "john.smith@mail.com",
        "name": "John Smith",
        "id": "53ec122d27aafe77d8c37b8",
        "following": []
    }
]

GET /users/:id/playlists

Permet de lister toutes les playlists d'un usager

Entrée

Token d'authentification nécessaire

Aucun paramètres

Sortie

Retourne la liste de toutes les playlists d'un usager

[{
    "tracks": [],
    "owner": {
        "email": "name@mail.com",
        "name": "username",
        "id": "5678"
    },
    "id": "1234"
}, {
 ...
}]