Merge · Schema

ScreeningQuestionAnswerRequest

# The ScreeningQuestionAnswer Object ### Description The `ScreeningQuestionAnswer` object is used to represent candidate responses to a screening question, for a specific application. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
remote_id stringnull The third-party API ID of the matching object.
question stringnull The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding `screening_question_answers.question` to the
answer stringnull The candidate’s response to the screening question.
integration_params objectnull
linked_account_params objectnull
View JSON Schema on GitHub

JSON Schema

merge-screeningquestionanswerrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScreeningQuestionAnswerRequest",
  "title": "ScreeningQuestionAnswerRequest",
  "type": "object",
  "properties": {
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "question": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The screening question associated with the candidate\u2019s answer. To determine the data type of the answer, you can expand on the screening question by adding `screening_question_answers.question` to the `expand` query parameter."
    },
    "answer": {
      "type": [
        "string",
        "null"
      ],
      "description": "The candidate\u2019s response to the screening question."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "description": "# The ScreeningQuestionAnswer Object\n### Description\nThe `ScreeningQuestionAnswer` object is used to represent candidate responses to a screening question, for a specific application.\n\n### Usage Example\nTODO"
}