API for CM Dashboard

Following APIs are created for CM Dashboard

  1. Water & Sewerage Tax
  2. New Water Connection for residential and Industrial (under development)
  3. Grevances Redressal System

API Endpoint:

Method:

GET

Authentication:

Basic Auth is used as Authentication mechanism to validate requests.

Water & Sewerage Tax

This API is used to fetch Water & Sewerage Tax. Following scenarios are handled
  1. Successful Fetch
  2. data not found
  3. API Error.
Request URL:
Request Method: GET

Success Response:

    {
      "data": [
        {
          "year": "2023-04-01",
          "zone": "01",
          "service": "Charges",
          "assessment": 2,
          "demand": 7740,
          "collection": 616,
          "balance": 7124,
          "percentage_collected": 7.96
        },
        {
          "year": "2023-04-01",
          "zone": "01",
          "service": "Tax",
          "assessment": 103,
          "demand": 120246,
          "collection": 245,
          "balance": 120001,
          "percentage_collected": 0.2
        }
      ],
      "status": "SUCCESS",
      "error_desc": null,
      "error_code": null
    }

data not found

Triggered when the invalid request parameters passed.
    {
      "data": [],
      "status": "FAILURE",
      "error_desc": "data not found",
      "error_code": 1
    }

API Error.

Triggered when any other error occurs during API call.
    {
      "data": [],
      "status": "FAILURE",
      "error_desc": "API Error.",
      "error_code": 0
    }

Grevances Redressal System

This API is used to fetch Grevances Redressal System. Following scenarios are handled
  1. Successful Fetch
  2. data not found
  3. API Error.
Request URL:
Request Method: GET

Success Response:

    {
      "data": [
        {
          "year": "2023-04-01",
          "zone": "01",
          "service": "Water",
          "type_of_grievance": "Water Leakage In Service Line",
          "no_of_grievances": 2,
          "grievances_addressed": 1,
          "grievances_pending": 1,
          "revenue": null
        },
        {
          "year": "2023-04-01",
          "zone": "01",
          "service": "Sewer",
          "type_of_grievance": "Sewer Main Block",
          "no_of_grievances": 30,
          "grievances_addressed": 20,
          "grievances_pending": 10,
          "revenue": null
        }
      ],
      "status": "SUCCESS",
      "error_desc": null,
      "error_code": null
    }

data not found

Triggered when the invalid request parameters passed.
    {
      "data": [],
      "status": "FAILURE",
      "error_desc": "data not found",
      "error_code": 1
    }

API Error.

Triggered when any other error occurs during API call.
    {
      "data": [],
      "status": "FAILURE",
      "error_desc": "API Error.",
      "error_code": 0
    }