v2

latestOpenAPI 3.0.0raw.githubusercontent.com2024-01-0511518.9 KB

Returns data about a section within a submission

get/submissions/{submissionId}/sections/{sectionId}

Path parameters

submissionIdstring required

The ID of the submission that sections should be returned from

sectionIdstring required

The Section ID to retrieve the correct sections

Response

success

sectionIdstring
sectionTitlestring
sectionStatusstring
questionIdsstring[]

Example response

{
  "sectionId": "ESSENTIAL",
  "sectionTitle": "Essential Information",
  "sectionStatus": "COMPLETE",
  "questionIds": [
    "APPLICANT_TYPE",
    "APPLICANT_ORG_NAME",
    "APPLICANT_ORG_ADDRESS",
    "APPLICANT_ORG_COMPANIES_HOUSE",
    "APPLICANT_ORG_COMPANIES_HOUSE",
    "APPLICANT_AMOUNT"
  ]
}