Get Cohort

GET /smart-ia/cohorts/{cohortId}
Api key

Get a Smart IA Cohort

Path parameters

Responses

  • 200 application/json

    OK

    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

  • 404

    Cohort not found.

GET /smart-ia/cohorts/{cohortId} 
curl \
 --request GET 'https://connect.century.tech/api/v1/smart-ia/cohorts/c334f818-0281-4f47-855a-3a3d0e356cfd' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "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"
  }
}