POST (/handles/query?include=relatedInfo)

Cria consultas de identificadores de sessão que incluem informações relacionadas da sessão.

Importante:
Este método é usado pelo Multiplayer 2015 e se aplica somente a essa versão multijogador e posteriores. Ele se destina ao uso com o contrato de modelo 104/105 ou posterior e requer um elemento de cabeçalho X-Xbl-Contract-Version: 104/105 ou posterior em todas as solicitações.

Comentários
Parâmetros de URI
Parâmetros da cadeia de consulta
Códigos de status HTTP
Corpo da solicitação
Corpo da resposta

Comentários

Este método HTTP/REST cria consultas de dados de identificadores com as informações de sessão especificadas na cadeia de consulta “include”. O valor da cadeia de consulta foi projetado para ser extensível a fim de dar suporte a opções de consulta futuras, aceitando uma lista delimitada por vírgulas, por exemplo, “?include=relatedInfo,session”. O método POST pode ser encapsulado por Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForUsersAsync. O campo type no corpo da solicitação deste método deve ser definido como “activity”. Os itens no corpo da resposta são mapeados diretamente para as propriedades de Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails.

Parâmetros de URI

Parâmetros da cadeia de consulta

Uma consulta pode ser modificada usando os parâmetros da cadeia de consulta na tabela a seguir. | Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | | keyword| string| Uma palavra-chave, por exemplo, “foo”, que deve ser encontrada nas sessões ou nos modelos para que eles sejam recuperados. | | xuid| inteiro sem sinal de 64 bits| A ID de usuário do XBOX, por exemplo, “123”, das sessões a serem incluídas na consulta. Por padrão, o usuário deve estar ativo na sessão para que ela seja incluída. | | reservations| booliano| True para incluir sessões nas quais o usuário está definido como um jogador reservado, mas ainda não ingressou para se tornar um jogador ativo. Este parâmetro é usado somente ao consultar suas próprias sessões ou ao consultar as sessões de um usuário específico de servidor para servidor. | | inactive| booliano| True para incluir sessões que o usuário aceitou, mas nas quais não está jogando ativamente. As sessões nas quais o usuário está “ready”, mas não “active”, contam como inativas. | | private| booliano| True para incluir sessões privadas. Este parâmetro é usado somente ao consultar suas próprias sessões ou ao consultar as sessões de um usuário específico de servidor para servidor. | | visibility| string| Estado de visibilidade das sessões. Os valores possíveis são definidos por Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility. Se este parâmetro for definido como “open”, a consulta deverá incluir somente sessões abertas. Se for definido como “private”, o parâmetro private deverá ser definido como true. | | version| inteiro com sinal de 32 bits| A versão máxima da sessão que deve ser incluída. Por exemplo, um valor de 2 especifica que somente as sessões com uma versão principal de sessão de 2 ou inferior devem ser incluídas. O número da versão deve ser menor ou igual à versão do contrato da solicitação mod 100. | | take| inteiro com sinal de 32 bits| O número máximo de sessões a serem recuperadas. Esse número deve estar entre 0 e 100. | Definir private ou reservations como true requer acesso no nível do servidor à sessão. Como alternativa, essas configurações exigem que a declaração de XUID do chamador corresponda ao filtro de XUID no URI. Caso contrário, o código de status HTTP/403 será retornado, independentemente de essas sessões realmente existirem ou não.

Códigos de status HTTP

O serviço retorna um código de status HTTP conforme aplicável ao MPSD.

Corpo da solicitação

Exemplo de solicitação

Para obter todas as atividades do grafo social “favorites” de um usuário, o corpo do POST tem esta aparência:

{
  "type": "activity",
  "scid": "B5B1F71F-A328-4371-89E0-C3AD222D0E92"  // optional filter on scid
  "owners": {
     "people": {
       "moniker": "favorites",
       "monikerXuid": "3210"
     }
  }
}

Corpo da resposta

Os resultados são retornados como uma matriz de estruturas de identificadores, com uma ID exclusiva inserida em cada identificador. As informações específicas da sessão são retornadas no objeto relatedInfo. Observe que essas informações não são retornadas para o método POST regular neste URI.

Exemplo de resposta

{
	"results": [{
		"id": "11111111-ebe0-42da-885f-033860a818f6",
		"type": "activity",
		"version": 1,
		"sessionRef": {
			"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
			"templateName": "party",
			"name": "e3a836aeac6f4cbe9bcab985494d3175"
		},

    "titleId": "1234567",
    "ownerXuid": "3212",

    // Only if ?include=relatedInfo
		"relatedInfo": {
			"visibility": "open",
			"joinRestriction": "followed",
			"closed": true,
			"maxMembersCount": 8,
			"membersCount": 4,
		}
	},
	{
		"id": "11111111-ebe0-42da-885f-033860a818f7",
		"type": "activity",
		"version": 1,
		"sessionRef": {
			"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
			"templateName": "TitleStorageTestDefault",
			"name": "795fcaa7-8377-4281-bd7e-e86c12843632"
		},
    "titleId": "1234567",
    "ownerXuid": "3212",

    // Only if ?include=relatedInfo
		"relatedInfo": {
			"visibility": "open",
			"joinRestriction": "followed",
			"closed": false,
			"maxMembersCount": 8,
			"membersCount": 4,
		}
	}]
}

Confira também

Pai

/handles/query

Porting

Build Paths

POST (/handles/query?include=relatedInfo)

POST (/handles/query?include=relatedInfo)

Comentários

Parâmetros de URI

Parâmetros da cadeia de consulta

Códigos de status HTTP

Corpo da solicitação

Exemplo de solicitação

Corpo da resposta

Exemplo de resposta

Confira também

Pai

​POST (/handles/query?include=relatedInfo)

​Comentários

​Parâmetros de URI

​Parâmetros da cadeia de consulta

​Códigos de status HTTP

​Corpo da solicitação

​Exemplo de solicitação

​Corpo da resposta

​Exemplo de resposta

​Confira também

Pai

POST (/handles/query?include=relatedInfo)

Comentários

Parâmetros de URI

Parâmetros da cadeia de consulta

Códigos de status HTTP

Corpo da solicitação

Exemplo de solicitação

Corpo da resposta

Exemplo de resposta

Confira também