Property Tax Service API

Property Tax Service API Contract

https://raw.githubusercontent.com/egovernments/Core-Platform/service-contracts/contracts/urban/property-service-contract'

Property Tax Information System

Creates new property.

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

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_create

Body

application/json

Details for the new property + RequestHeader meta data.

RequestHeaderRequestHeader

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.

PropertyProperty

Response

201400

Property created sucessfully

Body

text/plain

object

Property created sucessfully

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Update existing property.

Updates a given Property with newer details.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_update

Body

application/json

Request header for the property Request.

RequestHeaderRequestHeader

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.

PropertyProperty

Response

200400

Update Property successful

Body

text/plain

object

Update Property successful

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get the list of properties defined in the system.

Get the properties list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_search

Query parameters

Body

application/json

RequestHeader meta data.

apiInfoApiInfo

Info of the API being called

deviceDetailDeviceDetail

Contains information about the device used to access the api

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

signaturestring

Hash describing the current RequestHeader

Response

200400

Successful response

Body

text/plain

object

Successful response

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "msgId": "text"
    }),
});
const data = await response.json();

Delete existing property.

The API will delete the property associated with the given propertyId from the system The API works in idempotent manner.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_delete

Query parameters

Body

application/json

Request header for the property delete Request.

apiInfoApiInfo

Info of the API being called

deviceDetailDeviceDetail

Contains information about the device used to access the api

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

signaturestring

Hash describing the current RequestHeader

Response

200404

Deleted Property successful

Body

text/plain

object

Deleted Property successful

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "msgId": "text"
    }),
});
const data = await response.json();

Cancel existing property.

The API will delete the property associated with the given propertyId from the system The API works in idempotent manner.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_cancel

Query parameters

Body

application/json

Request header for the property delete Request.

apiInfoApiInfo

Info of the API being called

deviceDetailDeviceDetail

Contains information about the device used to access the api

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

signaturestring

Hash describing the current RequestHeader

Response

200404

Deleted Property successful

Body

text/plain

object

Deleted Property successful

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_cancel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "msgId": "text"
    }),
});
const data = await response.json();

Property Registry API Specs

Creates new property.

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

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_create

Body

application/json

propertyRequest

PropertyProperty

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Propertiesarray of Property

ResponseInfoResponseInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": 0,
          "longitude": 0
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "area": "text",
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text"
      },
      "channel": "SYSTEM",
      "source": "MUNICIPAL_RECORDS",
      "creationReason": "CREATE",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "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": 0,
      "superBuiltUpArea": 0,
      "units": [
        {
          "active": false,
          "additionalDetails": {},
          "arv": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "constructionDetail": {
            "builtUpArea": 0,
            "carpetArea": 0,
            "constructionType": "text",
            "dimensions": {},
            "plinthArea": 0,
            "superBuiltUpArea": 0
          },
          "id": "text",
          "occupancyType": "text",
          "tenantId": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text"
        }
      ],
      "usageCategory": "text",
      "linkedProperties": [
        "text"
      ],
      "owners": [
        {
          "aadhaarNumber": "text",
          "accountLocked": false,
          "active": false,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": false,
          "lastModifiedBy": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "relationship": "FATHER",
          "roles": [
            {
              "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": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "salutation": "text",
            "signature": "text",
            "userName": "text",
            "name": "text",
            "type": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "notificationAction": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessServiceId": "text",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "additionalDetails": {
        "array": false,
        "bigDecimal": false,
        "bigInteger": false,
        "binary": false,
        "boolean": false,
        "containerNode": false,
        "double": false,
        "empty": false,
        "float": false,
        "floatingPointNumber": false,
        "int": false,
        "integralNumber": false,
        "long": false,
        "missingNode": false,
        "nodeType": "ARRAY",
        "null": false,
        "number": false,
        "object": false,
        "pojo": false,
        "short": false,
        "textual": false,
        "valueNode": false
      }
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

propertyMigration

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_migration

Query parameters

Body

application/json

requestInfoWrapper

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_migration', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

plainsearch

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_plainsearch

Query parameters

Body

application/json

requestInfoWrapper

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Propertiesarray of Property

ResponseInfoResponseInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_plainsearch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": 0,
          "longitude": 0
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "area": "text",
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text"
      },
      "channel": "SYSTEM",
      "source": "MUNICIPAL_RECORDS",
      "creationReason": "CREATE",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "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": 0,
      "superBuiltUpArea": 0,
      "units": [
        {
          "active": false,
          "additionalDetails": {},
          "arv": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "constructionDetail": {
            "builtUpArea": 0,
            "carpetArea": 0,
            "constructionType": "text",
            "dimensions": {},
            "plinthArea": 0,
            "superBuiltUpArea": 0
          },
          "id": "text",
          "occupancyType": "text",
          "tenantId": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text"
        }
      ],
      "usageCategory": "text",
      "linkedProperties": [
        "text"
      ],
      "owners": [
        {
          "aadhaarNumber": "text",
          "accountLocked": false,
          "active": false,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": false,
          "lastModifiedBy": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "relationship": "FATHER",
          "roles": [
            {
              "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": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "salutation": "text",
            "signature": "text",
            "userName": "text",
            "name": "text",
            "type": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "notificationAction": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessServiceId": "text",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "additionalDetails": {
        "array": false,
        "bigDecimal": false,
        "bigInteger": false,
        "binary": false,
        "boolean": false,
        "containerNode": false,
        "double": false,
        "empty": false,
        "float": false,
        "floatingPointNumber": false,
        "int": false,
        "integralNumber": false,
        "long": false,
        "missingNode": false,
        "nodeType": "ARRAY",
        "null": false,
        "number": false,
        "object": false,
        "pojo": false,
        "short": false,
        "textual": false,
        "valueNode": false
      }
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

Get the list of properties defined in the system.

Get the properties list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_search

Query parameters

Body

application/json

requestInfoWrapper

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Propertiesarray of Property

ResponseInfoResponseInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": 0,
          "longitude": 0
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "area": "text",
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text"
      },
      "channel": "SYSTEM",
      "source": "MUNICIPAL_RECORDS",
      "creationReason": "CREATE",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "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": 0,
      "superBuiltUpArea": 0,
      "units": [
        {
          "active": false,
          "additionalDetails": {},
          "arv": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "constructionDetail": {
            "builtUpArea": 0,
            "carpetArea": 0,
            "constructionType": "text",
            "dimensions": {},
            "plinthArea": 0,
            "superBuiltUpArea": 0
          },
          "id": "text",
          "occupancyType": "text",
          "tenantId": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text"
        }
      ],
      "usageCategory": "text",
      "linkedProperties": [
        "text"
      ],
      "owners": [
        {
          "aadhaarNumber": "text",
          "accountLocked": false,
          "active": false,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": false,
          "lastModifiedBy": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "relationship": "FATHER",
          "roles": [
            {
              "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": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "salutation": "text",
            "signature": "text",
            "userName": "text",
            "name": "text",
            "type": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "notificationAction": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessServiceId": "text",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "additionalDetails": {
        "array": false,
        "bigDecimal": false,
        "bigInteger": false,
        "binary": false,
        "boolean": false,
        "containerNode": false,
        "double": false,
        "empty": false,
        "float": false,
        "floatingPointNumber": false,
        "int": false,
        "integralNumber": false,
        "long": false,
        "missingNode": false,
        "nodeType": "ARRAY",
        "null": false,
        "number": false,
        "object": false,
        "pojo": false,
        "short": false,
        "textual": false,
        "valueNode": false
      }
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

Update existing property.

Updates a given Property with newer details.

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_update

Body

application/json

propertyRequest

PropertyProperty

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Propertiesarray of Property

ResponseInfoResponseInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": 0,
          "longitude": 0
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "area": "text",
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text"
      },
      "channel": "SYSTEM",
      "source": "MUNICIPAL_RECORDS",
      "creationReason": "CREATE",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "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": 0,
      "superBuiltUpArea": 0,
      "units": [
        {
          "active": false,
          "additionalDetails": {},
          "arv": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "constructionDetail": {
            "builtUpArea": 0,
            "carpetArea": 0,
            "constructionType": "text",
            "dimensions": {},
            "plinthArea": 0,
            "superBuiltUpArea": 0
          },
          "id": "text",
          "occupancyType": "text",
          "tenantId": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text"
        }
      ],
      "usageCategory": "text",
      "linkedProperties": [
        "text"
      ],
      "owners": [
        {
          "aadhaarNumber": "text",
          "accountLocked": false,
          "active": false,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": false,
          "lastModifiedBy": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "relationship": "FATHER",
          "roles": [
            {
              "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": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "salutation": "text",
            "signature": "text",
            "userName": "text",
            "name": "text",
            "type": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "notificationAction": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessServiceId": "text",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "additionalDetails": {
        "array": false,
        "bigDecimal": false,
        "bigInteger": false,
        "binary": false,
        "boolean": false,
        "containerNode": false,
        "double": false,
        "empty": false,
        "float": false,
        "floatingPointNumber": false,
        "int": false,
        "integralNumber": false,
        "long": false,
        "missingNode": false,
        "nodeType": "ARRAY",
        "null": false,
        "number": false,
        "object": false,
        "pojo": false,
        "short": false,
        "textual": false,
        "valueNode": false
      }
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

fuzzySearch

POSThttps://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/fuzzy/_search

Query parameters

Body

application/json

requestInfoWrapper

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Propertiesarray of Property

ResponseInfoResponseInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0/property/fuzzy/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": 0,
          "longitude": 0
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "area": "text",
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text"
      },
      "channel": "SYSTEM",
      "source": "MUNICIPAL_RECORDS",
      "creationReason": "CREATE",
      "documents": [
        {
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "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": 0,
      "superBuiltUpArea": 0,
      "units": [
        {
          "active": false,
          "additionalDetails": {},
          "arv": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "constructionDetail": {
            "builtUpArea": 0,
            "carpetArea": 0,
            "constructionType": "text",
            "dimensions": {},
            "plinthArea": 0,
            "superBuiltUpArea": 0
          },
          "id": "text",
          "occupancyType": "text",
          "tenantId": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text"
        }
      ],
      "usageCategory": "text",
      "linkedProperties": [
        "text"
      ],
      "owners": [
        {
          "aadhaarNumber": "text",
          "accountLocked": false,
          "active": false,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "documents": [
            {
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "status": "ACTIVE"
            }
          ],
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "identificationMark": "text",
          "institutionId": "text",
          "isPrimaryOwner": false,
          "lastModifiedBy": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "ownerInfoUuid": "text",
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "relationship": "FATHER",
          "roles": [
            {
              "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": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "salutation": "text",
            "signature": "text",
            "userName": "text",
            "name": "text",
            "type": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "businessId": "text",
        "businessService": "text",
        "comment": "text",
        "documents": [
          {
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "status": "ACTIVE"
          }
        ],
        "id": "text",
        "moduleName": "text",
        "notificationAction": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessServiceId": "text",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "tenantId": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "additionalDetails": {
        "array": false,
        "bigDecimal": false,
        "bigInteger": false,
        "binary": false,
        "boolean": false,
        "containerNode": false,
        "double": false,
        "empty": false,
        "float": false,
        "floatingPointNumber": false,
        "int": false,
        "integralNumber": false,
        "long": false,
        "missingNode": false,
        "nodeType": "ARRAY",
        "null": false,
        "number": false,
        "object": false,
        "pojo": false,
        "short": false,
        "textual": false,
        "valueNode": false
      }
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

Property Tax Calculator Service

https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/pt-calculator-v2/src/main/resources/pt-calculator-v2-persister.yml