List Completed Smart IA Sessions

GET /smart-ia/sessions/completed

Convenience method that only return "Completed" Smart IA Sessions

Returns a paginated list of completed sessions

Query parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • sessionId string(uuid) Required

        The unique identifier for the Smart IA session (UUID).

      • startDate string(date-time) Required

        The start date and time of the Smart IA session.

      • endDate string(date-time) Required

        The end date and time of the Smart IA session.

      • status string Required

        The status of the Smart IA session, for completed sessions this will always be "COMPLETED".

        Value is COMPLETED.

      • user object Required

        Information about the the Smart IA session user.

        Hide user attributes Show user attributes object
        • userId string(uuid) Required

          The unique identifier for the user (UUID).

        • username string Required

          The username of the user.

        • upn string

          The Unique Pupil Number (UPN) of the user.

        • externalId string

          External user identifier provided during onboarding or signup

        • fullName string Required

          The full name of the user.

        • firstName string Required

          The first name of the user.

        • middleName string

          The middle name of the user.

        • lastName string Required

          The last name of the user.

        • emails array[string(email)]

          A list of all email addresses associated with the user.

        • gender string Required

          The gender of the user.

          Values are male, female, other, or unknown. Default value is unknown.

        • dateOfBirth string(date)

          The date of birth of the user.

      • test object Required

        Information about the the Smart IA session test.

        Hide test attributes Show test attributes object
        • testId string(uuid) Required

          The unique identifier for the Smart IA test (UUID).

        • 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.

      • result object Required

        Information about the the Smart IA session result.

        Hide result attributes Show result attributes object
        • createdDate string(date-time) Required

          The date and time when the Smart IA result was created.

        • level string Required

          The result outcome

        • duration string(duration) Required

          The duration of the session, in ISO 8601 duration format

    • pagination object Required
      Hide pagination attributes Show pagination attributes object
      • total integer(int32) Required

        The total number of items available.

      • limit integer(int32) Required

        The maximum number of results to return per page.

        Minimum value is 1, maximum value is 100. Default value is 100.

      • offset integer(int32) Required

        Indicates the starting position or index (offset)

        Default value is 0.

      • previousCursor string(byte) | null Required

        The cursor for pagination. Encoded byte string used to navigate between pages.

      • nextCursor string(byte) | null Required

        The cursor for pagination. Encoded byte string used to navigate between pages.
  • 401

    Invalid authentication credentials

  • 403

    Not authorised to access this resource

GET /smart-ia/sessions/completed 
curl \
 -X GET https://connect.century.tech/api/v1/smart-ia/sessions/completed
Response examples (200) 
{
  "data": [
    {
      "test": {
        "name": "English Smart Initial Assessment",
        "testId": "c5a77fda-7174-446f-a4f5-0f47ccbf15ce",
        "subject": "English",
        "testVersionId": "33ea5957-9320-4300-998d-c8fba3646aaa"
      },
      "user": {
        "emails": [
          "john.doe@email.com"
        ],
        "gender": "male",
        "userId": "2716be03-cec0-4027-a373-46b53fb6a08d",
        "fullName": "John Doe",
        "lastName": "Doe",
        "username": "john_doe",
        "firstName": "John",
        "externalId": "External_ID_123"
      },
      "result": {
        "level": "L1 - Lower",
        "duration": "PT1H30M",
        "createdDate": "2023-07-10T15:30:00.000Z"
      },
      "status": "COMPLETED",
      "endDate": "2023-07-10T15:30:00.000Z",
      "sessionId": "d93ba3c3-2482-4b0d-8b99-42a20e68e11e",
      "startDate": "2023-07-10T14:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 100,
    "offset": 0,
    "nextCursor": "eyJsaW1pdCI6MiwibGVmdDpbWyJlbmREYXRlIiwiZGVzYyJdXX0=",
    "previousCursor": null
  }
}