Water & Sewerage Service API

Water-sewerage Contract

Apply for new water connection.

Citizen or employee can apply for new water connection.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_create

Body

application/json

Details for the new property + RequestHeader meta data.

any

Response

201400

Water connection application is submitted sucessfully

Body

*/*

WaterConnectionarray of WaterConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

201400

{
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "rainWaterHarvesting": false,
      "waterSource": "text",
      "meterId": "text",
      "proposedPipeSize": 0,
      "actualPipeSize": 0,
      "proposedTaps": 0,
      "actualTaps": 0
    }
  ]
}

Update existing water connection details.

Updates a given water connection with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_update

Body

application/json

Request of water connection details.

RequestInfoany

WaterConnectionWaterConnection (all of)

Response

200400

Water connection details has been submitted sucessfully with new details

Body

*/*

WaterConnectionarray of WaterConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "rainWaterHarvesting": false,
      "waterSource": "text",
      "meterId": "text",
      "proposedPipeSize": 0,
      "actualPipeSize": 0,
      "proposedTaps": 0,
      "actualTaps": 0
    }
  ]
}

Get the list of exsting water connections.

Get the water connections list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_search

Query parameters

Body

application/json

RequestHeader meta data.

any

Response

200400

Successful response

Body

*/*

WaterConnectionarray of WaterConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400

{
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "rainWaterHarvesting": false,
      "waterSource": "text",
      "meterId": "text",
      "proposedPipeSize": 0,
      "actualPipeSize": 0,
      "proposedTaps": 0,
      "actualTaps": 0
    }
  ]
}

Apply for new Sewerage connection.

Citizen or employee can apply for new Sewerage connection.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_create

Body

application/json

Details for the new Sewerage Connection + RequestHeader meta data.

RequestInfoany

SewerageConnectionSewerageConnection (all of)

Response

201400

Sewerage connection application is submitted sucessfully

Body

*/*

SewerageConnectionsarray of SewerageConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "noOfWaterClosets": 0,
      "proposedWaterClosets": 0,
      "noOfToilets": 0,
      "proposedToilets": 0
    }
  ]
}

Update existing Sewerage connection details.

Updates a given Sewerage connection with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_update

Body

application/json

Request of Sewerage connection details.

SewerageConnectionSewerageConnection (all of)

Response

200400

Sewerage connection details has been submitted sucessfully with new details

Body

*/*

SewerageConnectionsarray of SewerageConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "noOfWaterClosets": 0,
      "proposedWaterClosets": 0,
      "noOfToilets": 0,
      "proposedToilets": 0
    }
  ]
}

Get the list of exsting Sewerage connections.

Get the water connections list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_search

Query parameters

Body

application/json

RequestHeader meta data.

any

Response

200400

Successful response

Body

*/*

SewerageConnectionsarray of SewerageConnection (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400

{
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "status": "Active",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 0
        }
      ],
      "connectionCategory": "text",
      "connectionType": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "noOfWaterClosets": 0,
      "proposedWaterClosets": 0,
      "noOfToilets": 0,
      "proposedToilets": 0
    }
  ]
}