Saltar al contenido principal

POST (/handles/query?include=relatedInfo)

Crea consultas de identificadores de sesión que incluyen información de sesión relacionada.
Importante:
Este método lo usa el multijugador de 2015 y se aplica únicamente a esa versión multijugador y posteriores. Está pensado para usarse con el contrato de plantilla 104/105 o posterior, y requiere un elemento de encabezado X-Xbl-Contract-Version: 104/105 o posterior en cada solicitud.

Comentarios

Este método HTTP/REST crea consultas de datos de identificadores con la información de sesión especificada en la cadena de consulta “include”. El valor de la cadena de consulta está diseñado para ser extensible y admitir opciones de consulta futuras, admitiendo una lista delimitada por comas, por ejemplo, “?include=relatedInfo,session”. El método POST puede encapsularse mediante Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForUsersAsync. El campo de tipo del cuerpo de la solicitud para este método debe establecerse en “activity”. Los elementos del cuerpo de la respuesta se asignan directamente a las propiedades de Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails.

Parámetros de URI

Parámetros de cadena de consulta

Una consulta puede modificarse mediante los parámetros de cadena de consulta de la tabla siguiente. | Parámetro| Tipo| Descripción| | --- | --- | --- | --- | | keyword| string| Una palabra clave, por ejemplo, “foo”, que debe encontrarse en las sesiones o plantillas para que se recuperen. | | xuid| Entero de 64 bits sin signo| El identificador de usuario de XBOX, por ejemplo, “123”, de las sesiones que se incluirán en la consulta. De forma predeterminada, el usuario debe estar activo en la sesión para que esta se incluya. | | reservations| Valor booleano| True para incluir las sesiones en las que el usuario está establecido como jugador reservado pero no se ha unido para convertirse en jugador activo. Este parámetro solo se usa al consultar sus propias sesiones, o al consultar las sesiones de un usuario específico de servidor a servidor. | | inactive| Valor booleano| True para incluir las sesiones que el usuario ha aceptado pero en las que no está jugando activamente. Las sesiones en las que el usuario está “ready” pero no “active” cuentan como inactivas. | | private| Valor booleano| True para incluir las sesiones privadas. Este parámetro solo se usa al consultar sus propias sesiones, o al consultar las sesiones de un usuario específico de servidor a servidor. | | visibility| string| Estado de visibilidad de las sesiones. Los valores posibles los define Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility. Si este parámetro se establece en “open”, la consulta debe incluir solo las sesiones abiertas. Si se establece en “private”, el parámetro private debe establecerse en true. | | version| Entero de 32 bits con signo| La versión máxima de sesión que debe incluirse. Por ejemplo, un valor de 2 especifica que solo deben incluirse las sesiones con una versión principal de sesión de 2 o inferior. El número de versión debe ser menor o igual que la versión del contrato de la solicitud módulo 100. | | take| Entero de 32 bits con signo| El número máximo de sesiones que se recuperarán. Este número debe estar entre 0 y 100. | Establecer private o reservations en true requiere acceso de nivel de servidor a la sesión. Como alternativa, estas configuraciones requieren que la notificación XUID del autor de la llamada coincida con el filtro XUID del URI. De lo contrario, se devuelve el código de estado HTTP/403, existan o no realmente dichas sesiones.

Códigos de estado HTTP

El servicio devuelve un código de estado HTTP según se aplica al MPSD.

Cuerpo de la solicitud

Ejemplo de solicitud

Para obtener todas las actividades del gráfico social de “favoritos” de un usuario, el cuerpo del POST tiene este aspecto:

Cuerpo de la respuesta

Los resultados se devuelven como una matriz de estructuras de identificador, con un ID único incrustado en cada identificador. La información específica de la sesión se devuelve en el objeto relatedInfo. Tenga en cuenta que esta información no se devuelve para el método POST normal en este URI.

Ejemplo de respuesta

Consulte también

Elemento primario
/handles/query
Última modificación el 19 de octubre de 2026