POST test/…/tickets

Generates a new anonymous test ticket or PIN.

With the test ID and the ticket it is possible to retrieve the status of the individual test attempt by calling the GET /api/2.1.1/test-results/{test_id}/{ticket} endpoint. This can be done prior, during or after the test.

Resource URL

https://www.drillster.com/api/2.1.1/test/{test_id}/tickets

Parameters

Field	Type	Description
`test_id` required	String	The ID of the test definition. This defines the test itself, not the individual instances done by users. Example value: `7OuHq7RcQOCsnGWR58TnBw`
`name` optional	String	The user's name.
`emailAddress` optional	String	The user's email address.
`reference` optional	String	An optional reference to the user.
`generatePin` optional	Boolean	Whether to generate and return a PIN code instead of a ticket value. If left off, a regular ticket is returned.
`sendAnnouncementEmail` optional	Boolean	Whether to send an announcement email to the user, including a link to the test. An `emailAddress` must be provided. If `generatePin` is selected, no email is sent. If left off, no email is sent.

Response

A 2.1.1 TestTicket object.