Water Connection

Water Service APIs

API specs to create, update, and search properties.

Apply for new Water connection.

post

Body

application/json

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

disconnectRequestbooleanOptional

isCreateCallbooleanOptional

isOldDataEncryptionRequestbooleanOptional

Responses

200

OK

application/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/wc/_create

HTTPcURLJavaScriptPython

POST /wc/_create HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 3961

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "WaterConnection": {
    "additionalDetails": {},
    "applicationStatus": "text",
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "connectionCategory": "text",
    "connectionHolders": [
      {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "institutionId": "text",
        "isPrimaryOwner": true,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "ownerInfoUuid": "text",
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "salutation": "text",
        "signature": "text",
        "status": "ACTIVE",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      }
    ],
    "connectionType": "text",
    "disconnectionExecutionDate": 1,
    "disconnectionReason": "text",
    "documents": [
      {
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "documentType": "text",
        "documentUid": "text",
        "fileStoreId": "text",
        "id": "text",
        "status": "ACTIVE"
      }
    ],
    "isDisconnectionTemporary": true,
    "meterId": "text",
    "meterInstallationDate": 1,
    "noOfTaps": 1,
    "oldApplication": false,
    "pipeSize": 1,
    "plumberInfo": [
      {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "correspondenceAddress": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": "text",
        "licenseNo": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "text"
      }
    ],
    "processInstance": {
      "action": "text",
      "assignes": [
        {
          "emailId": "text",
          "id": 1,
          "mobileNumber": "text",
          "name": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "businessId": "text",
      "businessService": "text",
      "comment": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "moduleName": "text",
      "state": {
        "actions": [
          {
            "action": "text",
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "currentState": "text",
            "nextState": "text",
            "roles": [
              "text"
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "applicationStatus": "text",
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessServiceId": "text",
        "docUploadRequired": true,
        "isStartState": true,
        "isStateUpdatable": true,
        "isTerminateState": true,
        "sla": 1,
        "state": "text",
        "tenantId": "text",
        "uuid": "text"
      },
      "tenantId": "text"
    },
    "propertyId": "text",
    "proposedPipeSize": 1,
    "proposedTaps": 1,
    "roadCuttingArea": 1,
    "roadCuttingInfo": [
      {
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "id": "text",
        "roadCuttingArea": 1,
        "roadType": "text",
        "status": "ACTIVE"
      }
    ],
    "roadType": "text",
    "status": "Active",
    "tenantId": "text",
    "waterSource": "text"
  },
  "disconnectRequest": true,
  "isCreateCall": true,
  "isOldDataEncryptionRequest": true
}

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionHolders": [
        {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": true,
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "status": "ACTIVE",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "correspondenceAddress": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "name": "text",
          "relationship": "text"
        }
      ],
      "processInstance": {
        "action": "text",
        "assignes": [
          {
            "emailId": "text",
            "id": 1,
            "mobileNumber": "text",
            "name": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadCuttingInfo": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "id": "text",
          "roadCuttingArea": 1,
          "roadType": "text",
          "status": "ACTIVE"
        }
      ],
      "roadType": "text",
      "status": "Active",
      "tenantId": "text",
      "waterSource": "text"
    }
  ]
}

encryptOldData

post

Query parameters

accountIdstringOptional

applicationNumberstring[]Optional

applicationStatusstring[]Optional

applicationTypestringOptional

assigneestringOptional

connectionNumberstring[]Optional

doorNostringOptional

fromDateinteger · int64Optional

idsstring[]Optional

isCountCallbooleanOptional

isFilestoreIdRequirebooleanOptional

isInternalCallbooleanOptional

isPropertyDetailsRequiredbooleanOptional

isSkipLevelSearchbooleanOptional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldConnectionNumberstringOptional

ownerIdsstring[]Optional

ownerNamestringOptional

propertyIdstringOptional

propertyIdsstring[]Optional

searchTypestringOptional

sortOrderstring · enumOptionalPossible values:

statusstringOptional

tenantIdstringOptional

tenantIdsstring[]Optional

toDateinteger · int64Optional

userIdsstring[]Optional

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/wc/_encryptOldData

HTTPcURLJavaScriptPython

POST /wc/_encryptOldData HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionHolders": [
        {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": true,
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "status": "ACTIVE",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "correspondenceAddress": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "name": "text",
          "relationship": "text"
        }
      ],
      "processInstance": {
        "action": "text",
        "assignes": [
          {
            "emailId": "text",
            "id": 1,
            "mobileNumber": "text",
            "name": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadCuttingInfo": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "id": "text",
          "roadCuttingArea": 1,
          "roadType": "text",
          "status": "ACTIVE"
        }
      ],
      "roadType": "text",
      "status": "Active",
      "tenantId": "text",
      "waterSource": "text"
    }
  ]
}

