Property Tax Service API
Last updated
Was this helpful?
Last updated
Was this helpful?
Creates new property with basic information related to land and owner information. Can be integrated with other modules like Water and Sewerage or Trade License to act as base entity against which water connection or trade license can be issued
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 6052
{
"Property": {
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
{
"area": "text",
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
},
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{
"Properties": [
{
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
],
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}POST /egovernmets-faundation/PT-2.0/1.0.0/property/_migration HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 902
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{}POST /egovernmets-faundation/PT-2.0/1.0.0/property/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 902
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{
"Properties": [
{
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
],
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Get the properties list based on the input parameters.
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 902
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{
"Properties": [
{
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
],
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Updates a given Property with newer details.
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 6052
{
"Property": {
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
{
"area": "text",
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
},
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{
"Properties": [
{
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
],
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}POST /egovernmets-faundation/PT-2.0/1.0.0/property/fuzzy/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 902
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
}{
"Properties": [
{
"id": "text",
"tenantId": "text",
"accountId": "text",
"propertyId": "text",
"oldPropertyId": "text",
"acknowldgementNumber": "text",
"propertyType": "text",
"surveyId": "text",
"address": {
"additionalDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"area": "text",
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": {
"href": "text",
"templated": true
}
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"channel": "SYSTEM",
"source": "MUNICIPAL_RECORDS",
"creationReason": "CREATE",
"documents": [
{
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text",
"status": "ACTIVE"
}
],
"institution": {
"additionalDetails": {},
"designation": "text",
"id": "text",
"name": "text",
"nameOfAuthorizedPerson": "text",
"tenantId": "text",
"type": "text"
},
"landArea": 1,
"superBuiltUpArea": 1,
"units": [
{
"active": true,
"additionalDetails": {},
"arv": 1,
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"constructionDetail": {
"builtUpArea": 1,
"carpetArea": 1,
"constructionDate": 1,
"constructionType": "text",
"dimensions": {},
"plinthArea": 1,
"superBuiltUpArea": 1
},
"floorNo": 1,
"id": "text",
"occupancyDate": 1,
"occupancyType": "text",
"tenantId": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text"
}
],
"usageCategory": "text",
"linkedProperties": [
"text"
],
"noOfFloors": 1,
"owners": [
{
"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": "FATHER",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"status": "ACTIVE",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
}
],
"ownershipCategory": "text",
"status": "ACTIVE",
"workflow": {
"action": "text",
"assignes": [
{
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"createdDate": 1,
"dob": 1,
"fatherOrHusbandName": "text",
"gender": "text",
"id": 1,
"identificationMark": "text",
"lastModifiedBy": "text",
"lastModifiedDate": 1,
"locale": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"pwdExpiryDate": 1,
"salutation": "text",
"signature": "text",
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"tenantId": "text"
}
],
"tenantId": "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",
"notificationAction": "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"
},
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"additionalDetails": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"empty": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
],
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Creates new property with basic information related to land and owner information. Can be integrated with other modules like Water and Sewerage or Trade License to act as base entity against which water connection or trade license can be issued
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
Property created sucessfully
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2643
{
"RequestHeader": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"Property": {
"id": "text",
"propertyId": "text",
"tenantId": "text",
"surveyId": "text",
"accountId": "text",
"oldPropertyId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"acknowldgementIds": "text",
"propertyType": "VACANT",
"ownershipCategory": "text",
"owners": [
{
"name": "text",
"mobileNumber": "text",
"gender": "text",
"fatherOrHusbandName": "text",
"correspondenceAddress": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"institutionId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"relationship": "FATHER",
"additionalDetails": {}
}
],
"institution": {
"id": "text",
"tenantId": "text",
"type": "text",
"designation": "text",
"nameOfAuthorizedPerson": "text",
"additionalDetails": {}
},
"creationReason": "NEWPROPERTY",
"noOfFloors": 1,
"landArea": 1,
"superBuiltUpArea": 1,
"source": "MUNICIPAL_RECORDS",
"channel": "SYSTEM",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"unit": {
"id": "text",
"tenantId": "text",
"floorNo": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text",
"occupancyType": "OWNER",
"occupancyDate": 1,
"constructionDetail": {
"id": "text",
"carpetArea": 1,
"builtUpArea": 1,
"plinthArea": 1,
"superBuiltUpArea": 1,
"constructionType": "text",
"constructionDate": 1,
"dimensions": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
},
"additionalDetails": {}
},
"additionalDetails": {}
}
}{}Updates a given Property with newer details.
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
Update Property successful
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2643
{
"RequestHeader": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"Property": {
"id": "text",
"propertyId": "text",
"tenantId": "text",
"surveyId": "text",
"accountId": "text",
"oldPropertyId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"acknowldgementIds": "text",
"propertyType": "VACANT",
"ownershipCategory": "text",
"owners": [
{
"name": "text",
"mobileNumber": "text",
"gender": "text",
"fatherOrHusbandName": "text",
"correspondenceAddress": "text",
"isPrimaryOwner": true,
"ownerShipPercentage": 1,
"ownerType": "text",
"institutionId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"relationship": "FATHER",
"additionalDetails": {}
}
],
"institution": {
"id": "text",
"tenantId": "text",
"type": "text",
"designation": "text",
"nameOfAuthorizedPerson": "text",
"additionalDetails": {}
},
"creationReason": "NEWPROPERTY",
"noOfFloors": 1,
"landArea": 1,
"superBuiltUpArea": 1,
"source": "MUNICIPAL_RECORDS",
"channel": "SYSTEM",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"unit": {
"id": "text",
"tenantId": "text",
"floorNo": "text",
"unitType": "Building, Room, Kitchen etc.",
"usageCategory": "text",
"occupancyType": "OWNER",
"occupancyDate": 1,
"constructionDetail": {
"id": "text",
"carpetArea": 1,
"builtUpArea": 1,
"plinthArea": 1,
"superBuiltUpArea": 1,
"constructionType": "text",
"constructionDate": 1,
"dimensions": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
},
"additionalDetails": {}
},
"additionalDetails": {}
}
}{}Get the properties list based on the input parameters.
Unique id for a tenant.
Name of owner whose property is to be searched.
List of system generated ids of properties.
List of constructionDetailNumbers to search.
List of oldPropertyIds to search..
MobileNumber of owner whose property is to be searched.
Fetches properties with created time after fromDate.
Fetches properties with created time till toDate.
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
Hash describing the current RequestHeader
Successful response
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 570
{
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
}{}The API will delete the property associated with the given propertyId from the system The API works in idempotent manner.
Unique id for a tenant.
The properrtyId to be deactivated
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
Hash describing the current RequestHeader
Deleted Property successful
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_delete HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 570
{
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
}{}The API will delete the property associated with the given propertyId from the system The API works in idempotent manner.
Unique id for a tenant.
The properrtyId to be deactivated
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
Hash describing the current RequestHeader
Deleted Property successful
POST /egovernmets-faundation/PT-2.0/1.0.0/property/_cancel HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 570
{
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
}{}