POST socket-server/{serverId}/parties

Perform a batch update of parties on a socket server.

Example

POST /api/v1/socket-server/20/parties HTTP/1.1
Authorization: Signature ...
Content-Type: application/json

[{
  "kind": "update",
  "party": "12bd6efa-d8f6-41cf-8198-9a163cb4687d",
  "currentPlayers": 5,
},{
  "kind": "update",
  "party": "58951996-374a-4ea6-a347-17430c41f815",
  "maxPlayers": 8,
  "name": "Jane's Party",
},{
  "kind": "delete"
  "party": "90c80fc4-8178-4719-8f6a-d69f312b043c",
}]
----------------------------------------
HTTP/1.1 204 No Content
ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

Security

Authentication is required and restricted to system processes. Requests should be signed using a System key.

URL Parameters

NameDescriptionValue
serverIdthe ID of the server, 0 to 255number

Request Body

The request body is an array of batch operations, see types Update and Delete. Update operations should include only the properties that have changed.

Update Operation

NameDescriptionValue
kindoperation type discriminatorliteral: update
partythe party ID to updatestring
namethe name of the party optionalstring
maxPlayersthe maximum allowed players for this server optionalnumber
currentPlayersthe current players connected to this server optionalnumber

Delete Operation

NameDescriptionValue
kindoperation type discriminatorliteral: delete
partythe party ID to deletestring

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE