Building Plan Approval

Building Plan Application System APIs

Stakeholders apply for building permits using the eDCR scrutiny.

Crete land detail in land registry

post

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

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

LandInfoobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": "[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": {}
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "text",
    "status": "ACTIVE",
    "address": {
      "tenantId": "text",
      "doorNo": "text",
      "plotNo": "text",
      "landmark": "text",
      "city": "text",
      "district": "text",
      "region": "text",
      "state": "text",
      "country": "text",
      "pincode": "text",
      "additionDetails": "text",
      "buildingName": "text",
      "street": "text",
      "locality": "[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": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Reqeuset submitted successfully

Update existing application.

post

Updates a given application with newer details.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

LandInfoobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": "[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": {}
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "LandInfo": {
    "id": "text",
    "landUId": "text",
    "landUniqueRegNo": "text",
    "tenantId": "text",
    "status": "ACTIVE",
    "address": {
      "tenantId": "text",
      "doorNo": "text",
      "plotNo": "text",
      "landmark": "text",
      "city": "text",
      "district": "text",
      "region": "text",
      "state": "text",
      "country": "text",
      "pincode": "text",
      "additionDetails": "text",
      "buildingName": "text",
      "street": "text",
      "locality": "[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": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

successfully updated

Get the list of land information.

post

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

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

userInfoobjectread-onlyoptional

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstringread-onlyoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "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",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[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": {},
      "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": {}
  }
}

Successful response

Apply for new building plan application.

post

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

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
        "id": "text",
        "landUId": "text",
        "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": "[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": {},
        "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": {}
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "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",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[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": {},
      "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": {}
  }
}

Application submitted successfully

Update existing application.

post

Updates a given application with newer details.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
        "id": "text",
        "landUId": "text",
        "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": "[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": {},
        "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": {}
    }
  }'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "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",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[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": {},
      "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": {}
  }
}

Application updated successfully

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

post

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

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

userInfoobjectread-onlyoptional

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstringread-onlyoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "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",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[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": {},
      "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": {}
  }
}

Successful response

plainSearch

post

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

RequestInfoobjectoptional

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.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    }
  }'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BPA": {
    "id": "text",
    "applicationNo": "text",
    "approvalNo": "text",
    "accountId": "text",
    "edcrNumber": "text",
    "riskType": "text",
    "landId": "text",
    "tenantId": "text",
    "status": "text",
    "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",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[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": {},
      "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": {}
  }
}

OK

getPdf

post

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BPAobjectrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/bpa-services/v1/bpa/_permitorderedcr' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
        "id": "text",
        "landUId": "text",
        "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": "[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": {},
        "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": {}
    }
  }'

200

201

401

403

404

200

{
  "description": "text",
  "file": "binary",
  "filename": "text",
  "inputStream": {},
  "open": true,
  "readable": true,
  "uri": "https://example.com",
  "url": "text"
}

OK