How to Send POST Request to Create Exam List?

Need to create an exam list programmatically? You can easily send a POST request to create your exam list via the Qualiphy API.

Why it matters:

• Sending a POST request allows you to automate the creation of your exam lists, making it faster and easier to manage multiple exams without doing it manually.

To send a POST request to create an exam list use the endpoint below:

POST /api/exam_list/

This endpoint is used to fetch a list of available practice exams. This endpoint allows users to retrieve detailed information about the exams that can be scheduled or taken by patients. It helps in automating the workflow of fetching exam details for further processing or display.

Refer to the specifics below:

Example Request Payload:

{
  "api_key": "your_api_key"
}

Parameters:

• api_key (string) - Required: API key for authentication

Request Fields:

No request fields available

Responses:

Status Code: 200 - Successful response

{
  "exams": [
    {
      "id": 1,
      "price": "100",
      "title": "Sample Exam 1",
      "rx_type": 1,
      "attachments": [
        "Lab"
      ],
      "attachments_required": 2
    },
    {
      "id": 2,
      "price": "50",
      "title": "Sample Exam 2",
      "rx_type": 1,
      "attachments": [],
      "attachments_required": 1
    }
  ]
}

Status Code: 400 - Invalid Request

{
  "error_message": "Invalid Request."
}

Status Code: 401 - Unauthorized access

{
  "error_message": "Unauthorized access."
}

Status Code: 500 - Server error

{
  "error_message": "Something went wrong. Please try again later."
}

Response Fields:

Field	Explanation
id	This is the exam id.
title	This is the exam title.
attachments_required	If the exam requires attachments to be uploaded then a value of 2 will be returned, if a value of 1 is returned then an attachment is not required
price	If no price is included then this will be null and there is no special pricing for this exam.
rx_type	If value is 1 then this is not an RX exam, if value is 2 then this is an RX exam. You can send multiple exams that are not of RX type 2 but ONLY one exam of RX type 1.
attachments	Each element in the array corresponds to an exam attachment