Code | Description |
---|---|
403 | You are not authorized to access this page. |
{ 'example_request_params': { 'nonce': '1527500365', 'timestamp': 1527500365052, 'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff', 'page': 1 }, 'example_response': { 'exams': [ { 'id': 1, 'institute_id': 1, 'name': 'New test', 'terms': null, 'created_at': '2018-11-21T00:54:59.934+01:00', 'updated_at': '2018-11-25T21:26:08.664+01:00', 'duration_minutes': 123, 'clipboard': null, 'start_time': '2018-11-21T00:54:00.000+01:00', 'mode': '01110000', 'upload_answers': false, 'token': 'b1342678e28f2b895ff6834408a33bd7', 'user_id': 5, 'end_time': null, 'restrictions': '[[false,['']],[false,['']],[false,['']],[false,['']],[false,['']],[false,['']],[true,['']]]', 'published': false, 'status': 'open', 'for_reviewing': false, 'uploaded_exam_documents_file_name': null, 'uploaded_exam_documents_content_type': null, 'uploaded_exam_documents_file_size': null, 'uploaded_exam_documents_updated_at': null, 'timezone': 0, 'use_duration': true, 'global_proctoring': true, 'global_reviewing': true, 'exam_language': 'en-GB', 'web_cam': true, 'mobile_cam': true, 'screen_share': true, 'live_proctoring': false } ] } }
Param name | Description |
---|---|
status optional |
Status filter for exams. Has to be one of draft,open,closed,deleted Validations:
|
page optional |
Page number, returns LIMIT items per page. The X-Pagination-* HTTP headers contain the information about the total number of items (X-Pagination-Item-Count), the total number of pages (X-Pagination-Page-Count), the current page number (X-Pagination-Page) and the number of items per page (X-Pagination-Limit). Validations:
|
limit optional |
Number of items returned per page. Default and maximum value is 300. Validations:
|
timestamp required |
Timestamp of the request in milliseconds. Validations:
|
nonce required |
Random number unique between the api calls made in the previous 24 hours. Validations:
|
signature required |
HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format ‘name=value’ joined by ‘?’ and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string Validations:
|
sort optional |
Sort by column(s). Stringified JSON constisting of an array of objects with column as key and sorting order as value. Example: sort=[{“column_name”: “asc”}, {“column_name”: “desc”}] Validations:
|
filter optional |
Filter by column(s). Stringified JSON consisting of an object with column as key and an object with operator as key and filtering value as value. Example: filter={“column_name”: {“operator”: “value”}} available operators: eq(equal to), gt(greater than), gte(greater than or equal to), lt(less than), lte(less than or equal to), ne(not equal to), in(in), nin(not in) Validations:
|