# Symptoms

The Symptoms API allows full CRUD operations on symptom records, including creating, listing, retrieving, updating, and deleting symptoms. Each symptom entry includes essential details, such as its unique identifier, name, and description.

# Get Symptom List

Retrieve a list of all symptoms.

  • URL: documents/symptoms/
  • Method: GET
  • Response Example:
    [
      {
        "unique_id": "abc123",
        "symptom_name": "Headache",
        "symptom_details": "A continuous pain in the head.",
        "date_created": "2023-01-01T12:00:00Z",
        "last_updated": "2023-01-01T12:00:00Z"
      },
      {
        "unique_id": "def456",
        "symptom_name": "Fever",
        "symptom_details": "An increase in body temperature.",
        "date_created": "2023-01-02T12:00:00Z",
        "last_updated": "2023-01-02T12:00:00Z"
      },
      ...
    ]
    

# Create a Symptom

Create a new symptom entry.

  • URL: documents/symptoms/
  • Method: POST
  • Request Example:
    {
      "symptom_name": "Headache",
      "symptom_details": "A continuous pain in the head."
    }
    
  • Response Example:
    {
      "unique_id": "abc123",
      "symptom_name": "Headache",
      "symptom_details": "A continuous pain in the head.",
      "date_created": "2023-01-01T12:00:00Z",
      "last_updated": "2023-01-01T12:00:00Z"
    }
    

# Get a Symptom

Retrieve details of a specific symptom by unique ID.

  • URL: documents/symptoms/<str:unique_id>/
  • Method: GET
  • Response Example:
    {
      "unique_id": "abc123",
      "symptom_name": "Headache",
      "symptom_details": "A continuous pain in the head.",
      "date_created": "2023-01-01T12:00:00Z",
      "last_updated": "2023-01-01T12:00:00Z"
    }
    

# Update a Symptom

Update an existing symptom by unique ID.

  • URL: documents/symptoms/<str:unique_id>/
  • Method: PUT
  • Request Example:
    {
      "symptom_name": "Severe Headache",
      "symptom_details": "An intense pain in the head."
    }
    
  • Response Example:
    {
      "unique_id": "abc123",
      "symptom_name": "Severe Headache",
      "symptom_details": "An intense pain in the head.",
      "date_created": "2023-01-01T12:00:00Z",
      "last_updated": "2023-01-02T08:30:00Z"
    }
    

# Delete a Symptom

Delete a symptom by unique ID.

  • URL: documents/symptoms/<str:unique_id>/
  • Method: DELETE
  • Response: 204 No Content