PUT (/serviceconfigs//sessiontemplates//sessions/)

Crea, actualiza o se une a una sesión.

Importante:
Este método de URI requiere un elemento de encabezado X-Xbl-Contract-Version: 104/105 o posterior en cada solicitud.

Comentarios
Parámetros de URI
Códigos de estado HTTP
Cuerpo de la solicitud
Cuerpo de la respuesta

Comentarios

Este método HTTP/REST crea, se une a o actualiza una sesión, según el subconjunto de la misma plantilla de cuerpo de solicitud JSON que se envíe. Si se realiza correctamente, devuelve un objeto MultiplayerSession que contiene la respuesta devuelta por el servidor. Los atributos que contiene pueden ser diferentes de los atributos del objeto MultiplayerSession pasado. Este método se puede encapsular mediante Microsoft.Xbox.Services.Multiplayer.MultiplayerService.WriteSessionAsync. Las operaciones de creación y actualización de sesiones usan PUT con un cuerpo application/json que representa los cambios que se van a aplicar. Las operaciones son idempotentes, es decir, varias aplicaciones de los mismos cambios no tienen ningún efecto adicional. El cuerpo de la solicitud JSON refleja la estructura de datos de la sesión. Todos los campos y subcampos son opcionales. A continuación se muestra el formato de conexión del modo de creación o unión a una sesión del método PUT.

Nota:
Tenga cuidado al usar este patrón. Las actualizaciones se aplican a ciegas, independientemente del estado actual de la sesión.

PUT /serviceconfigs/00000000-0000-0000-0000-000000000000/sessiontemplates/quick/sessions/00000000-0000-0000-0000-000000000001 HTTP/1.1
         Content-Type: application/json

A continuación se muestra el formato de conexión del modo de actualización de sesión del método PUT.

PUT /serviceconfigs/00000000-0000-0000-0000-000000000000/sessiontemplates/quick/sessions/00000000-0000-0000-0000-000000000001 HTTP/1.1
         Content-Type: application/json

A continuación se muestra el formato de conexión del método PUT para actualizar las propiedades de la sesión. Es equivalente a una operación PUT en el URI de la sesión con un cuerpo que solo contiene el objeto siguiente como propiedades. La diferencia es que esta operación devuelve el código de error 404 No encontrado si la sesión no existe. Esta operación admite el encabezado If-Match.

PUT /serviceconfigs/00000000-0000-0000-0000-000000000000/sessiontemplates/quick/sessions/00000000-0000-0000-0000-000000000001/properties HTTP/1.1
         Content-Type: application/json

         { "system": { }, "custom": { } }

Parámetros de URI

| Parámetro| Tipo| Descripción| | --- | --- | --- | --- | --- | | scid| GUID| Identificador de configuración de servicio (SCID). Parte 1 del identificador de sesión.| | sessionTemplateName| string| Nombre de la instancia actual de la plantilla de sesión. Parte 2 del identificador de sesión.| | sessionName| GUID| Id. único de la sesión. Parte 3 del identificador de sesión.|

Códigos de estado HTTP

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

Cuerpo de la solicitud

A continuación se muestra un ejemplo de cuerpo de solicitud para crear o unirse a una sesión. Los siguientes miembros del cuerpo de la solicitud son opcionales. Todos los demás miembros posibles están prohibidos en una solicitud. | Miembro| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | --- | --- | | constants| object| Configuración de solo lectura que se combina con la plantilla de sesión para generar las constantes de la sesión. | | properties | object | Cambios que se van a combinar en las propiedades de la sesión.| | members.me | object| Constantes y propiedades que funcionan de forma muy similar a sus equivalentes de nivel superior. Cualquier método PUT requiere que el usuario sea miembro de la sesión y agrega al usuario si es necesario. Si “me” se especifica como null, el miembro que realiza la solicitud se quita de la sesión. | | members | object| Otros objetos que representan usuarios que se van a agregar a la sesión, con un índice de base cero como clave. El número de miembros de una solicitud siempre empieza en 0, aunque la sesión ya contenga miembros. Los miembros se agregan a la sesión en el orden en que aparecen en la solicitud. Las propiedades de los miembros solo puede establecerlas el usuario al que pertenecen. | | servers | object| Valores que indican actualizaciones y adiciones al conjunto de participantes de servidor asociados de la sesión. Si un servidor se especifica como null, esa entrada de servidor se quita de la sesión. |

{
  "properties": {
    "custom": {"KANWE": "MGMSY"},
    "system": {}
  },
  "constants": {
    "custom": {},
    "system": {"visibility": "open"}
  },
  "members": {
    "reserve_0": {
    "constants": {
      "custom": {"type": "leader"},
      "system": {"xuid": "5500461"} }}
   }
}

Cuerpo de la respuesta

Ejemplo de cuerpo de respuesta para crear o unirse a una sesión:

{
  "contractVersion": 104,
  "correlationId": "0FE81338-EE96-46E3-A3B5-2DBBD6C41C3B",
  "nextTimer": "2009-06-15T13:45:30.0900000Z",

  "initializing": {
    "stage": "measuring",
    "stageStartTime": "2009-06-15T13:45:30.0900000Z",
    "episode": 1
  },

  "hostCandidates": [ "ab90a362", "99582e67" ],

  "constants": {
    "system": {"visibility": "open"},
    "custom": {}
  },

  "properties": {
     "system": { "turn": [] },
     "custom": { "myProperty": "myValue" }
  },

  "members": {
      "1": {
        "properties": {
        "system": { },
        "custom": { }
      },

      "constants": {
        "system": { "xuid": "5500461" },
        "custom": { }
      }

      "gamertag": "stacy",
      "deviceToken": "9f4032ba7",
      "reserved": true,
      "activeTitleId": "8397267",
      "joinTime": "2009-06-15T13:45:30.0900000Z",
      "turn": true,
      "initializationFailure": "latency",
      "initializationEpisode": 1,
      "next": 4
    },
  },

  "membersInfo": {
      "first": 1,
      "next": 4,
      "count": 1,
      "accepted": 0
  },

  "servers": {
      "name": {
        "constants": { },
        "properties": { }
      }
  }
}

Consulte también

Elemento primario

/serviceconfigs//sessiontemplates//sessions/

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

PUT (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName})

PUT (/serviceconfigs//sessiontemplates//sessions/)

Comentarios

Parámetros de URI

Códigos de estado HTTP

Cuerpo de la solicitud

Cuerpo de la respuesta

Consulte también

Elemento primario

​PUT (/serviceconfigs//sessiontemplates//sessions/)

​Comentarios

​Parámetros de URI

​Códigos de estado HTTP

​Cuerpo de la solicitud

​Cuerpo de la respuesta

​Consulte también

Elemento primario

PUT (/serviceconfigs//sessiontemplates//sessions/)

Comentarios

Parámetros de URI

Códigos de estado HTTP

Cuerpo de la solicitud

Cuerpo de la respuesta

Consulte también