Online Building Plan Approval Service API

Land Service

Crete land detail in land registry

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

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create

Body

application/json

Fill Bpa application details and submit the request.

RequestInfo*RequestInfo (object)

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.

LandInfo*LandInfo

Response

202400

Reqeuset submitted successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

LandInfoLandInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "LandInfo": {
        "address": {
          "locality": {
            "code": "text",
            "name": "text"
          },
          "tenantId": "text"
        },
        "owners": [
          {
            "fatherOrHusbandName": "text",
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER"
          }
        ],
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": [],
        "materializedPath": "text"
      },
      "geoLocation": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "ownershipCategory": "text",
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": false,
        "ownerShipPercentage": 0,
        "ownerType": "text",
        "institutionId": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text"
          }
        ],
        "relationship": "FATHER"
      }
    ],
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text"
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ],
    "unit": [
      {
        "id": "text",
        "tenantId": "text",
        "floorNo": "text",
        "unitType": "Building, Room, Kitchen etc.",
        "usageCategory": "text",
        "occupancyType": "OWNER",
        "constructionDetail": {
          "id": "text",
          "carpetArea": 0,
          "builtUpArea": 0,
          "plinthArea": 0,
          "superBuiltUpArea": 0,
          "constructionType": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      }
    ],
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Update existing application.

Updates a given application with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update

Body

application/json

Request to update existing application details.

RequestInfo*RequestInfo (object)

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.

LandInfo*LandInfo

Response

202400

successfully updated

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

LandInfoLandInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "LandInfo": {
        "address": {
          "locality": {
            "code": "text",
            "name": "text"
          },
          "tenantId": "text"
        },
        "owners": [
          {
            "fatherOrHusbandName": "text",
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER"
          }
        ],
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": [],
        "materializedPath": "text"
      },
      "geoLocation": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "ownershipCategory": "text",
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": false,
        "ownerShipPercentage": 0,
        "ownerType": "text",
        "institutionId": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text"
          }
        ],
        "relationship": "FATHER"
      }
    ],
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text"
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ],
    "unit": [
      {
        "id": "text",
        "tenantId": "text",
        "floorNo": "text",
        "unitType": "Building, Room, Kitchen etc.",
        "usageCategory": "text",
        "occupancyType": "OWNER",
        "constructionDetail": {
          "id": "text",
          "carpetArea": 0,
          "builtUpArea": 0,
          "plinthArea": 0,
          "superBuiltUpArea": 0,
          "constructionType": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      }
    ],
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Get the list of land information.

Get the list of land information..

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search

Query parameters

Body

application/json

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Apply for new building plan application.

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

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create

Body

application/json

Fill Bpa application details and submit the request.

RequestInfo*RequestInfo (object)

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.

BPA*BPA (object)

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

Response

202400

Application submitted successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "BPA": {
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Update existing application.

Updates a given application with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update

Body

application/json

Request to update existing application details.

RequestInfo*RequestInfo (object)

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.

BPA*BPA (object)

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

Response

202400

Application updated successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "BPA": {
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

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

Get the properties list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search

Query parameters

Body

application/json

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Building Permission Application Services

Crete land detail in land registry

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

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create

Body

application/json

Fill Bpa application details and submit the request.

RequestInfo*RequestInfo (object)

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.

LandInfo*LandInfo

Response

202400

Reqeuset submitted successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

LandInfoLandInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "LandInfo": {
        "address": {
          "locality": {
            "code": "text",
            "name": "text"
          },
          "tenantId": "text"
        },
        "owners": [
          {
            "fatherOrHusbandName": "text",
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER"
          }
        ],
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": [],
        "materializedPath": "text"
      },
      "geoLocation": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "ownershipCategory": "text",
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": false,
        "ownerShipPercentage": 0,
        "ownerType": "text",
        "institutionId": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text"
          }
        ],
        "relationship": "FATHER"
      }
    ],
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text"
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ],
    "unit": [
      {
        "id": "text",
        "tenantId": "text",
        "floorNo": "text",
        "unitType": "Building, Room, Kitchen etc.",
        "usageCategory": "text",
        "occupancyType": "OWNER",
        "constructionDetail": {
          "id": "text",
          "carpetArea": 0,
          "builtUpArea": 0,
          "plinthArea": 0,
          "superBuiltUpArea": 0,
          "constructionType": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      }
    ],
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Update existing application.

Updates a given application with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update

Body

application/json

Request to update existing application details.

RequestInfo*RequestInfo (object)

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.

LandInfo*LandInfo

Response

202400

successfully updated

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

LandInfoLandInfo

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "LandInfo": {
        "address": {
          "locality": {
            "code": "text",
            "name": "text"
          },
          "tenantId": "text"
        },
        "owners": [
          {
            "fatherOrHusbandName": "text",
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER"
          }
        ],
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": [],
        "materializedPath": "text"
      },
      "geoLocation": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "ownershipCategory": "text",
    "owners": [
      {
        "name": "text",
        "mobileNumber": "text",
        "gender": "text",
        "fatherOrHusbandName": "text",
        "correspondenceAddress": "text",
        "isPrimaryOwner": false,
        "ownerShipPercentage": 0,
        "ownerType": "text",
        "institutionId": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text"
          }
        ],
        "relationship": "FATHER"
      }
    ],
    "institution": {
      "id": "text",
      "tenantId": "text",
      "type": "text",
      "designation": "text",
      "nameOfAuthorizedPerson": "text"
    },
    "source": "MUNICIPAL_RECORDS",
    "channel": "SYSTEM",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ],
    "unit": [
      {
        "id": "text",
        "tenantId": "text",
        "floorNo": "text",
        "unitType": "Building, Room, Kitchen etc.",
        "usageCategory": "text",
        "occupancyType": "OWNER",
        "constructionDetail": {
          "id": "text",
          "carpetArea": 0,
          "builtUpArea": 0,
          "plinthArea": 0,
          "superBuiltUpArea": 0,
          "constructionType": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      }
    ],
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Get the list of land information.

Get the list of land information..

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search

Query parameters

Body

application/json

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/land/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Apply for new building plan application.

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

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create

Body

application/json

Fill Bpa application details and submit the request.

RequestInfo*RequestInfo (object)

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.

BPA*BPA (object)

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

Response

202400

Application submitted successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "BPA": {
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

Update existing application.

Updates a given application with newer details.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update

Body

application/json

Request to update existing application details.

RequestInfo*RequestInfo (object)

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.

BPA*BPA (object)

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

Response

202400

Application updated successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "BPA": {
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

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

Get the properties list based on the input parameters.

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search

Query parameters

Body

application/json

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BPABPA (object)

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

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/v1/bpa/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
      }
    ],
    "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": [],
          "materializedPath": "text"
        },
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "ownershipCategory": "text",
      "owners": [
        {
          "name": "text",
          "mobileNumber": "text",
          "gender": "text",
          "fatherOrHusbandName": "text",
          "correspondenceAddress": "text",
          "isPrimaryOwner": false,
          "ownerShipPercentage": 0,
          "ownerType": "text",
          "institutionId": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "relationship": "FATHER"
        }
      ],
      "institution": {
        "id": "text",
        "tenantId": "text",
        "type": "text",
        "designation": "text",
        "nameOfAuthorizedPerson": "text"
      },
      "source": "MUNICIPAL_RECORDS",
      "channel": "SYSTEM",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "unit": [
        {
          "id": "text",
          "tenantId": "text",
          "floorNo": "text",
          "unitType": "Building, Room, Kitchen etc.",
          "usageCategory": "text",
          "occupancyType": "OWNER",
          "constructionDetail": {
            "id": "text",
            "carpetArea": 0,
            "builtUpArea": 0,
            "plinthArea": 0,
            "superBuiltUpArea": 0,
            "constructionType": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            }
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comments": "text",
      "varificationDocuments": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

BPA Calculator Services

Calculate the Fee and create Demand for the building plan application

Calculate the Fee and create Demand for the building plan application

POSThttps://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/bpa-calculator/v1/_calculate

Body

application/json

Fill Bpa application details and submit the request.

CalculationCriteriaarray of CalulationCriteria (object)

Response

202400

Successfull

Body

*/*

Calculationsarray of Calculation (object)

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/egov-foundation/BPA/1.0.0/bpa-calculator/v1/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "tenantId": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "Category": "TAX"
        }
      ],
      "feeType": "text"
    }
  ]
}