POST (/users/xuid(xuid)/lists/PINS/)
Inserta elementos en la lista en el índice indicado por el parámetro de cadena de consulta insertIndex. El dominio de estos URI eseplists.xboxlive.com.
- Comentarios
- Parámetros de URI
- Parámetros de cadena de consulta
- Autorización
- Códigos de estado HTTP
- Encabezados de solicitud obligatorios
- Ejemplo de solicitud
- Cuerpo de la respuesta
Comentarios
Esta llamada insertará elementos en la lista en el índice indicado por el parámetro de cadena de consulta insertIndex (el valor predeterminado es 0, es decir, el principio de la lista). Todos los elementos del cuerpo de la solicitud se insertarán en ese punto de la lista. Si el valor de insertIndex es mayor que el número de elementos de la lista existente, los nuevos elementos se insertarán al final. Los elementos que se van a insertar deben tener los campos obligatorios indicados en la especificación funcional; de lo contrario, se devolverá un HTTP 400. Del mismo modo, si el resultado de la inserción supera el tamaño máximo de la lista (definido por tipo de lista), se devolverá un HTTP 400 y no se insertará nada. Si el elemento no se va a insertar al principio o al final de la lista, es obligatorio incluir el encabezado If-Match:versionNumber en la solicitud. El encabezado es opcional si la inserción es al principio o al final. Si está presente, el encabezado se validará independientemente de la ubicación de inserción. En el encabezado, VersionNumber es el número de versión actual de la lista. Si no se incluye y es obligatorio, o no coincide con el número de versión actual de la lista, se devolverá un código de estado HTTP 412 (error de condición previa) y el cuerpo de la respuesta contendrá los metadatos más recientes de la lista, que incluyen el número de versión actual. Esto se hace para evitar que las actualizaciones de distintos clientes se sobrescriban entre sí. Tenga en cuenta que esta llamada no es idempotente; las llamadas repetidas con los mismos datos podrían dar lugar a varias inserciones. Sin embargo, dado que actualmente ninguna lista admite duplicados, las llamadas repetidas probablemente den lugar a que se devuelvan códigos HTTP 400.Parámetros de URI
Parámetros de cadena de consulta
| Parámetro| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | | insertIndex| string| Opcional. Define dónde insertar los elementos. Valores admitidos: 0, enteros positivos y “end”. Cualquier valor de índice mayor que el número de elementos de la lista agregará el nuevo elemento al final de la lista y no insertará espacio “en blanco” en la lista. Valor predeterminado: 0.|Autorización
Esta llamada espera un token SAML de XSTS en el encabezado Authorization. Debe existir una notificación Xuid dentro de ese token SAML para identificar al autor de la llamada. Este valor se usa para determinar si el autor de la llamada tiene derechos de acceso a los datos de la lista en cuestión. La propia lista también se identificará mediante el Xuid y se incluirá en el URI de la lista. Con esto, es posible que en el futuro se admita el acceso compartido a las listas, pero por ahora no es una característica disponible. Actualmente, todas las listas a las que accede un usuario serán suyas y no existe acceso compartido. Por lo tanto, el Xuid del URI debe coincidir con el Xuid del token de notificaciones SAML.Nota:
Actualmente se admiten tanto los tokens de XBL Auth 2.0 como los de 3.0.