Create Cohort

POST /smart-ia/cohorts

Api key

Create a Smart IA Cohort

application/json

Body Required

cohort object Required

If an Academic Year ID is not provided it will default to the current Academic Year
Hide cohort attributes Show cohort attributes object
- name string Required
  
  The name of the cohort
- description string
  
  Optional cohort description
- academicYearId string(uuid)
  
  Academic Year UUID.
- tests array[object]
  Hide tests attributes Show tests attributes object
  
  testId string(uuid) Required
  
  The Smart IA test ID
  
  active boolean
  
  Activation status, set to true to activate the tests for Cohort users
  
  Default value is true.

Responses

201 application/json

Cohort created successfully.
Hide response attribute Show response attribute object
- cohort object Required
  
  Hide cohort attributes Show cohort attributes object
  
  cohortId string(uuid) Required
  
  Cohort UUID.
  
  name string Required
  
  The name of the cohort
  
  description string
  
  Optional cohort description
  
  academicYearId string(uuid) Required
  
  Academic Year UUID.
  
  tests array[object] Required
  
  Hide tests attributes Show tests attributes object
  
  testId string(uuid) Required
  
  The Smart IA test ID
  
  testVersionId string(uuid) Required
  
  The unique identifier for the Smart IA test version (UUID).
  
  name string Required
  
  The name of the Smart IA test.
  
  subject string Required
  
  The subject of the Smart IA test.
  
  activationStatus string Required
  
  Values are active, inactive, or deactivated.
400

Invalid request.
401

Invalid authentication credentials
403

Not authorised to access this resource
409

Cohort already exists.

POST /smart-ia/cohorts

curl \
 --request POST 'https://connect.century.tech/api/v1/smart-ia/cohorts' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"cohort":{"name":"Cohort 2023","description":"This cohort is for students graduating in 2023","academicYearId":"dccd109a-08ca-4a18-a277-4653ba726316","tests":[{"testId":"c5a77fda-7174-446f-a4f5-0f47ccbf15ce","active":true}]}}'

Request examples

{
  "cohort": {
    "name": "Cohort 2023",
    "description": "This cohort is for students graduating in 2023",
    "academicYearId": "dccd109a-08ca-4a18-a277-4653ba726316",
    "tests": [
      {
        "testId": "c5a77fda-7174-446f-a4f5-0f47ccbf15ce",
        "active": true
      }
    ]
  }
}

Response examples (201)

{
  "class": {
    "name": "Cohort 2023",
    "tests": [
      {
        "name": "English Initial Test",
        "testId": "c5a77fda-7174-446f-a4f5-0f47ccbf15ce",
        "subject": "English",
        "testVersionId": "38444333-7450-49d5-922d-eb16a8f30589",
        "activationStatus": "active"
      }
    ],
    "cohortId": "c334f818-0281-4f47-855a-3a3d0e356cfd",
    "description": "This cohort is for students graduating in 2023",
    "academicYearId": "dccd109a-08ca-4a18-a277-4653ba726316"
  }
}