Online Building Plan Approval Service API
Last updated
Was this helpful?
Last updated
Was this helpful?
Citizen, Employee, Or an Architect can create for new build plan approval
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
POST /egov-foundation/BPA/1.0.0/v1/land/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1944
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"LandInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
}
}{
"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",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Updates a given application with newer details.
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
POST /egov-foundation/BPA/1.0.0/v1/land/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1944
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"LandInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
}
}{
"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",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Get the list of land information..
Unique id for a tenant.
List of system generated ids of BPA applications.
land identifier.
MobileNumber of land owners
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
POST /egov-foundation/BPA/1.0.0/v1/land/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Citizen, Employee, Or an Architect can apply for new build plan approval
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egov-foundation/BPA/1.0.0/v1/bpa/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2260
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BPA": {
"accountId": "text",
"edcrNumber": "text",
"landId": "text",
"tenantId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"landInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"additionalDetails": {}
}
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Updates a given application with newer details.
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egov-foundation/BPA/1.0.0/v1/bpa/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2260
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BPA": {
"accountId": "text",
"edcrNumber": "text",
"landId": "text",
"tenantId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"landInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"additionalDetails": {}
}
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Get the properties list based on the input parameters.
Unique id for a tenant.
List of system generated ids of BPA applications.
edcr Number.
application numbers
MobileNumber of land owners
approval no
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
POST /egov-foundation/BPA/1.0.0/v1/bpa/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Citizen, Employee, Or an Architect can create for new build plan approval
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
POST /egov-foundation/BPA/1.0.0/v1/land/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1944
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"LandInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
}
}{
"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",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Updates a given application with newer details.
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
POST /egov-foundation/BPA/1.0.0/v1/land/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1944
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"LandInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
}
}{
"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",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Get the list of land information..
Unique id for a tenant.
List of system generated ids of BPA applications.
land identifier.
MobileNumber of land owners
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
POST /egov-foundation/BPA/1.0.0/v1/land/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Citizen, Employee, Or an Architect can apply for new build plan approval
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egov-foundation/BPA/1.0.0/v1/bpa/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2260
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BPA": {
"accountId": "text",
"edcrNumber": "text",
"landId": "text",
"tenantId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"landInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"additionalDetails": {}
}
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Updates a given application with newer details.
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egov-foundation/BPA/1.0.0/v1/bpa/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2260
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BPA": {
"accountId": "text",
"edcrNumber": "text",
"landId": "text",
"tenantId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"landInfo": {
"landUniqueRegNo": "text",
"tenantId": "text",
"status": "ACTIVE",
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "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": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"additionalDetails": {}
}
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Get the properties list based on the input parameters.
Unique id for a tenant.
List of system generated ids of BPA applications.
edcr Number.
application numbers
MobileNumber of land owners
approval no
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
POST /egov-foundation/BPA/1.0.0/v1/bpa/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"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",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"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": {}
},
"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": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
}
}Calculate the Fee and create Demand for the building plan application
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
POST /egov-foundation/BPA/1.0.0/bpa-calculator/v1/_calculate HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 450
{
"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",
"edcrNumber": "text",
"landId": "text",
"tenantId": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {}
},
"tenantId": "text",
"feeType": "text"
}
]
}{
"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",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"additionalDetails": {}
},
"tenantId": "text",
"taxHeadEstimates": [
{
"taxHeadCode": "text",
"estimateAmount": 1,
"Category": "TAX"
}
],
"feeType": "text"
}
]
}