Skip to main content

GET (/users/xuid()/achievements)

Obtém a lista de conquistas definidas no título, as desbloqueadas pelo usuário ou as que o usuário tem em andamento. O domínio desses URIs é achievements.xboxlive.com.

Parâmetros de URI

Parâmetros da cadeia de caracteres de consulta

| Parâmetro| Obrigatório| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | --- | | skipItems| Não| inteiro com sinal de 32 bits| Retorna itens começando após o número de itens fornecido. Por exemplo, skipItems=“3” recuperará itens a partir do quarto item recuperado. | | continuationToken| Não| string| Retorna os itens a partir do token de continuação fornecido. | | maxItems| Não| inteiro com sinal de 32 bits| Número máximo de itens a serem retornados da coleção, que pode ser combinado com skipItems e continuationToken para retornar um intervalo de itens. O serviço pode fornecer um valor padrão se maxItems não estiver presente e pode retornar menos que maxItems, mesmo que a última página de resultados ainda não tenha sido retornada. | | titleId| Não| string| Um filtro para os resultados retornados. Aceita um ou mais identificadores de título decimais delimitados por vírgula.| | unlockedOnly| Não| Valor booliano| Filtro para os resultados retornados. Se definido como true, retornará apenas as conquistas desbloqueadas para o usuário. O padrão é false.| | possibleOnly| Não| Valor booliano| Filtro para os resultados retornados. Se definido como true, retornará todos os resultados possíveis, mas não os metadados de desbloqueio, apenas as informações de conquista do XMS. O padrão é false.| | types| Não| string| Um filtro para os resultados retornados. Pode ser “Persistent” ou “Challenge”. O padrão são todos os tipos com suporte.| | orderBy| Não| string| Especifica a ordem em que os resultados serão retornados. Pode ser “Unordered”, “Title”, “UnlockTime” ou “EndingSoon”. O padrão é “Unordered”.|

Autorização

| Declaração| Obrigatória?| Descrição| Comportamento se ausente| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | User| O chamador é um usuário autorizado do XBOX LIVE.| O chamador precisa ser um usuário válido no XBOX LIVE.| 403 Forbidden|

Cabeçalhos de solicitação obrigatórios

| Cabeçalho| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| string| Credenciais de autenticação para autenticação HTTP. Valor de exemplo: “XBL3.0 x=<userhash>;<token>”.|

Cabeçalhos de solicitação opcionais

| Cabeçalho| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| string| Nome/número de build do serviço XBOX LIVE para o qual esta solicitação deve ser direcionada. A solicitação só será roteada para esse serviço após a verificação da validade do cabeçalho, das declarações no token de autenticação etc. Valor padrão: 1.| | x-xbl-contract-version| inteiro sem sinal de 32 bits| Se presente e definido como 2, a versão V2 desta API será usada. Caso contrário, a V1.| | Accept-Language| string| Lista de localidades desejadas e alternativas (por exemplo, fr-FR, fr, en-GB, en-WW, en-US). O serviço Achievements percorrerá a lista até encontrar cadeias de caracteres localizadas correspondentes. Se nenhuma for encontrada, ele tentará corresponder ao local definido no token do usuário, que vem do endereço IP do usuário. Se ainda assim nenhuma cadeia de caracteres localizada correspondente for encontrada, ele usará as cadeias de caracteres padrão fornecidas pelo desenvolvedor/editor do título. |

Corpo da solicitação

Nenhum objeto é enviado no corpo desta solicitação.

Corpo da resposta

Se a chamada for bem-sucedida, o serviço retornará uma matriz de objetos Achievement (JSON) e um objeto PagingInfo (JSON).

Exemplo de resposta

Confira também

Pai
/users/xuid()/achievements
Referência
Achievement (JSON) PagingInfo (JSON) Parâmetros de paginação
Last modified on October 6, 2026