Water Connection

Water Service APIs

API specs to create, update, and search properties.

Apply for new Water connection.

post

/wc/_create

Body

RequestInfoRequestInfo

WaterConnectionWaterConnection

This is lightweight property object that can be used as reference by definitions needing property linking. Actual Property Object extends this to include more elaborate attributes of the property.

disconnectRequestboolean

isCreateCallboolean

isOldDataEncryptionRequestboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//wc/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"WaterConnection":{"additionalDetails":{},"auditDetails":{},"connectionCategory":"text","connectionType":"text","oldApplication":false,"processInstance":{"action":"text","businessId":"text","businessService":"text","moduleName":"text","state":{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]},"tenantId":"text","assignes":[{"roles":[{}]}],"documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}]},"status":"Active","connectionHolders":[{"mobileNumber":"text","name":"text","ownerType":"text","status":"ACTIVE","documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}],"roles":[{}]}],"documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}],"plumberInfo":[{"additionalDetails":{},"auditDetails":{}}],"roadCuttingInfo":[{"auditDetails":{},"status":"ACTIVE"}]}}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {},
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "processInstance": {
        "action": "text",
        "businessId": "text",
        "businessService": "text",
        "moduleName": "text",
        "state": {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        },
        "tenantId": "text",
        "assignes": [
          {
            "roles": [
              {}
            ]
          }
        ],
        "documents": [
          {
            "auditDetails": {},
            "documentType": "text",
            "fileStoreId": "text",
            "status": "ACTIVE"
          }
        ]
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadType": "text",
      "tenantId": "text",
      "waterSource": "text",
      "status": "Active",
      "connectionHolders": [
        {
          "mobileNumber": "text",
          "name": "text",
          "ownerType": "text",
          "status": "ACTIVE",
          "documents": [
            {
              "auditDetails": {},
              "documentType": "text",
              "fileStoreId": "text",
              "status": "ACTIVE"
            }
          ],
          "roles": [
            {}
          ]
        }
      ],
      "documents": [
        {
          "auditDetails": {},
          "documentType": "text",
          "fileStoreId": "text",
          "status": "ACTIVE"
        }
      ],
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {}
        }
      ],
      "roadCuttingInfo": [
        {
          "auditDetails": {},
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK

encryptOldData

post

/wc/_encryptOldData

Query parameters

accountIdstring

applicationNumberstring[]

applicationStatusstring[]

applicationTypestring

assigneestring

connectionNumberstring[]

doorNostring

fromDateinteger · int64

idsstring[]

isCountCallboolean

isFilestoreIdRequireboolean

isInternalCallboolean

isPropertyDetailsRequiredboolean

isSkipLevelSearchboolean

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldConnectionNumberstring

ownerIdsstring[]

ownerNamestring

propertyIdstring

propertyIdsstring[]

searchTypestring

sortOrderstring · enum

Options: ASC, DESC

statusstring

tenantIdstring

tenantIdsstring[]

toDateinteger · int64

userIdsstring[]

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//wc/_encryptOldData' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {},
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "processInstance": {
        "action": "text",
        "businessId": "text",
        "businessService": "text",
        "moduleName": "text",
        "state": {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        },
        "tenantId": "text",
        "assignes": [
          {
            "roles": [
              {}
            ]
          }
        ],
        "documents": [
          {
            "auditDetails": {},
            "documentType": "text",
            "fileStoreId": "text",
            "status": "ACTIVE"
          }
        ]
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadType": "text",
      "tenantId": "text",
      "waterSource": "text",
      "status": "Active",
      "connectionHolders": [
        {
          "mobileNumber": "text",
          "name": "text",
          "ownerType": "text",
          "status": "ACTIVE",
          "documents": [
            {
              "auditDetails": {},
              "documentType": "text",
              "fileStoreId": "text",
              "status": "ACTIVE"
            }
          ],
          "roles": [
            {}
          ]
        }
      ],
      "documents": [
        {
          "auditDetails": {},
          "documentType": "text",
          "fileStoreId": "text",
          "status": "ACTIVE"
        }
      ],
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {}
        }
      ],
      "roadCuttingInfo": [
        {
          "auditDetails": {},
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK

plainSearch

post

/wc/_plainsearch

Query parameters

accountIdstring

applicationNumberstring[]

applicationStatusstring[]

applicationTypestring

assigneestring

connectionNumberstring[]

doorNostring

fromDateinteger · int64

idsstring[]

isCountCallboolean

isFilestoreIdRequireboolean

isInternalCallboolean

isPropertyDetailsRequiredboolean

isSkipLevelSearchboolean

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldConnectionNumberstring

ownerIdsstring[]

ownerNamestring

propertyIdstring

propertyIdsstring[]

searchTypestring

sortOrderstring · enum

Options: ASC, DESC

statusstring

tenantIdstring

tenantIdsstring[]

toDateinteger · int64

userIdsstring[]

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//wc/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {},
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "processInstance": {
        "action": "text",
        "businessId": "text",
        "businessService": "text",
        "moduleName": "text",
        "state": {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        },
        "tenantId": "text",
        "assignes": [
          {
            "roles": [
              {}
            ]
          }
        ],
        "documents": [
          {
            "auditDetails": {},
            "documentType": "text",
            "fileStoreId": "text",
            "status": "ACTIVE"
          }
        ]
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadType": "text",
      "tenantId": "text",
      "waterSource": "text",
      "status": "Active",
      "connectionHolders": [
        {
          "mobileNumber": "text",
          "name": "text",
          "ownerType": "text",
          "status": "ACTIVE",
          "documents": [
            {
              "auditDetails": {},
              "documentType": "text",
              "fileStoreId": "text",
              "status": "ACTIVE"
            }
          ],
          "roles": [
            {}
          ]
        }
      ],
      "documents": [
        {
          "auditDetails": {},
          "documentType": "text",
          "fileStoreId": "text",
          "status": "ACTIVE"
        }
      ],
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {}
        }
      ],
      "roadCuttingInfo": [
        {
          "auditDetails": {},
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK

Get the list of exsting Water connections.

post

/wc/_search

Query parameters

accountIdstring

applicationNumberstring[]

applicationStatusstring[]

applicationTypestring

assigneestring

connectionNumberstring[]

doorNostring

fromDateinteger · int64

idsstring[]

isCountCallboolean

isFilestoreIdRequireboolean

isInternalCallboolean

isPropertyDetailsRequiredboolean

isSkipLevelSearchboolean

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldConnectionNumberstring

ownerIdsstring[]

ownerNamestring

propertyIdstring

propertyIdsstring[]

searchTypestring

sortOrderstring · enum

Options: ASC, DESC

statusstring

tenantIdstring

tenantIdsstring[]

toDateinteger · int64

userIdsstring[]

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//wc/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {},
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "processInstance": {
        "action": "text",
        "businessId": "text",
        "businessService": "text",
        "moduleName": "text",
        "state": {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        },
        "tenantId": "text",
        "assignes": [
          {
            "roles": [
              {}
            ]
          }
        ],
        "documents": [
          {
            "auditDetails": {},
            "documentType": "text",
            "fileStoreId": "text",
            "status": "ACTIVE"
          }
        ]
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadType": "text",
      "tenantId": "text",
      "waterSource": "text",
      "status": "Active",
      "connectionHolders": [
        {
          "mobileNumber": "text",
          "name": "text",
          "ownerType": "text",
          "status": "ACTIVE",
          "documents": [
            {
              "auditDetails": {},
              "documentType": "text",
              "fileStoreId": "text",
              "status": "ACTIVE"
            }
          ],
          "roles": [
            {}
          ]
        }
      ],
      "documents": [
        {
          "auditDetails": {},
          "documentType": "text",
          "fileStoreId": "text",
          "status": "ACTIVE"
        }
      ],
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {}
        }
      ],
      "roadCuttingInfo": [
        {
          "auditDetails": {},
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK

Update existing Water connection details.

post

/wc/_update

Body

RequestInfoRequestInfo

WaterConnectionWaterConnection

This is lightweight property object that can be used as reference by definitions needing property linking. Actual Property Object extends this to include more elaborate attributes of the property.

disconnectRequestboolean

isCreateCallboolean

isOldDataEncryptionRequestboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//wc/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"WaterConnection":{"additionalDetails":{},"auditDetails":{},"connectionCategory":"text","connectionType":"text","oldApplication":false,"processInstance":{"action":"text","businessId":"text","businessService":"text","moduleName":"text","state":{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]},"tenantId":"text","assignes":[{"roles":[{}]}],"documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}]},"status":"Active","connectionHolders":[{"mobileNumber":"text","name":"text","ownerType":"text","status":"ACTIVE","documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}],"roles":[{}]}],"documents":[{"auditDetails":{},"documentType":"text","fileStoreId":"text","status":"ACTIVE"}],"plumberInfo":[{"additionalDetails":{},"auditDetails":{}}],"roadCuttingInfo":[{"auditDetails":{},"status":"ACTIVE"}]}}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {},
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "processInstance": {
        "action": "text",
        "businessId": "text",
        "businessService": "text",
        "moduleName": "text",
        "state": {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        },
        "tenantId": "text",
        "assignes": [
          {
            "roles": [
              {}
            ]
          }
        ],
        "documents": [
          {
            "auditDetails": {},
            "documentType": "text",
            "fileStoreId": "text",
            "status": "ACTIVE"
          }
        ]
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadType": "text",
      "tenantId": "text",
      "waterSource": "text",
      "status": "Active",
      "connectionHolders": [
        {
          "mobileNumber": "text",
          "name": "text",
          "ownerType": "text",
          "status": "ACTIVE",
          "documents": [
            {
              "auditDetails": {},
              "documentType": "text",
              "fileStoreId": "text",
              "status": "ACTIVE"
            }
          ],
          "roles": [
            {}
          ]
        }
      ],
      "documents": [
        {
          "auditDetails": {},
          "documentType": "text",
          "fileStoreId": "text",
          "status": "ACTIVE"
        }
      ],
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {}
        }
      ],
      "roadCuttingInfo": [
        {
          "auditDetails": {},
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK