GET test-results/…

Retrieves test results for a given test definition for the calling user, or for a given ticket.

Depending on the test's settings, there may be multiple test results (attempts) for the same test and user.

Resource URL

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

or

https://www.drillster.com/api/2.1.1/test-results/{test_id}/{user_id}

or

https://www.drillster.com/api/2.1.1/test-results/{test_id}/{ticket}

or

https://www.drillster.com/api/2.1.1/test-results/{test_id}/{pin}

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
user_id
optional, unless a status is included		 String The user ID to retrieve the test results for.
ticket
optional		 String In case of an anonymous test, an anonymous test ticket may be used as well.

See POST /api/2.1.1/test/{test_id}/tickets for information about obtaining test tickets.
pin
optional		 String A substitute for an anonymous test ticket.

See POST /api/2.1.1/test/{test_id}/tickets for information about obtaining test PINs.
detail
optional		 String constant Controls how much detail is returned in the response. Possible values:

  • FULL – return all available details
If the value is omitted, not all test results details are returned.
status
optional		 String constant An optional string constant to control which test result(s) are returned. Possible values:

  • INCOMPLETE – Return the incomplete test result, i.e. a test that is still in progress. This may return zero or one test results.
  • LASTCOMPLETED – Return the last completed test result. This may return zero or one test results.
If this value is omitted, all available test results are returned.
resultStart
optional		 Integer The index number (zero-based) of the first test result to include in the result. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of test results included in the result. Defaults to 0.
resultSize
optional		 Integer The maximum number of test results to include in the result. If not specified, the results for all (remaining) test results are returned, with a maximum of 10.

Response

A 2.1.1 TestResults object, with details about zero or more test results.

Error responses

The following error situations are possible:

ID Response code Description
missing_test_key 400 (Bad request) No test key given
unknown_test 404 (Not found) Requested test was not found
invalid_detail 400 (Bad request) The specified detail level is invalid
pin_or_ticket_required 401 (Unauthorized) Supply a valid PIN or ticket to access this test
not_authorized 401 (Unauthorized) You are not authorized to see the test results

 

Last updated on