GET (/users/xuid(xuid)/lists/PINS/)
Retorna o conteúdo de uma lista. O domínio para esses URIs éeplists.xboxlive.com.
- Comentários
- Parâmetros de URI
- Parâmetros da cadeia de consulta
- Autorização
- Cabeçalhos de solicitação obrigatórios
- Corpo da solicitação
- Códigos de status HTTP
- Corpo da resposta
Comentários
O campo listCount nos dados retornados indica quantos itens existem no total da lista mantida pelo serviço; assim, ele pode ser usado para determinar onde está o fim da lista, e esse número pode ser diferente da quantidade de itens específicos retornados pela solicitação. Se a lista ainda não existir, os resultados não conterão itens de lista, o listCount será zero e o listVersion será zero.Parâmetros de URI
Parâmetros da cadeia de consulta
| Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | | skipItems| inteiro de 32 bits com sinal| Opcional. Número de itens a serem ignorados na enumeração antes de retornar os resultados. Valor padrão: 0.| | maxItems| inteiro de 32 bits com sinal| Opcional. Número máximo de itens a serem retornados. O padrão é 25 itens se nenhum máximo for especificado na solicitação. O serviço não impõe um máximo a esse valor; se o valor for maior que o número de itens na lista, todos os itens serão retornados sem erro.| | filterItemId| cadeia de caracteres| Opcional. Especifica o item a ser localizado na lista. Retorna todas as instâncias do item na lista. Permite que o cliente determine rapidamente se e onde um item está em uma lista. Útil para listas grandes, para determinar todas as instâncias de um item sem iterar pela lista inteira. Valor padrão: null.| | filterContentType| cadeia de caracteres| Opcional. Especifica uma lista separada por vírgulas de tipos de conteúdo a serem retornados (não retornará tipos que não estejam na lista). Usado para obter apenas determinados tipos de conteúdo de uma lista. Uma lista separada por vírgulas de tipos de conteúdo é usada para esse filtro. (Vários tipos de conteúdo podem ser consultados em uma única chamada.) Os tipos de conteúdo com suporte incluem todos os tipos de mídia definidos pelo Entertainment Discovery Services (EDS). Valor padrão: null (todos os tipos de conteúdo).| | filterDeviceType| cadeia de caracteres| Opcional. Especifica uma lista separada por vírgulas de tipos de dispositivo a serem retornados (não retornará tipos que não estejam na lista). Filtra o conjunto retornado para retornar apenas itens que foram inseridos a partir de um conjunto específico de tipos de dispositivo. Uma lista separada por vírgulas de tipos de dispositivo é usada para esse filtro (vários tipos de dispositivo podem ser consultados em uma única chamada). Valores possíveis: XboxOne, MCapensis, WindowsPhone, WindowsPhone7, Web, PC, MoLive. Valor padrão: null (todos os tipos de conteúdo).|Autorização
Esta chamada espera um token SAML do XSTS no cabeçalho Authorization. Uma declaração Xuid deve existir nesse token SAML para identificar o chamador. Esse valor é usado para determinar se o chamador tem direitos de acesso aos dados da lista em questão. A própria lista também será identificada pelo Xuid e será incluída no URI da lista. Com isso, poderemos no futuro dar suporte ao acesso compartilhado a listas, mas esse não é um recurso disponível no momento. Atualmente, todas as listas que um usuário acessa serão dele mesmo e não há acesso compartilhado. Portanto, o Xuid no URI deve corresponder ao Xuid no token de declarações SAML.Observação:
No momento, há suporte para tokens do XBL Auth 2.0 e 3.0.