Returns data about a section within a submission

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

Request

Base URL
http://localhost:8080
Auth
none declared
TypeScript
https://skmtc.dev/cabinet-office/apis/application-submission-api/docs/submissions/:submissionId/sections/:sectionId/get.ts
A function with typed inputs. Its response is checked against the schema.

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"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.