Request format

In order to create a structured section response you must send a JSON:API spec JSON object representing a structured section response.

Required attributes

No attributes are required, and none are currently writable.

📘
Why can't I edit the date_from_answer or date_to_answer?
These attributes should be written directly to the corresponding Answer record of the structured section response

Required relationships

The structured_section and answerable relationships are both required. Answerable can be one of the following types: applications or job_seekers.

Examples

{
  "data": {
    "type": "structured_section_responses",
    "attributes": {},
    "relationships": {
      "structured_section": {
        "data": {
          "type": "structured_sections",
          "id": "2"
        }
      },
      "answerable": {
        "data": {
          "type": "applications",
          "id": "4"
        }
      }
    }
  }
}

{
  "data": {
    "type": "structured_section_responses",
    "attributes": {},
    "relationships": {
      "structured_section": {
        "data": {
          "type": "structured_sections",
          "id": "2"
        }
      },
      "answerable": {
        "data": {
          "type": "applications",
          "id": "4"
        }
      },
      "answers": {
        "data": [
          {
            "type": "answers",
            "temp-id": "temp-a-1",
            "method": "create"
          }
        ]
      }
    }
  },
  "included": [
    {
        "type": "answers",
        "temp-id": "temp-a-1",
        "attributes": {
            "text_answer": "A new answer!"
        },
        "relationships": {
            "answerable": {
                "data": {
                    "type": "applications",
                    "id": "4"
                }
            },
            "question": {
                "data": {
                    "id": "10",
                    "type": "questions"
                }
            }
        }
    }
  ]
}