plainSearch

post

Query parameters

accountIdstringOptional

applicationNumberstring[]Optional

applicationStatusstring[]Optional

applicationTypestringOptional

assigneestringOptional

connectionNumberstring[]Optional

doorNostringOptional

fromDateinteger · int64Optional

idsstring[]Optional

isCountCallbooleanOptional

isFilestoreIdRequirebooleanOptional

isInternalCallbooleanOptional

isPropertyDetailsRequiredbooleanOptional

isSkipLevelSearchbooleanOptional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldConnectionNumberstringOptional

ownerIdsstring[]Optional

ownerNamestringOptional

propertyIdstringOptional

propertyIdsstring[]Optional

searchTypestringOptional

sortOrderstring · enumOptionalPossible values:

statusstringOptional

tenantIdstringOptional

tenantIdsstring[]Optional

toDateinteger · int64Optional

userIdsstring[]Optional

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/wc/_plainsearch

HTTPcURLJavaScriptPython

POST /wc/_plainsearch HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionHolders": [
        {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": true,
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "status": "ACTIVE",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "correspondenceAddress": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "name": "text",
          "relationship": "text"
        }
      ],
      "processInstance": {
        "action": "text",
        "assignes": [
          {
            "emailId": "text",
            "id": 1,
            "mobileNumber": "text",
            "name": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadCuttingInfo": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "id": "text",
          "roadCuttingArea": 1,
          "roadType": "text",
          "status": "ACTIVE"
        }
      ],
      "roadType": "text",
      "status": "Active",
      "tenantId": "text",
      "waterSource": "text"
    }
  ]
}

Get the list of exsting Water connections.

post

Query parameters

accountIdstringOptional

applicationNumberstring[]Optional

applicationStatusstring[]Optional

applicationTypestringOptional

assigneestringOptional

connectionNumberstring[]Optional

doorNostringOptional

fromDateinteger · int64Optional

idsstring[]Optional

isCountCallbooleanOptional

isFilestoreIdRequirebooleanOptional

isInternalCallbooleanOptional

isPropertyDetailsRequiredbooleanOptional

isSkipLevelSearchbooleanOptional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldConnectionNumberstringOptional

ownerIdsstring[]Optional

ownerNamestringOptional

propertyIdstringOptional

propertyIdsstring[]Optional

searchTypestringOptional

sortOrderstring · enumOptionalPossible values:

statusstringOptional

tenantIdstringOptional

tenantIdsstring[]Optional

toDateinteger · int64Optional

userIdsstring[]Optional

Body

application/json

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/wc/_search

HTTPcURLJavaScriptPython

POST /wc/_search HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionHolders": [
        {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": true,
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "status": "ACTIVE",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "correspondenceAddress": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "name": "text",
          "relationship": "text"
        }
      ],
      "processInstance": {
        "action": "text",
        "assignes": [
          {
            "emailId": "text",
            "id": 1,
            "mobileNumber": "text",
            "name": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadCuttingInfo": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "id": "text",
          "roadCuttingArea": 1,
          "roadType": "text",
          "status": "ACTIVE"
        }
      ],
      "roadType": "text",
      "status": "Active",
      "tenantId": "text",
      "waterSource": "text"
    }
  ]
}

Update existing Water connection details.

post

Body

application/json

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

