Skip to main content

Get List

GET 
/api/treatments

API Endpoint: Retrieve Treatments​

Purpose​

This endpoint allows users to retrieve a list of treatments available in the system. It is useful for applications that need to display or utilize treatment data for various purposes, such as healthcare applications or patient management systems.

Request Format​

  • Method: GET
  • URL: https://app.udyogx.in/api/treatments
  • Request Body: This endpoint does not require a request body.

Response Structure​

The response from the server will typically include a JSON object containing the following keys:

  • status: Indicates the success or failure of the request.
  • data: An array of treatment objects, where each object includes details about a specific treatment.
  • message: A descriptive message providing additional context about the response.

Example Response​

{
	"status": "success",
	"data": [
		{
			"id": "1",
			"name": "Treatment A",
			"description": "Description of Treatment A"
		},
		{
			"id": "2",
			"name": "Treatment B",
			"description": "Description of Treatment B"
		}
	],
	"message": "Treatments retrieved successfully."
}

This structure allows clients to easily parse and utilize the treatment data returned by the API.

Responses​