Logo

Exam List

POST

https://staging-api.qualiphy.me/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.

Parameters
  • api_key string

    Required

    API key for authentication


Response

200
400
401
500

Response Fields Explanation

FieldExplanation
idThis is the exam id
titleThis is the exam title
attachments_requiredIf 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
priceIf 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
attachmentsEach element in the array corresponds to an exam attachment

Example Request Payload:

Response Example

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