Class Manager
GET /v1/trials/{id}

Get Trial

Path parameters

  • id string Required

    Trial id

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • classId string Required

      Class ID

    • studentId string Required

      Student ID

    • trialAt string(date) Required

      Date of trial

    • time string(time) Required

      Time of trial

    • archivedAt string(date-time) | null Required

      Archived at
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/trials/{id} 
curl \
 --request GET 'https://localhost/v1/trials/trl_xxxxxxxx'
Response examples (200) 
{
  "id": "trl_xxxxxxxxxxx",
  "companyId": "co_123123123123",
  "classId": "cls_123123123123",
  "studentId": "stu_123123123123",
  "trialAt": "2023-12-05",
  "time": "23:15",
  "archivedAt": "2024-06-12T09:39:49.000000Z"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}