Skip to main content

​
GET (/users/xuid(xuid)/lists/PINS/)

Retourne le contenu d’une liste. Le domaine de ces URI est eplists.xboxlive.com.

​
Remarques

Le champ listCount des données retournées indique le nombre total d’éléments de la liste gérée par le service. Il peut donc servir à déterminer où se trouve la fin de la liste, et ce nombre peut différer du nombre d’éléments précis retournés par la requête. Si la liste n’existe pas encore, les résultats ne contiennent aucun élément de liste, et listCount et listVersion valent zéro.

​
Paramètres d’URI

​
Paramètres de la chaîne de requête

| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | skipItems| entier signé 32 bits| Facultatif. Nombre d’éléments à ignorer dans l’énumération avant de retourner les résultats. Valeur par défaut : 0.| | maxItems| entier signé 32 bits| Facultatif. Nombre maximal d’éléments à retourner. La valeur par défaut est de 25 éléments si aucun maximum n’est spécifié dans la requête. Le service n’impose pas de maximum à cette valeur; si la valeur est supérieure au nombre d’éléments de la liste, tous les éléments sont retournés sans erreur.| | filterItemId| chaîne| Facultatif. Indique l’élément à rechercher dans la liste. Retourne toutes les instances de l’élément dans la liste. Permet au client de déterminer rapidement si un élément se trouve dans une liste et à quel endroit. Pratique pour les grandes listes afin de déterminer toutes les instances d’un élément sans parcourir la liste entière. Valeur par défaut : null.| | filterContentType| chaîne| Facultatif. Indique une liste de types de contenu séparés par des virgules à retourner (les types absents de la liste ne sont pas retournés). Sert à obtenir uniquement certains types de contenu d’une liste. Une liste de types de contenu séparés par des virgules est utilisée pour ce filtre. (Plusieurs types de contenu peuvent être interrogés en un seul appel.) Les types de contenu pris en charge comprennent tous les types de médias définis par Entertainment Discovery Services (EDS). Valeur par défaut : null (tous les types de contenu).| | filterDeviceType| chaîne| Facultatif. Indique une liste de types d’appareils séparés par des virgules à retourner (les types absents de la liste ne sont pas retournés). Filtre l’ensemble retourné pour ne retourner que les éléments insérés à partir d’un ensemble précis de types d’appareils. Une liste de types d’appareils séparés par des virgules est utilisée pour ce filtre (plusieurs types d’appareils peuvent être interrogés en un seul appel). Valeurs possibles : XboxOne, MCapensis, WindowsPhone, WindowsPhone7, Web, PC, MoLive. Valeur par défaut : null (tous les types de contenu).|

​
Autorisation

Cet appel attend un jeton SAML XSTS dans l’en-tête Authorization. Une revendication Xuid doit exister dans ce jeton SAML pour identifier l’appelant. Cette valeur sert à déterminer si l’appelant dispose des droits d’accès aux données de la liste en question. La liste elle-même est également identifiée par le Xuid, qui est inclus dans l’URI de la liste. Grâce à cela, nous pourrions à l’avenir prendre en charge l’accès partagé aux listes, mais cette fonctionnalité n’est pas offerte pour le moment. Actuellement, toutes les listes auxquelles un utilisateur accède lui appartiennent et il n’y a pas d’accès partagé. Ainsi, le Xuid de l’URI doit correspondre au Xuid du jeton de revendications SAML.
Remarque :
Les jetons XBL Auth 2.0 et 3.0 sont tous deux pris en charge actuellement.

​
En-têtes de requête obligatoires

| En-tête| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| Contient le jeton STS utilisé pour authentifier et autoriser la requête. Doit être un jeton du service XSTS et inclure le XUID parmi les revendications.| | X-XBL-Contract-Version| Indique la version de l’API demandée (entiers positifs). Pins prend en charge la version 2. Si cet en-tête est absent ou si la valeur n’est pas prise en charge, le service retourne un code 400 - Bad request avec « Unsupported or missing contract version header » dans la description de l’état.| | Content-Type| Indique si le contenu des corps de requête et de réponse sera en JSON ou en XML. Les valeurs prises en charge sont « application/json » et « application/xml »| | If-Match| Cet en-tête doit contenir le numéro de version actuel d’une liste lors des requêtes de modification. Les requêtes de modification utilisent les verbes PUT, POST ou DELETE. Si la version de l’en-tête « If-Match » ne correspond pas à la version actuelle de la liste, la requête est rejetée avec le code de retour HTTP 412 - precondition failed. (facultatif) Peut aussi être utilisé pour les GET : s’il est présent et que la version transmise correspond à la version actuelle de la liste, aucune donnée de liste n’est retournée et le code HTTP 304 - Not Modified est retourné.|

​
Corps de la requête

Aucun objet n’est envoyé dans le corps de cette requête.

​
Codes d’état HTTP

Le service retourne l’un des codes d’état de cette section en réponse à une requête effectuée avec cette méthode sur cette ressource. Pour obtenir la liste complète des codes d’état HTTP standard utilisés avec les services XBOX Live, consultez Codes d’état HTTP standard. | Code| Phrase de motif| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| La requête s’est terminée avec succès. Le corps de la réponse doit contenir la ressource demandée (pour un GET). Les requêtes POST et PUT reçoivent les métadonnées à jour de la liste (version de la liste, nombre, etc.).| | 201| Created| Une nouvelle liste a été créée. Ce code est retourné lors de la première insertion dans une liste. La réponse comprend les métadonnées à jour de la liste et l’en-tête location contient l’URI de la liste.| | 304| Not Modified| Retourné pour les GET. Indique que le client possède la dernière version de la liste. Le service compare la valeur de l’en-tête If-Match à la version de la liste. Si elles sont égales, un code 304 est retourné sans données.| | 400| Bad Request| La requête était mal formée. Il peut s’agir d’une valeur ou d’un type non valide pour un paramètre d’URI ou de chaîne de requête. Cela peut aussi résulter d’un paramètre ou d’une valeur de données obligatoire manquant, ou d’une version de l’API manquante ou non valide indiquée dans la requête. Consultez l’en-tête X-XBL-Contract-Version.| | 401| Unauthorized| La requête nécessite l’authentification de l’utilisateur.| | 403| Forbidden| La requête n’est pas autorisée pour l’utilisateur ou le service.| | 404| Not Found| L’appelant n’a pas accès à la ressource. Cela indique qu’aucune liste de ce type n’a été créée.| | 412| Precondition Failed| Indique que la version de la liste a changé et qu’une requête de modification a échoué. Une requête de modification est une insertion, une mise à jour ou une suppression. Le service vérifie la version de la liste dans l’en-tête If-Match. Si elle ne correspond pas à la version actuelle de la liste, l’opération échoue et ce code est retourné avec les métadonnées actuelles de la liste (qui incluent la version actuelle).| | 500| Internal Server Error| Le service refuse la requête en raison d’une erreur côté serveur.| | 501| Not Implemented| L’appelant a demandé un URI qui n’a pas été implémenté sur le serveur. (Actuellement utilisé uniquement lorsqu’une requête porte sur un nom de liste qui ne figure pas dans la liste d’autorisation.)| | 503| Service Unavailable| Le serveur refuse la requête, généralement en raison d’une charge excessive. Après un délai (consultez l’en-tête Retry-after), la requête peut être réessayée.|

​
Corps de la réponse

​
Exemple de réponse

​
Voir aussi

Parent
/users/xuid(xuid)/lists/PINS/
Informations supplémentaires
URI du Marketplace Référence supplémentaire
Last modified on October 6, 2026