Water & Sewerage Service API

Water-sewerage Contract

Apply for new water connection.

Citizen or employee can apply for new water connection.

post

/wc/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

WaterConnectionall of

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_create' \
  --header 'Content-Type: application/json'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "rainWaterHarvesting": true,
      "waterSource": "text",
      "meterId": "text",
      "meterInstallationDate": 1,
      "proposedPipeSize": 1,
      "actualPipeSize": 1,
      "proposedTaps": 1,
      "actualTaps": 1,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Water connection application is submitted sucessfully

Update existing water connection details.

Updates a given water connection with newer details.

post

/wc/_update

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

WaterConnectionall of

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_update' \
  --header 'Content-Type: application/json'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "rainWaterHarvesting": true,
      "waterSource": "text",
      "meterId": "text",
      "meterInstallationDate": 1,
      "proposedPipeSize": 1,
      "actualPipeSize": 1,
      "proposedTaps": 1,
      "actualTaps": 1,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Water connection details has been submitted sucessfully with new details

Get the list of exsting water connections.

Get the water connections list based on the input parameters.

post

/wc/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of water connection.

connectionNostring[]

List of water connection numbers to search..

oldConnectionNostring[]

List of old water connection numbers to search..

mobileNumberinteger · int64

MobileNumber of owner whose water connection is to be searched.

fromDatenumber

Fetches properties with created time after fromDate.

toDatenumber

Fetches properties with created time till toDate.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "WaterConnection": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "rainWaterHarvesting": true,
      "waterSource": "text",
      "meterId": "text",
      "meterInstallationDate": 1,
      "proposedPipeSize": 1,
      "actualPipeSize": 1,
      "proposedTaps": 1,
      "actualTaps": 1,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Successful response

Apply for new Sewerage connection.

Citizen or employee can apply for new Sewerage connection.

post

/swc/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

SewerageConnectionall of

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_create' \
  --header 'Content-Type: application/json'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Sewerage connection application is submitted sucessfully

Update existing Sewerage connection details.

Updates a given Sewerage connection with newer details.

post

/swc/_update

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

SewerageConnectionall of

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_update' \
  --header 'Content-Type: application/json'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Sewerage connection details has been submitted sucessfully with new details

Get the list of exsting Sewerage connections.

Get the water connections list based on the input parameters.

post

/swc/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of Sewerage connection.

connectionNostring[]

List of Sewerage connection numbers to search..

oldConnectionNostring[]

List of old Sewerage connection numbers to search..

mobileNumberinteger · int64

MobileNumber of owner whose Sewerage connection is to be searched.

fromDatenumber

Fetches Sewerage Connection with created time after fromDate.

toDatenumber

Fetches Sewerage Connection with created time till toDate.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "SewerageConnections": [
    {
      "id": "text",
      "tenantId": "text",
      "propertyId": "text",
      "applicationNo": "text",
      "applicationStatus": "text",
      "connectionNo": "text",
      "oldConnectionNo": "text",
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "Active",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "relationship": "FATHER"
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ]
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Successful response