Boundary

API endpoint to create Boundary.

Provides functionality to create boundary data.

post

/boundary/_create

Body

RequestInfoobject

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[]

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"Boundary":[{"code":"text","geometry":{"type":"Polygon","coordinates":[[[null]]]},"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": [
          [
            [
              null
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to search boundary entities.

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

post

/boundary/_search

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": [
          [
            [
              null
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to update Boundary.

Provides functionality to update boundary data.

post

/boundary/_update

Body

RequestInfoobject

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[]

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"Boundary":[{"code":"text","geometry":{"type":"Polygon","coordinates":[[[null]]]},"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": [
          [
            [
              null
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

Successful Response.

API endpoint to define hierarchy.

Provides functionality to define hierarchy.

post

/boundary/hierarchy-definition/_create

Body

RequestInfoobject

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.

BoundaryHierarchyobject

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"BoundaryHierarchy":{"boundaryHierarchy":[{}]}}'

200

400

200

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

Successful Response.

API endpoint to search boundary entities.

Provides boundary type hierarchy based on the provided search criteria.

post

/boundary/hierarchy-definition/_search

Body

RequestInfoobject

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.

BoundaryTypeHierarchySearchCriteriaobject

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BoundaryTypeHierarchySearchCriteria":{}}'

200

400

200

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

Successful Response.

API endpoint to create relationships between boundaries.

Provides functionality to establish relationships between boundaries.

post

/boundary/boundary-relationships/_create

Body

RequestInfoobject

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.

BoundaryRelationshipobject

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"BoundaryRelationship":{"code":"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.

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

post

/boundary/boundary-relationships/_search

Query parameters

tenantIdstring · varchar · max: 256required

unique id for a tenant.

boundaryTypestring · varchar · max: 64

boundary type within the tenant boundary structure.

hierarchyTypestring · varchar · max: 128

Type Of the BoundaryType Like REVENUE, ADMIN

includeChildrenboolean

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

includeParentsboolean

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

codesstring · varchar[]

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": {
        "id": "text",
        "tenantId": "text",
        "code": "text",
        "boundaryType": "text",
        "children": [
          {
            "id": "text",
            "tenantId": "text",
            "code": "text",
            "boundaryType": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    }
  ]
}

Successful Response.

API endpoint to update relationships between boundaries.

Provides functionality to update relationships between boundaries.

post

/boundary/boundary-relationships/_update

Body

RequestInfoobject

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.

BoundaryRelationshipobject

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","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"BoundaryRelationship":{"code":"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.