Building Plan Approval
Building Plan Application System APIs
Stakeholders apply for building permits using the eDCR scrutiny.
Citizen, Employee, Or an Architect can create for new build plan approval
Body
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
Responses
202
Reqeuset submitted successfully
*/*
400
Failed to process the request
*/*
post
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.
Body
Contract class to receive request. Array of Land items are used in case of create . Where as single Land item is used for update
Responses
202
successfully updated
*/*
400
Failed to update
*/*
post
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..
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
idsstring[]Optional
List of system generated ids of BPA applications.
landUIdstringOptional
land identifier.
mobileNumberinteger · int64Optional
MobileNumber of land owners
Body
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.
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: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Successful response
*/*
400
Invalid input.
*/*
post
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
Body
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
Responses
202
Application submitted successfully
*/*
400
Failed to process the application
*/*
post
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.
Body
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
Responses
202
Application updated successfully
*/*
400
Failed to update
*/*
post
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.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
idsstring[]Optional
List of system generated ids of BPA applications.
edcrNumberstringOptional
edcr Number.
applicationNostringOptional
application numbers
mobileNumberinteger · int64Optional
MobileNumber of land owners
approvalNostringOptional
approval no
Body
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.
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: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Successful response
*/*
400
Invalid input.
*/*
post
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": {}
}
}Query parameters
applicationNostringOptional
applicationTypestringOptional
approvalDateinteger · int64Optional
approvalNostringOptional
businessServicestring[]Optional
createdBystring[]Optional
edcrNumberstringOptional
fromDateinteger · int64Optional
idsstring[]Optional
landIdstring[]Optional
limitinteger · int32Optional
localitystringOptional
mobileNumberstringOptional
offsetinteger · int32Optional
ownerIdsstring[]Optional
permitNumberstringOptional
serviceTypestringOptional
statusstringOptional
tenantIdstringOptional
toDateinteger · int64Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /egov-foundation/BPA/1.0.0/v1/bpa/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"RequestInfo": {
"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": {}
}
}Body
Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /egov-foundation/BPA/1.0.0/bpa-services/v1/bpa/_permitorderedcr 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": {}
}
}{
"description": "text",
"file": "binary",
"filename": "text",
"inputStream": {},
"open": true,
"readable": true,
"uri": "https://example.com",
"url": "text"
}Last updated
Was this helpful?