Building Plan Calculator

Building Plan Application System APIs

The BPA calculator is one of the services in the building plan approval system used for fee calculation and demand generation.

calculate

post

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

/bpa-calculator/_calculate

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

OK

*/*

Contains the ResponseHeader and the created/updated property

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/bpa-calculator/_calculate

HTTPcURLJavaScriptPython

POST /egov-foundation/BPA/1.0.0/bpa-calculator/_calculate HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 3536

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "CalculationCriteria": [
    {
      "applicationNo": "text",
      "bpa": {
        "accountId": "text",
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "documents": [
          {
            "additionalDetails": {},
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ],
        "edcrNumber": "text",
        "landId": "text",
        "landInfo": {
          "additionalDetails": {},
          "address": {
            "additionDetails": "text",
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "buildingName": "text",
            "city": "text",
            "country": "text",
            "district": "text",
            "doorNo": "text",
            "geoLocation": {
              "additionalDetails": {},
              "id": "text",
              "latitude": 1,
              "longitude": 1
            },
            "landmark": "text",
            "locality": "[Circular Reference]",
            "pincode": "text",
            "plotNo": "text",
            "region": "text",
            "state": "text",
            "street": "text",
            "tenantId": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "channel": "CFC_COUNTER",
          "documents": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text"
            }
          ],
          "institution": {
            "additionalDetails": {},
            "designation": "text",
            "id": "text",
            "nameOfAuthorizedPerson": "text",
            "tenantId": "text",
            "type": "text"
          },
          "landUniqueRegNo": "text",
          "owners": [
            {
              "aadhaarNumber": "text",
              "accountLocked": false,
              "active": false,
              "additionalDetails": {},
              "altContactNumber": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "bloodGroup": "text",
              "correspondenceAddress": "text",
              "correspondenceCity": "text",
              "correspondencePinCode": "text",
              "createdBy": "text",
              "createdDate": 1,
              "dob": 1,
              "documents": [
                {
                  "additionalDetails": {},
                  "auditDetails": {
                    "createdBy": "text",
                    "createdTime": 1,
                    "lastModifiedBy": "text",
                    "lastModifiedTime": 1
                  },
                  "documentType": "text",
                  "documentUid": "text",
                  "fileStoreId": "text",
                  "id": "text"
                }
              ],
              "emailId": "text",
              "fatherOrHusbandName": "text",
              "gender": "text",
              "id": 1,
              "identificationMark": "text",
              "institutionId": "text",
              "isPrimaryOwner": false,
              "lastModifiedBy": "text",
              "lastModifiedDate": 1,
              "locale": "text",
              "mobileNumber": "text",
              "name": "text",
              "otpReference": "text",
              "ownerId": "text",
              "ownerShipPercentage": 1,
              "ownerType": "text",
              "pan": "text",
              "password": "text",
              "permanentAddress": "text",
              "permanentCity": "text",
              "permanentPinCode": "text",
              "photo": "text",
              "pwdExpiryDate": 1,
              "relationship": "FATHER",
              "roles": [
                {
                  "code": "text",
                  "description": "text",
                  "name": "text"
                }
              ],
              "salutation": "text",
              "signature": "text",
              "tenantId": "text",
              "type": "text",
              "userName": "text",
              "uuid": "text"
            }
          ],
          "ownershipCategory": "text",
          "source": "FIELD_SURVEY",
          "status": "ACTIVE",
          "tenantId": "text",
          "unit": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "floorNo": "text",
              "id": "text",
              "occupancyDate": 1,
              "occupancyType": "text",
              "tenantId": "text",
              "unitType": "Building, Room, Kitchen etc.",
              "usageCategory": "text"
            }
          ]
        },
        "status": "text",
        "tenantId": "text",
        "workflow": {
          "action": "text",
          "assignes": [
            "text"
          ],
          "comments": "text",
          "varificationDocuments": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text"
            }
          ]
        }
      },
      "tenantId": "text",
      "feeType": "text"
    }
  ]
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculations": [
    {
      "applicationNumber": "text",
      "bpa": {
        "accountId": "text",
        "additionalDetails": {},
        "applicationDate": 1,
        "applicationNo": "text",
        "approvalDate": 1,
        "approvalNo": "text",
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "documents": [
          {
            "additionalDetails": {},
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ],
        "edcrNumber": "text",
        "id": "text",
        "landId": "text",
        "landInfo": {
          "additionalDetails": {},
          "address": {
            "additionDetails": "text",
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "buildingName": "text",
            "city": "text",
            "country": "text",
            "district": "text",
            "doorNo": "text",
            "geoLocation": {
              "additionalDetails": {},
              "id": "text",
              "latitude": 1,
              "longitude": 1
            },
            "id": "text",
            "landmark": "text",
            "locality": "[Circular Reference]",
            "pincode": "text",
            "plotNo": "text",
            "region": "text",
            "state": "text",
            "street": "text",
            "tenantId": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "channel": "CFC_COUNTER",
          "documents": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text"
            }
          ],
          "id": "text",
          "institution": {
            "additionalDetails": {},
            "designation": "text",
            "id": "text",
            "nameOfAuthorizedPerson": "text",
            "tenantId": "text",
            "type": "text"
          },
          "landUId": "text",
          "landUniqueRegNo": "text",
          "owners": [
            {
              "aadhaarNumber": "text",
              "accountLocked": false,
              "active": false,
              "additionalDetails": {},
              "altContactNumber": "text",
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "bloodGroup": "text",
              "correspondenceAddress": "text",
              "correspondenceCity": "text",
              "correspondencePinCode": "text",
              "createdBy": "text",
              "createdDate": 1,
              "dob": 1,
              "documents": [
                {
                  "additionalDetails": {},
                  "auditDetails": {
                    "createdBy": "text",
                    "createdTime": 1,
                    "lastModifiedBy": "text",
                    "lastModifiedTime": 1
                  },
                  "documentType": "text",
                  "documentUid": "text",
                  "fileStoreId": "text",
                  "id": "text"
                }
              ],
              "emailId": "text",
              "fatherOrHusbandName": "text",
              "gender": "text",
              "id": 1,
              "identificationMark": "text",
              "institutionId": "text",
              "isPrimaryOwner": false,
              "lastModifiedBy": "text",
              "lastModifiedDate": 1,
              "locale": "text",
              "mobileNumber": "text",
              "name": "text",
              "otpReference": "text",
              "ownerId": "text",
              "ownerShipPercentage": 1,
              "ownerType": "text",
              "pan": "text",
              "password": "text",
              "permanentAddress": "text",
              "permanentCity": "text",
              "permanentPinCode": "text",
              "photo": "text",
              "pwdExpiryDate": 1,
              "relationship": "FATHER",
              "roles": [
                {
                  "code": "text",
                  "description": "text",
                  "name": "text"
                }
              ],
              "salutation": "text",
              "signature": "text",
              "tenantId": "text",
              "type": "text",
              "userName": "text",
              "uuid": "text"
            }
          ],
          "ownershipCategory": "text",
          "source": "FIELD_SURVEY",
          "status": "ACTIVE",
          "tenantId": "text",
          "unit": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "floorNo": "text",
              "id": "text",
              "occupancyDate": 1,
              "occupancyType": "text",
              "tenantId": "text",
              "unitType": "Building, Room, Kitchen etc.",
              "usageCategory": "text"
            }
          ]
        },
        "riskType": "text",
        "status": "text",
        "tenantId": "text",
        "workflow": {
          "action": "text",
          "assignes": [
            "text"
          ],
          "comments": "text",
          "varificationDocuments": [
            {
              "additionalDetails": {},
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text"
            }
          ]
        }
      },
      "tenantId": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 1,
          "Category": "TAX"
        }
      ],
      "feeType": "text"
    }
  ]
}