Demandes de suivi

GET /api/follow-requests

Obtenir les demandes de suivi à valider, reçues par l’utilisateur authentifié.

Scope : follow:read

Exemple de requêtes :

  • sans paramètres

GET /api/follow-requests/ HTTP/1.1

  • avec quelques paramètres de requête

GET /api/follow-requests?page=1&order=desc  HTTP/1.1

Exemple de réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "follow_requests": [
      {
        "admin": false,
        "bio": null,
        "birth_date": null,
        "created_at": "Thu, 02 Dec 2021 17:50:48 GMT",
        "first_name": null,
        "followers": 1,
        "following": 1,
        "last_name": null,
        "location": null,
        "nb_sports": 0,
        "nb_workouts": 0,
        "picture": false,
        "records": [],
        "sports_list": [],
        "total_distance": 0.0,
        "total_duration": "0:00:00",
        "username": "Sam"
      }
    ]
  },
  "pagination": {
    "has_next": false,
    "has_prev": false,
    "page": 1,
    "pages": 1,
    "total": 1
  },
  "status": "success"
}
Paramètres de requête:

  • page (integer) – page si pagination (par défaut : 1)

  • per_page (integer) – nombre de demande de suivi par page (par défaut : 10, max : 50)

  • order (string) – ordre de tri (par défaut : asc)

En-têtes de requête:
Codes d’état:
POST /api/follow-requests/(user_name)/accept

Accepter la demande de suivi d’un utilisateur

Scope : follow:write

Exemple de requêtes :

POST /api/follow-requests/Sam/accept HTTP/1.1

Exemple de réponses :

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "message": "Follow request from user 'Sam' is accepted.",
}
Paramètres:

  • user_name (string) – nom de l’utilisateur

En-têtes de requête:
Codes d’état:

  • 200 OK – succès

  • 401 Unauthorized –

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again

  • 400 Bad Request –

    • Follow request from user 'user_name' already accepted.

  • 403 Forbidden –

    • you do not have permissions, your account is suspended

  • 404 Not Found –

    • user does not exist

    • Follow request does not exist.

POST /api/follow-requests/(user_name)/reject

Rejeter la demande de suivi d’un utilisateur.

Scope : follow:write

Exemple de requêtes :

POST /api/follow-requests/Sam/reject HTTP/1.1

Exemple de réponses :

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "message": "Follow request from user 'Sam' is rejected.",
}
Paramètres:

  • user_name (string) – nom de l’utilisateur

En-têtes de requête:
Codes d’état:

  • 200 OK – succès

  • 401 Unauthorized –

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again

  • 400 Bad Request –

    • Follow request from user 'user_name' already rejected.

  • 403 Forbidden –

    • you do not have permissions, your account is suspended

  • 404 Not Found –

    • user does not exist

    • Follow request does not exist.