POST socket-server/activity

Perform a batch update of player activity from a socket server.

Example

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

[{
  "playerId": "6d57b549-55c5-4767-8a7d-07f5c5c03b2e",
  "activity": "In Terminal",
  "online": true
},{
  "playerId": "517c686c-4125-4115-a113-4a2af3d1e267",
  "online": true
},{
  "playerId": "9fe3aca0-a7dd-42b0-b467-fb2f61a50439",
  "online": false
}]
----------------------------------------
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

NONE

Request Body

The request body is an array of batch operations, see type Activity.

Activity

NameDescriptionValue
playerIdthe player ID to updatestring
onlinewhether or not this player is onlineboolean
activitya text description of the player's current activity, which will be displayed to other users; if not provided (and if the user is still online) their previous activity is retained optionalstring

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE