Lire les amis d'un utilisateur

Lire les amis d'un utilisateurClient-side

get/users/me/relationships

Récupère la liste des utilisateurs ajoutés en tant qu'amis de l'utilisateur authentifié.

SecurityBearer or APIKey

Request

query Parameters

type required	string Type d'amis. Valeurs possibles : `friends` : pour obtenir la liste des utilisateurs ajoutés à la liste d'amis. `friend_requested` : pour obtenir la liste des utilisateurs qui ont reçu une demande d'ami. `friend_requested_by` : pour obtenir la liste des utilisateurs qui ont envoyé une demande d'ami. `blocked` : pour obtenir la liste des utilisateurs ajoutés à la liste d'amis, mais bloqués. `blocked_by` : pour obtenir la liste des utilisateurs qui ont bloqué cet utilisateur. Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by required	string Condition de tri des utilisateurs. Valeurs possibles : `by_nickname` : pour trier la liste par ordre alphabétique de pseudo. `by_updated` : pour trier la liste par la date à laquelle les utilisateurs ont récemment ajouté quelqu'un à leur liste d'amis ou l'ont bloqué. Enum: "by_nickname" "by_updated"
sort_order required	string Condition de tri de la liste des utilisateurs. Valeurs possibles : `asc` : pour appliquer la valeur `sort_by` dans l'ordre croissant. `desc` : pour appliquer la valeur `sort_by` dans l'ordre décroissant. Enum: "asc" "desc"
after	string Paramètre utilisé pour la pagination de l'API.
limit	integer [ 1 .. 50 ] Default: 20 Nombre maximum d'utilisateurs renvoyés à la fois.

Responses

200

400

Bad Request

401

Forbidden

403

Forbidden

404

Not Found

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/users/me/relationships?after=SOME_STRING_VALUE&limit=20&type=SOME_STRING_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer BEARER_TOKEN'

Response samples

application/json

{"next_after": "string",
"next_url": "string",
"relationships": [{"next_after": "bmFtZS0ydXNlci0y",
"next_url": "https://login.xsolla.com/api/users/by_access_key/access-key-1/relationships?type=friend_requests&sort_by=by_name&limit=2&after=bmFtZS0ydXNlci0y",
"relationships": [{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499214.3501,
"user": {"id": "user-3",
"name": "name-3",
"nickname": "nick-2",
"picture": "",
"tag": "423432"
}
},
{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499213.4718,
"user": {"id": "user-2",
"name": "name-2",
"nickname": "nick-2",
"picture": "",
"tag": "3100"
}
}
]
}
]
}