Answer API documentation version v1.0

http://api.example.com/x-nmos/testanswer/{version}

  • version: required(v1.0)

Overview

The Answer API is the endpoint on the NMOS Testing tool that receives answer data from the user side of the Controller Test suites. This could be either from the bundled Testing Facade app or from a fully automated testing app and contains all the information necessary to determine the outcome of the test within the Test Suite.

Further Documentation

Further documentation covering the usage of this API is contained in the docs and schemas folders of this repository.

Base

post

post

Receive a single answer set for a question

Receive a single answer set for a question

Body

Media type: application/json

Type:

{
    "title": "Controller Testing - POST request to testing tool",
    "description": "Contains answers to a question to be verified by the test suite",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "required": [
      "question_id",
      "answer_response"
    ],
    "properties": {
      "question_id": {
        "description": "The question_id as received on Question API",
        "anyOf": [
          {
              "description": "Identifier for messages sent at the beginning and end of every set of tests",
              "type": "string",
              "enum": [
                  "pre_tests_message",
                  "post_tests_message"
              ]
          },
          {
              "description": "Identifier for questions within a test",
              "type": "string",
              "pattern": "^test_[0-9a-z_]+$"
          }
      ]
      },
      "answer_response": {
        "description": "Answer or answers to be verified",
        "oneOf": [
          {
            "description": "Multi choice response",
            "type": "array",
            "items": 
              {
                "type": "string"
              },
            "examples": [
              ["answer_1", "answer_3"]
            ]
          },
          {
            "description": "Single choice response",
            "type": "string"
          },
          {
            "description": "Action response",
            "type": "null"
          }
        ]
      }
    }
  }

Example:

{
    "question_id": "pre_tests_message", 
    "answer_response": null 
}

HTTP status code 202

HTTP status code 400

Returned when question_id is missing from request