Sewerage Connection

Sewerage APIs

APIs for Water & Sewerage module to create, search and update existing properties.

Apply for new Sewerage connection.

post

Body

RequestInfoobjectoptional

SewerageConnectionobjectoptional

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.

disconnectRequestbooleanoptional

isCreateCallbooleanoptional

isOldDataEncryptionRequestbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//swc/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    },
    "SewerageConnection": {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    },
    "disconnectRequest": true,
    "isCreateCall": true,
    "isOldDataEncryptionRequest": true
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "SewerageConnections": [
    {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    }
  ],
  "TotalCount": 1
}

OK

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

statusstringoptional

tenantIdstringoptional

tenantIdsstring[]optional

toDateinteger · int64optional

userIdsstring[]optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//swc/_encryptOldData' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "SewerageConnections": [
    {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    }
  ],
  "TotalCount": 1
}

OK

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

statusstringoptional

tenantIdstringoptional

tenantIdsstring[]optional

toDateinteger · int64optional

userIdsstring[]optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//swc/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "SewerageConnections": [
    {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    }
  ],
  "TotalCount": 1
}

OK

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

statusstringoptional

tenantIdstringoptional

tenantIdsstring[]optional

toDateinteger · int64optional

userIdsstring[]optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//swc/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "SewerageConnections": [
    {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    }
  ],
  "TotalCount": 1
}

OK

Update existing Sewerage connection details.

post

Body

RequestInfoobjectoptional

SewerageConnectionobjectoptional

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.

disconnectRequestbooleanoptional

isCreateCallbooleanoptional

isOldDataEncryptionRequestbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//swc/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    },
    "SewerageConnection": {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    },
    "disconnectRequest": true,
    "isCreateCall": true,
    "isOldDataEncryptionRequest": true
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "SewerageConnections": [
    {
      "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,
      "noOfToilets": 1,
      "noOfWaterClosets": 1,
      "oldApplication": false,
      "oldConnectionNo": "text",
      "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",
      "proposedToilets": 1,
      "proposedWaterClosets": 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"
    }
  ],
  "TotalCount": 1
}

OK