Response Format

Response Format

The Generic SQL API Framework returns responses in JSON format. Every response follows a consistent structure, making it easy to integrate with frontend applications, mobile apps, and third-party systems.

---

Successful Response

A successful request returns the requested data.

{
    "success": true,
    "message": "Query executed successfully.",
    "data": [
        {
            "CustomerID": 1,
            "CustomerName": "John Doe",
            "City": "Bangalore"
        }
    ]
}

---

Empty Result

If no records match the query, the request is still considered successful.

{
    "success": true,
    "message": "No records found.",
    "data": []
}

---

Error Response

If an error occurs during validation or execution, the framework returns an error response.

{
    "success": false,
    "message": "Query file not found."
}

---

Validation Error

Example:

{
    "success": false,
    "message": "Missing required parameter: CustomerID"
}

---

Database Error

Example:

{
    "success": false,
    "message": "Database connection failed."
}

---

SQL Execution Error

Example:

{
    "success": false,
    "message": "SQL execution failed."
}

---

Pagination Response

When pagination is enabled, additional metadata may be included.

{
    "success": true,
    "data": [
        {
            "CustomerID": 1,
            "CustomerName": "John Doe"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 25,
        "totalRecords": 450,
        "totalPages": 18
    }
}

---

Metadata Response

Some endpoints may return additional metadata.

{
    "success": true,
    "metadata": {
        "database": "AdventureWorks",
        "server": "SQLSERVER01",
        "executionTime": "15 ms",
        "rowsReturned": 250
    },
    "data": []
}

---

Standard Response Fields

Field	Description
success	Indicates whether the request succeeded
message	Human-readable status message
data	Query result set
pagination	Pagination information (optional)
metadata	Additional execution details (optional)

---

HTTP Status Codes

Status Code	Description
200	Request completed successfully
400	Invalid request or validation error
404	Query file not found
500	Internal server or database error

---

Best Practices

• Always check the success field before processing data.
• Handle empty result sets gracefully.
• Display meaningful error messages to users.
• Log server-side errors for troubleshooting.

---

Next Steps

Continue with:

• Error Handling
• Performance Tips
• Security Best Practices
• Framework Architecture