disconnectRequestbooleanOptional

isCreateCallbooleanOptional

isOldDataEncryptionRequestbooleanOptional

Responses

200

OK

application/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/wc/_update

HTTPcURLJavaScriptPython

POST /wc/_update HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 3961

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "WaterConnection": {
    "additionalDetails": {},
    "applicationStatus": "text",
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "connectionCategory": "text",
    "connectionHolders": [
      {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "institutionId": "text",
        "isPrimaryOwner": true,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "ownerInfoUuid": "text",
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "salutation": "text",
        "signature": "text",
        "status": "ACTIVE",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      }
    ],
    "connectionType": "text",
    "disconnectionExecutionDate": 1,
    "disconnectionReason": "text",
    "documents": [
      {
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "documentType": "text",
        "documentUid": "text",
        "fileStoreId": "text",
        "id": "text",
        "status": "ACTIVE"
      }
    ],
    "isDisconnectionTemporary": true,
    "meterId": "text",
    "meterInstallationDate": 1,
    "noOfTaps": 1,
    "oldApplication": false,
    "pipeSize": 1,
    "plumberInfo": [
      {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "correspondenceAddress": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": "text",
        "licenseNo": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "text"
      }
    ],
    "processInstance": {
      "action": "text",
      "assignes": [
        {
          "emailId": "text",
          "id": 1,
          "mobileNumber": "text",
          "name": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "businessId": "text",
      "businessService": "text",
      "comment": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "moduleName": "text",
      "state": {
        "actions": [
          {
            "action": "text",
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "currentState": "text",
            "nextState": "text",
            "roles": [
              "text"
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "applicationStatus": "text",
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessServiceId": "text",
        "docUploadRequired": true,
        "isStartState": true,
        "isStateUpdatable": true,
        "isTerminateState": true,
        "sla": 1,
        "state": "text",
        "tenantId": "text",
        "uuid": "text"
      },
      "tenantId": "text"
    },
    "propertyId": "text",
    "proposedPipeSize": 1,
    "proposedTaps": 1,
    "roadCuttingArea": 1,
    "roadCuttingInfo": [
      {
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "id": "text",
        "roadCuttingArea": 1,
        "roadType": "text",
        "status": "ACTIVE"
      }
    ],
    "roadType": "text",
    "status": "Active",
    "tenantId": "text",
    "waterSource": "text"
  },
  "disconnectRequest": true,
  "isCreateCall": true,
  "isOldDataEncryptionRequest": true
}

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "TotalCount": 1,
  "WaterConnection": [
    {
      "additionalDetails": {},
      "applicationNo": "text",
      "applicationStatus": "text",
      "applicationType": "text",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "channel": "text",
      "connectionCategory": "text",
      "connectionExecutionDate": 1,
      "connectionHolders": [
        {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": true,
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "text",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "status": "ACTIVE",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        }
      ],
      "connectionNo": "text",
      "connectionType": "text",
      "dateEffectiveFrom": 1,
      "disconnectionExecutionDate": 1,
      "disconnectionReason": "text",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "status": "ACTIVE"
        }
      ],
      "id": "text",
      "isDisconnectionTemporary": true,
      "meterId": "text",
      "meterInstallationDate": 1,
      "noOfTaps": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "pipeSize": 1,
      "plumberInfo": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "correspondenceAddress": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": "text",
          "licenseNo": "text",
          "mobileNumber": "text",
          "name": "text",
          "relationship": "text"
        }
      ],
      "processInstance": {
        "action": "text",
        "assignes": [
          {
            "emailId": "text",
            "id": 1,
            "mobileNumber": "text",
            "name": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "propertyId": "text",
      "proposedPipeSize": 1,
      "proposedTaps": 1,
      "roadCuttingArea": 1,
      "roadCuttingInfo": [
        {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "id": "text",
          "roadCuttingArea": 1,
          "roadType": "text",
          "status": "ACTIVE"
        }
      ],
      "roadType": "text",
      "status": "Active",
      "tenantId": "text",
      "waterSource": "text"
    }
  ]
}