POST (/users/xuid(xuid)/lists/PINS/)
Insère des éléments dans la liste à l’index défini par le paramètre de chaîne de requête insertIndex. Le domaine de ces URI esteplists.xboxlive.com.
- Remarques
- Paramètres d’URI
- Paramètres de la chaîne de requête
- Autorisation
- Codes d’état HTTP
- En-têtes de requête obligatoires
- Exemple de requête
- Corps de la réponse
Remarques
Cet appel insère des éléments dans la liste à l’index défini par le paramètre de chaîne de requête insertIndex (0 par défaut, soit le début de la liste). Tous les éléments du corps de la requête sont insérés à cet endroit de la liste. Si insertIndex est supérieur au nombre d’éléments de la liste existante, les nouveaux éléments sont insérés à la fin. Les éléments à insérer doivent comporter les champs obligatoires indiqués dans la spécification fonctionnelle; sinon, un code HTTP 400 est retourné. De même, si l’insertion fait dépasser la taille maximale de la liste (définie par type de liste), un code HTTP 400 est retourné et rien n’est inséré. Si l’élément ne doit pas être inséré au début ou à la fin de la liste, l’en-tête If-Match:versionNumber doit être inclus dans la requête. L’en-tête est facultatif si l’insertion se fait au début ou à la fin. S’il est présent, l’en-tête est validé quel que soit l’emplacement d’insertion. Dans l’en-tête, 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, le code d’état HTTP 412 (precondition failed) est retourné et le corps de la réponse contient les métadonnées les plus récentes de la liste, y compris le numéro de version actuel. Cela permet d’éviter que les mises à jour de différents clients s’écrasent mutuellement. Notez que cet appel n’est pas idempotent; des appels répétés avec les mêmes données pourraient entraîner plusieurs insertions. Toutefois, comme aucune liste ne prend actuellement en charge les doublons, des appels répétés entraîneront probablement le retour de codes HTTP 400.Paramètres d’URI
Paramètres de la chaîne de requête
| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | insertIndex| chaîne| Facultatif. Définit où insérer les éléments. Valeurs prises en charge : 0, entiers positifs et « end ». Toute valeur d’index supérieure au nombre d’éléments de la liste ajoute le nouvel élément au bas de la liste, sans insérer d’espace « vide » dans la liste. Valeur par défaut : 0.|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.