Passer au contenu principal

​
POST /users/xuid(xuid)/lists/PINS//index()?insertIndex=

Déplace un élément d’une liste vers une autre position dans la liste. Le domaine de ces URI est eplists.xboxlive.com.

​
Remarques

Cet appel permet au client de déplacer facilement un élément vers un autre index de la liste en une seule opération. Un seul élément peut être déplacé à la fois. Si l’index de l’élément à déplacer n’existe pas, un code HTTP 400 est retourné. L’index du point d’insertion suit les mêmes règles qu’une insertion standard. Sa valeur par défaut est 0 (le début de la liste), et tout nombre supérieur au nombre d’éléments de la liste réinsère l’élément à la fin de la liste. De même, la fin de la liste peut être indiquée en transmettant “end” pour insertIndex. Cet appel vous permet également d’identifier l’élément à déplacer par son itemId (ou par la combinaison provider/providerId). Dans ce cas, l’itemId doit être transmis dans le corps de la requête et doit correspondre à un élément existant de la liste. Sinon, une erreur HTTP 400 est retournée avec IndexOutOfRange dans la description ; pour cette version spéciale de l’appel, utilisez “-1” comme index de l’élément à déplacer. Cet appel exige qu’un en-tête “If-Match:versionNumber” soit inclus dans la requête si l’élément est spécifié par son index. Si vous utilisez l’itemId pour indiquer l’élément à déplacer, l’en-tête “If-Match” est facultatif. S’il est présent, l’en-tête “If-Match” est toujours validé. Dans l’en-tête “if-Match”, versionNumber est le numéro de version actuel de la liste. S’il n’est pas inclus (alors qu’il est obligatoire) ou s’il ne correspond pas au numéro de version actuel de la liste, un code d’état HTTP 412 - precondition failed est retourné, et le corps de la réponse contient les dernières métadonnées de la liste, qui incluent le numéro de version actuel. Cela permet d’éviter que des mises à jour provenant de différents clients ne s’écrasent mutuellement.

​
Paramètres d’URI

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

| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | insertIndex| string| Spécifie l’emplacement de la liste où insérer l’élément. Les valeurs autorisées sont zéro, les entiers positifs et “end”. “end” place l’élément à la fin de la liste actuelle. Si la valeur spécifiée se situe au-delà de la fin de la liste, l’élément est inséré à la fin de la liste.|

​
Corps de la requête

Un corps de requête est envoyé uniquement lorsque l’élément à déplacer est spécifié par itemId ou par Provider/ProviderId. Exemple de 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 XBOX Live Services, consultez Codes d’état HTTP standard. | Code| Expression de raison| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| La requête a abouti. 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 d’éléments, 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 inclut 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 dispose 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 obligatoire ou d’une valeur de données manquants, ou d’une version de l’API manquante ou non valide indiquée par la requête. Consultez l’en-tête X-XBL-Contract-Version.| | 401| Unauthorized| La requête nécessite une 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 verte.)| | 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.|

​
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| Spécifie 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| Spécifie si le contenu des corps de requête/réponse sera au format json ou 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 de requêtes de modification. Les requêtes de modification utilisent les verbes PUT, POST ou DELETE. Si la version indiquée dans 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 également ê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 réponse

Si l’appel réussit, le service retourne les dernières métadonnées de la liste.

​
Exemple de réponse

Dernière modification le 19 octobre 2026