GET (/users/xuid(xuid)/lists/PINS/)
Devuelve el contenido de una lista. El dominio de estos URI eseplists.xboxlive.com.
- Comentarios
- Parámetros de URI
- Parámetros de cadena de consulta
- Autorización
- Encabezados de solicitud obligatorios
- Cuerpo de la solicitud
- Códigos de estado HTTP
- Cuerpo de la respuesta
Comentarios
El campo listCount de los datos devueltos indica cuántos elementos hay en la lista total que mantiene el servicio; como tal, se puede usar para determinar dónde está el final de la lista, y es potencialmente un número distinto del número de elementos específicos que devolvió la solicitud. Si la lista aún no existe, los resultados no contendrán elementos de lista, el valor de listCount será cero y el de listVersion será cero.Parámetros de URI
Parámetros de cadena de consulta
| Parámetro| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | | skipItems| Entero de 32 bits con signo| Opcional. Número de elementos que se van a omitir en la enumeración antes de devolver resultados. Valor predeterminado: 0.| | maxItems| Entero de 32 bits con signo| Opcional. Número máximo de elementos que se van a devolver. El valor predeterminado es 25 elementos si no se especifica un máximo en la solicitud. El servicio no impone un máximo a este valor; si el valor es mayor que el número de elementos de la lista, se devolverán todos los elementos sin ningún error.| | filterItemId| string| Opcional. Especifica el elemento que se va a buscar en la lista. Devuelve todas las instancias del elemento en la lista. Permite al cliente determinar rápidamente si un elemento está en una lista y dónde. Resulta práctico para listas grandes a fin de determinar todas las instancias de un elemento sin recorrer toda la lista. Valor predeterminado: null.| | filterContentType| string| Opcional. Especifica una lista separada por comas de tipos de contenido que se van a devolver (no devolverá tipos que no estén en la lista). Se usa para obtener solo determinados tipos de contenido de una lista. Para este filtro se usa una lista separada por comas de tipos de contenido. (Se pueden consultar varios tipos de contenido en una sola llamada). Los tipos de contenido admitidos incluyen todos los tipos de medios definidos por Entertainment Discovery Services (EDS). Valor predeterminado: null (todos los tipos de contenido).| | filterDeviceType| string| Opcional. Especifica una lista separada por comas de tipos de dispositivo que se van a devolver (no devolverá tipos que no estén en la lista). Filtra el conjunto devuelto para que solo se devuelvan elementos que se hayan insertado desde un conjunto específico de tipos de dispositivo. Para este filtro se usa una lista separada por comas de tipos de dispositivo (se pueden consultar varios tipos de dispositivo en una sola llamada). Valores posibles: XboxOne, MCapensis, WindowsPhone, WindowsPhone7, Web, PC, MoLive. Valor predeterminado: null (todos los tipos de contenido).|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.