Property Tax APIs

Create New Property

Creates new property.

post

https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0https://egov-micro-dev.egovernments.org

/property/_create

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

Body

application/json

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

Responses

201

Property created sucessfully

text/plain

400

Property(s) creation failed

post

/property/_create

HTTPcURLJavaScriptPython

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": {}
  }
}

{}

Update Existing Property

Update existing property.

post

https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0https://egov-micro-dev.egovernments.org

/property/_update

Updates a given Property with newer details.

Body

application/json

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

Responses

200

Update Property successful

text/plain

Responseobject

Update Property successful

400

Update Property failed

post

/property/_update

HTTPcURLJavaScriptPython

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": {}
  }
}

{}

Fetch Properties List

Get the list of properties defined in the system.

post

https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0https://egov-micro-dev.egovernments.org

/property/_search

Get the properties list based on the input parameters.

Query parameters

tenantIdstringRequired

Unique id for a tenant.

namestring · nullableOptional

Name of owner whose property is to be searched.

idsstringOptional

List of system generated ids of properties.

constructionDetailNumbersstring · min: 4 · max: 128Optional

List of constructionDetailNumbers to search.

oldpropertyidsstring · min: 4 · max: 128Optional

List of oldPropertyIds to search..

mobileNumberinteger · int64Optional

MobileNumber of owner whose property is to be searched.

fromDatenumber · doubleOptional

Fetches properties with created time after fromDate.

toDatenumber · doubleOptional

Fetches properties with created time till toDate.

Body

application/json

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.

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

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

keystring · max: 256Optional

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

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringOptional

signaturestringOptional

Hash describing the current RequestHeader

Responses

200

Successful response

text/plain

Responseobject

Successful response

400

Invalid input.

post

/property/_search

HTTPcURLJavaScriptPython

POST /egovernmets-faundation/PT-2.0/1.0.0/property/_search?tenantId=text 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"
}

{}

Delete Existing Property

Delete existing property.

post

https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0https://egov-micro-dev.egovernments.org

/property/_delete

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

Query parameters

tenantIdstringRequired

Unique id for a tenant.

propertyIdstring · min: 4 · max: 128Required

The properrtyId to be deactivated

Body

application/json

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.

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

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

keystring · max: 256Optional

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

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringOptional

signaturestringOptional

Hash describing the current RequestHeader

Responses

200

Deleted Property successful

text/plain

Responseobject

Deleted Property successful

404

Delete Property failed

post

/property/_delete

HTTPcURLJavaScriptPython

POST /egovernmets-faundation/PT-2.0/1.0.0/property/_delete?tenantId=text&propertyId=text 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"
}

{}

Cancel Existing Property

Cancel existing property.

post

https://virtserver.swaggerhub.com/egovernmets-faundation/PT-2.0/1.0.0https://egov-micro-dev.egovernments.org

/property/_cancel

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

Query parameters

tenantIdstringRequired

Unique id for a tenant.

propertyIdstring · min: 4 · max: 128Required

The properrtyId to be deactivated

Body

application/json

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.

tsinteger · int64Required

time in epoch

actionstring · max: 32Required

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

keystring · max: 256Optional

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

msgIdstring · max: 256Required

Unique request message id from the caller

requesterIdstring · max: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringOptional

signaturestringOptional

Hash describing the current RequestHeader

Responses

200

Deleted Property successful

text/plain

Responseobject

Deleted Property successful

404

Delete Property failed

post

/property/_cancel

HTTPcURLJavaScriptPython

POST /egovernmets-faundation/PT-2.0/1.0.0/property/_cancel?tenantId=text&propertyId=text 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"
}

{}