Boundary

API endpoint to create Boundary.

post

Provides functionality to create boundary data.

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.

Boundaryobject[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/_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",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-28",
        "lastModifiedDate": "2025-03-28",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "Boundary": [
      {
        "tenantId": "text",
        "code": "text",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                1
              ]
            ]
          ]
        },
        "additionalDetails": {}
      }
    ]
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Boundary": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to search boundary entities.

post

Provides a list of boundary entities based on the provided search criteria.

Query parameters

tenantIdstring · varchar · max: 256required

unique id for a tenant.

codesstring · varchar[]required

unique list of boundary codes.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/_search?tenantId=text&codes=text'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Boundary": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to update Boundary.

post

Provides functionality to update boundary data.

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.

Boundaryobject[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/_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",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-28",
        "lastModifiedDate": "2025-03-28",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "Boundary": [
      {
        "tenantId": "text",
        "code": "text",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                1
              ]
            ]
          ]
        },
        "additionalDetails": {}
      }
    ]
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Boundary": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to define hierarchy.

post

Provides functionality to define hierarchy.

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.

BoundaryHierarchyobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/hierarchy-definition/_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",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-28",
        "lastModifiedDate": "2025-03-28",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "BoundaryHierarchy": {
      "tenantId": "text",
      "hierarchyType": "text",
      "boundaryHierarchy": [
        {
          "boundaryType": "text",
          "parentBoundaryType": "text",
          "active": true
        }
      ]
    }
  }'

200

400

200

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BoundaryHierarchy": {
    "tenantId": "text",
    "hierarchyType": "text",
    "boundaryHierarchy": [
      {
        "boundaryType": "text",
        "parentBoundaryType": "text",
        "active": true
      }
    ]
  }
}

Successful Response.

API endpoint to search boundary entities.

post

Provides boundary type hierarchy based on the provided search criteria.

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.

BoundaryTypeHierarchySearchCriteriaobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/hierarchy-definition/_search' \
  --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"
    },
    "BoundaryTypeHierarchySearchCriteria": {
      "tenantId": "text",
      "hierarchyType": "text"
    }
  }'

200

400

200

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BoundaryHierarchy": {
    "tenantId": "text",
    "hierarchyType": "text",
    "boundaryHierarchy": [
      {
        "boundaryType": "text",
        "parentBoundaryType": "text",
        "active": true
      }
    ]
  }
}

Successful Response.

API endpoint to create relationships between boundaries.

post

Provides functionality to establish relationships between boundaries.

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.

BoundaryRelationshipobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/boundary-relationships/_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",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-28",
        "lastModifiedDate": "2025-03-28",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "BoundaryRelationship": {
      "code": "text",
      "tenantId": "text",
      "hierarchyType": "text",
      "boundaryType": "text",
      "parent": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TenantBoundary": [
    {
      "id": "text",
      "code": "text",
      "tenantId": "text",
      "hierarchyType": "text",
      "boundaryType": "text",
      "parent": "text"
    }
  ]
}

Successful Response.

API endpoint to search linked boundaries.

post

Provides functionality to search linked boundaries based on the provided search criteria

Query parameters

tenantIdstring · varchar · max: 256required

unique id for a tenant.

boundaryTypestring · varchar · max: 64optional

boundary type within the tenant boundary structure.

hierarchyTypestring · varchar · max: 128optional

Type Of the BoundaryType Like REVENUE, ADMIN

includeChildrenbooleanoptional

boolean flag to inform the service if children need to be part of search.

includeParentsbooleanoptional

boolean flag to inform the service if parents need to be part of search.

codesstring · varchar[]optional

unique List of boundary codes.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/boundary-relationships/_search?tenantId=text'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TenantBoundary": [
    {
      "tenantId": "text",
      "hierarchyType": "text",
      "boundary": "[Circular Reference]"
    }
  ]
}

Successful Response.

API endpoint to update relationships between boundaries.

post

Provides functionality to update relationships between boundaries.

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.

BoundaryRelationshipobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v2/boundary/boundary-relationships/_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",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "uuid": "text",
        "userName": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "roles": [
          {
            "tenantId": "text",
            "id": "text",
            "name": "text",
            "description": "text"
          }
        ],
        "salutation": "text",
        "name": "text",
        "gender": "text",
        "alternateMobileNumber": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "accountLocked": true,
        "accountLockedDate": 1,
        "fatherOrHusbandName": "text",
        "relationship": "text",
        "signature": "text",
        "bloodGroup": "text",
        "photo": "text",
        "identificationMark": "text",
        "createdBy": 1,
        "password": "text",
        "otpReference": "text",
        "lastModifiedBy": 1,
        "createdDate": "2025-03-28",
        "lastModifiedDate": "2025-03-28",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "BoundaryRelationship": {
      "code": "text",
      "tenantId": "text",
      "hierarchyType": "text",
      "boundaryType": "text",
      "parent": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TenantBoundary": [
    {
      "id": "text",
      "code": "text",
      "tenantId": "text",
      "hierarchyType": "text",
      "boundaryType": "text",
      "parent": "text"
    }
  ]
}

Successful Response.