Online Building Plan Approval Service API

Land Service

Crete land detail in land registry

Citizen, Employee, Or an Architect can create for new build plan approval

post

/v1/land/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

LandInfoLandInforequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "ownershipCategory": "text",
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text",
      "additionalDetails": {}
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": true,
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "institutionId": "text",
        "relationship": "FATHER",
        "additionalDetails": {},
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      }
    ],
    "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": {}
      }
    ]
  }
}

Reqeuset submitted successfully

Update existing application.

Updates a given application with newer details.

post

/v1/land/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

LandInfoLandInforequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "ownershipCategory": "text",
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text",
      "additionalDetails": {}
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": true,
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "institutionId": "text",
        "relationship": "FATHER",
        "additionalDetails": {},
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      }
    ],
    "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": {}
      }
    ]
  }
}

successfully updated

Get the list of land information.

Get the list of land information..

post

/v1/land/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of BPA applications.

landUIdstring

land identifier.

mobileNumberinteger · int64

MobileNumber of land owners

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Successful response

Apply for new building plan application.

Citizen, Employee, Or an Architect can apply for new build plan approval

post

/v1/bpa/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Application submitted successfully

Update existing application.

Updates a given application with newer details.

post

/v1/bpa/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Application updated successfully

Get the list of application by passing the diffrent search criteria.

Get the properties list based on the input parameters.

post

/v1/bpa/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of BPA applications.

edcrNumberstring

edcr Number.

applicationNostring

application numbers

mobileNumberinteger · int64

MobileNumber of land owners

approvalNostring

approval no

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Successful response

Building Permission Application Services

Crete land detail in land registry

Citizen, Employee, Or an Architect can create for new build plan approval

post

/v1/land/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

LandInfoLandInforequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "ownershipCategory": "text",
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text",
      "additionalDetails": {}
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": true,
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "institutionId": "text",
        "relationship": "FATHER",
        "additionalDetails": {},
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      }
    ],
    "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": {}
      }
    ]
  }
}

Reqeuset submitted successfully

Update existing application.

Updates a given application with newer details.

post

/v1/land/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

LandInfoLandInforequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "ownershipCategory": "text",
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text",
      "additionalDetails": {}
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": true,
        "ownerShipPercentage": 1,
        "ownerType": "text",
        "institutionId": "text",
        "relationship": "FATHER",
        "additionalDetails": {},
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      }
    ],
    "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": {}
      }
    ]
  }
}

successfully updated

Get the list of land information.

Get the list of land information..

post

/v1/land/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of BPA applications.

landUIdstring

land identifier.

mobileNumberinteger · int64

MobileNumber of land owners

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Successful response

Apply for new building plan application.

Citizen, Employee, Or an Architect can apply for new build plan approval

post

/v1/bpa/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Application submitted successfully

Update existing application.

Updates a given application with newer details.

post

/v1/bpa/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Application updated successfully

Get the list of application by passing the diffrent search criteria.

Get the properties list based on the input parameters.

post

/v1/bpa/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

List of system generated ids of BPA applications.

edcrNumberstring

edcr Number.

applicationNostring

application numbers

mobileNumberinteger · int64

MobileNumber of land owners

approvalNostring

approval no

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "landInfo": {
      "id": "text",
      "landUId": "text",
      "landUniqueRegNo": "text",
      "tenantId": "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",
          "materializedPath": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "latitude": 1,
          "longitude": 1,
          "additionalDetails": {}
        }
      },
      "ownershipCategory": "text",
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text",
        "additionalDetails": {}
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": true,
          "ownerShipPercentage": 1,
          "ownerType": "text",
          "institutionId": "text",
          "relationship": "FATHER",
          "additionalDetails": {},
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ]
        }
      ],
      "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": {}
        }
      ]
    },
    "workflow": {
      "action": "text",
      "comments": "text",
      "assignes": [
        "text"
      ],
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {},
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  }
}

Successful response

BPA Calculator Services

Calculate the Fee and create Demand for the building plan application

Calculate the Fee and create Demand for the building plan application

post

/bpa-calculator/v1/_calculate

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

CalculationCriteriaobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/bpa-calculator/v1/_calculate' \
  --header 'Content-Type: application/json'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculations": [
    {
      "applicationNumber": "text",
      "bpa": {
        "id": "text",
        "applicationNo": "text",
        "approvalNo": "text",
        "accountId": "text",
        "edcrNumber": "text",
        "riskType": "text",
        "landId": "text",
        "tenantId": "text",
        "status": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "additionalDetails": {},
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "tenantId": "text",
      "feeType": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 1,
          "Category": "TAX"
        }
      ]
    }
  ]
}

Successfull