PlaceSummaryForGameUpdate — openapi

Summary of a place for a game update.

Properties

Name	Type	Required	Description
placeId	integer	false	Place ID of the place to be updated.
playersToBeKicked	integer	false	Number of players to be kicked from the place during the game update.
totalPlayers	integer	false	Total number of players in the place.
instancesToBeClosed	integer	false	Number of instances to be closed for the place during the game update.
totalInstances	integer	false	Total number of instances for the place.
placeVersion	integer	false	Lastest version of the place to be updated.
lastUpdated	string	false	The timestamp of the last update to the place summary.
isInUniverse	boolean	false	Indicates whether the place is still part of the universe. A place may have active games but is no longer in the universe if it has been removed from the universe.
versionToPlayerCounts	object	false	Player counts broken down by place version. Key is the place version, value is the number of players on that version.
versionToInstanceCounts	object	false	Instance counts broken down by place version. Key is the place version, value is the number of instances on that version.

Complete Schema

{
  "type": "object",
  "properties": {
    "placeId": {
      "type": "integer",
      "description": "Place ID of the place to be updated.",
      "format": "int64"
    },
    "playersToBeKicked": {
      "type": "integer",
      "description": "Number of players to be kicked from the place during the game update.",
      "format": "int32"
    },
    "totalPlayers": {
      "type": "integer",
      "description": "Total number of players in the place.",
      "format": "int32"
    },
    "instancesToBeClosed": {
      "type": "integer",
      "description": "Number of instances to be closed for the place during the game update.",
      "format": "int32"
    },
    "totalInstances": {
      "type": "integer",
      "description": "Total number of instances for the place.",
      "format": "int32"
    },
    "placeVersion": {
      "type": "integer",
      "description": "Lastest version of the place to be updated.",
      "format": "int32"
    },
    "lastUpdated": {
      "type": "string",
      "description": "The timestamp of the last update to the place summary.",
      "format": "date-time"
    },
    "isInUniverse": {
      "type": "boolean",
      "description": "Indicates whether the place is still part of the universe.\r\nA place may have active games but is no longer in the universe if it has been removed from the universe."
    },
    "versionToPlayerCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Player counts broken down by place version.\r\nKey is the place version, value is the number of players on that version.",
      "nullable": true
    },
    "versionToInstanceCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Instance counts broken down by place version.\r\nKey is the place version, value is the number of instances on that version.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Summary of a place for a game update."
}