Pular para o conteúdo principal

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

Move um item de uma lista para uma posição diferente dentro da lista. O domínio para esses URIs é eplists.xboxlive.com.

​
Comentários

Esta chamada é fornecida para permitir que o cliente mova facilmente um item para um índice diferente dentro da lista em uma única operação. Somente um item pode ser movido por vez. Se o índice do item a ser movido não existir, um HTTP 400 será retornado. O índice do ponto de inserção segue as mesmas regras de uma inserção padrão. O padrão é 0 (o início da lista), e qualquer número maior que o número de itens na lista reinserirá o item no fim da lista. Da mesma forma, o fim da lista pode ser indicado passando “end” para insertIndex. Esta chamada também permite identificar o item a ser movido pelo itemId (ou pela combinação provider/providerId). Nesse caso, o itemId deve ser passado no corpo da solicitação e deve corresponder a um item existente na lista. Caso contrário, um erro HTTP 400 será retornado com IndexOutOfRange na descrição; para esta versão especial da chamada, use “-1” como o índice do item a ser movido. Esta chamada requer que um cabeçalho “If-Match:versionNumber” seja incluído na solicitação se o item for especificado por índice. Se o itemId for usado para indicar qual item mover, o cabeçalho “If-Match” será opcional. Se estiver presente, o cabeçalho “If-Match” sempre será validado. No cabeçalho “if-Match”, versionNumber é o número da versão atual da lista. Se ele não for incluído (e for obrigatório) ou não corresponder ao número da versão atual da lista, um código de status HTTP 412 - precondition failed será retornado, e o corpo da resposta conterá os metadados mais recentes da lista, que incluem o número da versão atual. Isso é feito para evitar que atualizações de clientes diferentes se sobreponham umas às outras.

​
Parâmetros de URI

​
Parâmetros da cadeia de consulta

| Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | | insertIndex| cadeia de caracteres| Especifica o local da lista em que o item será inserido. Os valores permitidos são zero, inteiros positivos e “end”. “end” coloca o item no fim da lista atual. Se o valor especificado estiver além do fim da lista, o item será inserido no fim da lista. |

​
Corpo da solicitação

Um corpo de solicitação é enviado somente ao especificar o item a ser movido por itemId ou por Provider/ProviderId. Exemplo de solicitação

​
Códigos de status HTTP

O serviço retorna um dos códigos de status desta seção em resposta a uma solicitação feita com este método neste recurso. Para obter uma lista completa dos códigos de status HTTP padrão usados com os XBOX Live Services, consulte Códigos de status HTTP padrão. | Código| Frase de motivo| Descrição| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK | A solicitação foi concluída com êxito. O corpo da resposta deve conter o recurso solicitado (para um GET). As solicitações POST e PUT receberão metadados atualizados da lista (versão da lista, contagem etc.).| | 201| Created | Uma nova lista foi criada. Isso é retornado na inserção inicial em uma lista. A resposta inclui metadados atualizados sobre a lista, e o cabeçalho location contém o URI da lista.| | 304| Not Modified| Retornado em GETs. Indica que o cliente tem a versão mais recente da lista. O serviço compara o valor no cabeçalho If-Match com a versão da lista. Se forem iguais, um 304 será retornado sem dados. | | 400| Bad Request | A solicitação estava malformada. Pode ser um valor ou tipo inválido para um parâmetro de URI ou da cadeia de consulta. Também pode ser resultado da ausência de um parâmetro ou valor de dados obrigatório, ou de a solicitação indicar uma versão ausente ou inválida da API. Consulte o cabeçalho X-XBL-Contract-Version. | | 401| Unauthorized | A solicitação requer autenticação do usuário.| | 403| Forbidden | A solicitação não é permitida para o usuário ou serviço.| | 404| Not Found | O chamador não tem acesso ao recurso. Isso indica que essa lista não foi criada.| | 412| Precondition Failed | Indica que a versão da lista foi alterada e uma solicitação de modificação falhou. Uma solicitação de modificação é uma inserção, atualização ou remoção. O serviço verifica o cabeçalho If-Match para obter a versão da lista. Se ela não corresponder à versão atual da lista, a operação falhará e isso será retornado junto com os metadados atuais da lista (que incluem a versão atual). | | 500| Internal Server Error | O serviço está recusando a solicitação devido a um erro no servidor.| | 501| Not Implemented | O chamador solicitou um URI que não foi implementado no servidor. (Atualmente, usado apenas quando é feita uma solicitação para um nome de lista que não está na lista de permissões.)| | 503| Service Unavailable | O servidor está recusando a solicitação, geralmente devido a carga excessiva. Após um intervalo (consulte o cabeçalho Retry-after), a solicitação pode ser repetida. |

​
Cabeçalhos de solicitação obrigatórios

| Cabeçalho| Descrição| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| Contém o token STS usado para autenticar e autorizar a solicitação. Deve ser um token do serviço XSTS e incluir o XUID como uma das declarações. | | X-XBL-Contract-Version| Especifica qual versão da API está sendo solicitada (inteiros positivos). Pins dá suporte à versão 2. Se esse cabeçalho estiver ausente ou o valor não tiver suporte, o serviço retornará 400 - Bad request com “Unsupported or missing contract version header” na descrição do status.| | Content-Type| Especifica se o conteúdo dos corpos de solicitação/resposta estará em json ou xml. Os valores com suporte são “application/json” e “application/xml”| | If-Match| Este cabeçalho deve conter o número da versão atual de uma lista ao fazer solicitações de modificação. As solicitações de modificação usam os verbos PUT, POST ou DELETE. Se a versão no cabeçalho “If-Match” não corresponder à versão atual da lista, a solicitação será rejeitada com um código de retorno HTTP 412 - precondition failed. (opcional) Também pode ser usado para GETs; se estiver presente e a versão passada corresponder à versão atual da lista, nenhum dado da lista será retornado, e sim um código HTTP 304 - Not Modified. |

​
Corpo da resposta

Se a chamada for bem-sucedida, o serviço retornará os metadados mais recentes da lista.

​
Exemplo de resposta

Última modificação em 19 de outubro de 2026