Set the caller's answering setting: its transfers and reservations taken in from now on are acknowledged at Received (the default) or answered with their decision, waiting at most wait_ms (REQ-CS-9). Answered with its result.

POST

/v1/principals/self/answering

const url = 'https://example.com/v1/principals/self/answering';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"answer":"acknowledged","wait_ms":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/principals/self/answering \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "answer": "acknowledged", "wait_ms": 1 }'

Authorizations

bearer

Request Body^required

application/json

POST /v1/principals/self/answering (REQ-CS-9): set the calling principal’s answering setting. It applies to transfers and reservations taken in from now on.

object

answer

required

One of:

string
string

Acknowledged at Received; the decision follows by notification and query. The default.

string

Allowed value: acknowledged

Answered with the decision, or ERR-DecisionUnavailable past the wait.

string

Allowed value: decided

wait_ms

How long a decided reply may wait for the decision, in milliseconds. At most the deployment’s decision wait; without it, NFR-16’s 1 000 ms, or the decision wait if shorter.

integer | null format: uint64

Responses

200

The caller’s answering setting as it now stands (REQ-CS-9).

application/json

A principal’s answering setting, as it stands (REQ-CS-9).

object

answer

required

One of:

string
string

Acknowledged at Received; the decision follows by notification and query. The default.

string

Allowed value: acknowledged

Answered with the decision, or ERR-DecisionUnavailable past the wait.

string

Allowed value: decided

principal

required

The principal it applies to.

string

set_at

When it was set. Absent for the default.

integer | null format: uint64

set_by

Who set it. Absent for the default, which nobody set.

string | null

wait_ms

required

How long a decided reply waits for the decision, in milliseconds.

integer format: uint64

Example

{
  "answer": "acknowledged"
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).

Set the caller's answering setting: its transfers and reservations taken in from now on are acknowledged at Received (the default) or answered with their decision, waiting at most wait_ms (REQ-CS-9). Answered with its result.

Authorizations

Request Bodyrequired

Responses

200

Example

4XX

Example

5XX

Example

Headers

Request Body^required