Get Tests

Method returns tests list from StartExam using specified filters.

Request Information

Scheme

GET https://api.startexam.com/v1/tests?projectId={projectId}&type={type}&status={status}

URI Parameters

• projectId - optional filter by project identifier, guid from StartExam.
• type - optional filter by type. Supported values: test , survey.
• status - optional filter by status. Supported values: active , archive , deleted.

Body Parameters

None.

Request Example

• Json Request

GET https://api.startexam.com/v1/tests?projectId=84d146f8-d2da-4607-ac42-3e96321552d5 HTTP/1.1
Host: api.startexam.com
Accept: application/json; charset=utf-8
Authorization: SharedKey 99:f52JP7GQd0xqrBzMO1NWTNVGzLENymgdUXu/Ie++NX4=
Content-Type: application/json; charset=utf-8
Date: Thu, 21 Nov 2024 06:57:25 GMT

Date and Authorization headers are constructed in the standard way.

Response Information

HTTP status code

200 OK, 400 Bad Request, etc. according the response processing guide.

Content-Type

Json.

Content

• testId - test id, guid.
• projectId - project id, guid.
• type - test type, test/survey.
• status - test status, active/archive/deleted.
• title - test name, string.
• description - test description, string, nullable.
• time - test time limit, HH:MM:SS, nullable.
• modified - test last modified in UTC, ISO 8601.

Response Example

• Json Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 657

{
  "tests": [
    {
      "testId": "c216bc8f-b2f1-46d2-b021-644f68fd6628",
      "projectId": "84d146f8-d2da-4607-ac42-3e96321552d5",
      "type": "test",
      "status": "active",
      "title": "IQ Test",
      "description": "Standard intelligence quotient assessment",
      "time": "02:00:00",
      "modified": "2024-01-21T06:57:25Z"
    },
    {
      "testId": "ed191f47-138e-499f-a3b1-35881d754c3a",
      "projectId": "84d146f8-d2da-4607-ac42-3e96321552d5",
      "type": "survey",
      "status": "deleted",
      "title": "Motivation Survey",
      "description": null,
      "time": null,
      "modified": "1994-11-21T06:57:25Z"
    }
  ]
}

Try Method