Water & Sewerage Service API | DIGIT Specifications

Apply for new water connection.

post

Citizen or employee can apply for new water connection.

Body

Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update

WaterConnectionall ofOptional

and

Responses

201

Water connection application is submitted sucessfully

*/*

400

Failed to submit application

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 832

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "WaterConnection": {
    "tenantId": "text",
    "propertyId": "text",
    "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",
        "relationship": "FATHER",
        "additionalDetails": {}
      }
    ],
    "roadCuttingInfo": [
      {
        "roadType": "text",
        "roadCuttingArea": 1
      }
    ],
    "connectionCategory": "text",
    "connectionType": "text",
    "additionalDetails": {},
    "rainWaterHarvesting": true,
    "waterSource": "text",
    "meterId": "text",
    "meterInstallationDate": 1,
    "proposedPipeSize": 1,
    "actualPipeSize": 1,
    "proposedTaps": 1,
    "actualTaps": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 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": {}
        }
      ]
    }
  ]
}

Update existing water connection details.

post

Updates a given water connection with newer details.

Body

Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update

WaterConnectionall ofOptional

and

Responses

200

Water connection details has been submitted sucessfully with new details

*/*

400

Update water connection details failed

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 832

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "WaterConnection": {
    "tenantId": "text",
    "propertyId": "text",
    "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",
        "relationship": "FATHER",
        "additionalDetails": {}
      }
    ],
    "roadCuttingInfo": [
      {
        "roadType": "text",
        "roadCuttingArea": 1
      }
    ],
    "connectionCategory": "text",
    "connectionType": "text",
    "additionalDetails": {},
    "rainWaterHarvesting": true,
    "waterSource": "text",
    "meterId": "text",
    "meterInstallationDate": 1,
    "proposedPipeSize": 1,
    "actualPipeSize": 1,
    "proposedTaps": 1,
    "actualTaps": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 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": {}
        }
      ]
    }
  ]
}

Get the list of exsting water connections.

post

Get the water connections list based on the input parameters.

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[]Optional

List of system generated ids of water connection.

connectionNostring[]Optional

List of water connection numbers to search..

oldConnectionNostring[]Optional

List of old water connection numbers to search..

mobileNumberinteger · int64Optional

MobileNumber of owner whose water connection is to be searched.

fromDatenumberOptional

Fetches properties with created time after fromDate.

toDatenumberOptional

Fetches properties with created time till toDate.

Body

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.

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: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

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: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringRead-onlyOptional

Responses

200

Successful response

*/*

400

Invalid input.

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/wc/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text"
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 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": {}
        }
      ]
    }
  ]
}

Apply for new Sewerage connection.

post

Citizen or employee can apply for new Sewerage connection.

Body

Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update

SewerageConnectionall ofOptional

and

Responses

201

Sewerage connection application is submitted sucessfully

*/*

400

Failed to submit application

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 754

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "SewerageConnection": {
    "tenantId": "text",
    "propertyId": "text",
    "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",
        "relationship": "FATHER",
        "additionalDetails": {}
      }
    ],
    "roadCuttingInfo": [
      {
        "roadType": "text",
        "roadCuttingArea": 1
      }
    ],
    "connectionCategory": "text",
    "connectionType": "text",
    "additionalDetails": {},
    "noOfWaterClosets": 1,
    "proposedWaterClosets": 1,
    "noOfToilets": 1,
    "proposedToilets": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Update existing Sewerage connection details.

post

Updates a given Sewerage connection with newer details.

Body

Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update

SewerageConnectionall ofOptional

and

Responses

200

Sewerage connection details has been submitted sucessfully with new details

*/*

400

Update Sewerage connection details failed

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 754

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "SewerageConnection": {
    "tenantId": "text",
    "propertyId": "text",
    "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",
        "relationship": "FATHER",
        "additionalDetails": {}
      }
    ],
    "roadCuttingInfo": [
      {
        "roadType": "text",
        "roadCuttingArea": 1
      }
    ],
    "connectionCategory": "text",
    "connectionType": "text",
    "additionalDetails": {},
    "noOfWaterClosets": 1,
    "proposedWaterClosets": 1,
    "noOfToilets": 1,
    "proposedToilets": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Get the list of exsting Sewerage connections.

post

Get the water connections list based on the input parameters.

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[]Optional

List of system generated ids of Sewerage connection.

connectionNostring[]Optional

List of Sewerage connection numbers to search..

oldConnectionNostring[]Optional

List of old Sewerage connection numbers to search..

mobileNumberinteger · int64Optional

MobileNumber of owner whose Sewerage connection is to be searched.

fromDatenumberOptional

Fetches Sewerage Connection with created time after fromDate.

toDatenumberOptional

Fetches Sewerage Connection with created time till toDate.

Body

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.

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: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

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: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringRead-onlyOptional

Responses

200

Successful response

*/*

400

Invalid input.

*/*

post

POST /egov-foundation/Water-Sewerage-1.0/1.0.0/swc/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text"
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
          "additionalDetails": {}
        }
      ],
      "plumberInfo": [
        {
          "tenantId": "text",
          "name": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "roadCuttingInfo": [
        {
          "roadType": "text",
          "roadCuttingArea": 1
        }
      ],
      "connectionExecutionDate": 1,
      "connectionCategory": "text",
      "connectionType": "text",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    },
    {
      "noOfWaterClosets": 1,
      "proposedWaterClosets": 1,
      "noOfToilets": 1,
      "proposedToilets": 1
    }
  ]
}

Water-sewerage Contract

Apply for new water connection.

Update existing water connection details.

Get the list of exsting water connections.

Apply for new Sewerage connection.

Update existing Sewerage connection details.

Get the list of exsting Sewerage connections.