Report a safe command result

POST

/api/v1/player/commands/{id}/result

curl --request POST \
  --url https://example.com/api/v1/player/commands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/result \
  --header 'Content-Type: application/json' \
  --data '{ "success": true, "code": "example", "message": "example" }'

Requires an authenticated player credential.

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

success

required

boolean

code

string

<= 80 characters

message

string

<= 240 characters

Example^generated

{
  "success": true,
  "code": "example",
  "message": "example"
}

Responses

200

Result accepted idempotently

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

state

required

string

Allowed values: pending delivered acknowledged running succeeded failed cancelled expired

Example

{
  "data": {
    "state": "pending"
  }
}

409

Command expired or cancelled