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

GET https://api.startexam.com/v1/tests?projectId=9d30c43f-2756-4ec4-aa70-fe2861dcbc36 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: Mon, 16 Dec 2019 10:09:32 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

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

{
  "tests": [
    {
      "testId": "e6a3bafa-cdba-48f3-bd5c-945b8e1d043c",
      "projectId": "9d30c43f-2756-4ec4-aa70-fe2861dcbc36",
      "type": "test",
      "status": "active",
      "title": "IQ Test",
      "description": "Standard intelligence quotient assessment",
      "time": "02:00:00",
      "modified": "2019-02-16T10:09:32Z"
    },
    {
      "testId": "a45654cb-cadd-4951-93cc-8dca318ad15b",
      "projectId": "9d30c43f-2756-4ec4-aa70-fe2861dcbc36",
      "type": "survey",
      "status": "deleted",
      "title": "Motivation Survey",
      "description": null,
      "time": null,
      "modified": "1989-12-16T10:09:32Z"
    }
  ]
}

Try Method