RArainbird
Decisions

Response - Respond with an answer to a question

Changed on

If you have received a questionResponse from the query, response or undo endpoints, you can submit an array of answers. These must be provided as triples.<br><br> Note: properties returned in the question object will determine how you can respond.<br><br> Skipping a question. If you are unable or do not wish to answer, set the unanswered property to true on the answer to skip the question rather than supplying a value. This is only accepted when the question object was returned with allowUnknown set to true, or when it includes knownAnswers; submitting unanswered as true for any other question returns a validation error. When skipping, you still send the triple that identifies the question, but the value being asked for is omitted (see the unanswered property below).

post/{sessionID}/response

Request

Path parameters

sessionIDstring required

The session to send responses to

Request body

Example request

{
  "answers": [
    {
      "subject": "Ben",
      "relationship": "suffered",
      "object": "water damage",
      "certainty": 100
    }
  ]
}

Response

An answer if one is reached, or a question

OR

Example response

{
  "question": {
    "subject": "Ben",
    "dataType": "string",
    "relationship": "suffered",
    "type": "Second Form Object",
    "plural": true,
    "allowCF": true,
    "allowUnknown": false,
    "canAdd": true,
    "prompt": "What type of loss has Ben suffered?",
    "knownAnswers": [],
    "concepts": [
      {
        "conceptType": "loss",
        "name": "cosmetic damage",
        "type": "string",
        "value": "cosmetic damage"
      },
      {
        "conceptType": "loss",
        "name": "water damage",
        "type": "string",
        "value": "water damage"
      },
      {
        "conceptType": "loss",
        "name": "loss",
        "type": "string",
        "value": "loss"
      },
      {
        "conceptType": "loss",
        "name": "theft",
        "type": "string",
        "value": "theft"
      }
    ]
  },
  "sid": "c1bf18d7-d1f0-44bc-a639-8cd4ded56dce"
}

Changes