StartExam API

Create Test

Method creates a new empty test in StartExam.

Request Information

Scheme

POST https://api.startexam.com/v1/create-test

URI Parameters

None

Body Parameters

Json with the CreateTestQuery:

  • ProjectId - Project identifier which will be a test container. Projects list can be found in your account details page at app.startexam.com
  • Title - name of the test. Max length: 200 symbols
  • Type - type of the entity. Supported values: test , survey

Request Example

POST https://api.startexam.com/v1/create-test 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
Content-Length: 118
Date: Fri, 03 May 2024 01:19:11 GMT

{
  "projectId": "3f53d7c3-26ec-4caf-884e-60d5293c4e1d",
  "title": "My new Test (created by API)",
  "type": "test"
}

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

Method returns identifier of the created test:

  • TestId - ID of the created test.

Response Example

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

{
  "testId": "cb7912d9-4595-4379-aafb-0d611ebe84ca"
}

Use TestId as a URL parameter to redirect user to the Test Settings page:
https://app.startexam.com/Test/Settings?testId=cb7912d9-4595-4379-aafb-0d611ebe84ca

Try Method