Boundary

API endpoint to create Boundary.

Provides functionality to create boundary data.

POST/location/v2/boundary/_create

Body

application/json

RequestInfoRequestInfo (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.

Boundaryarray of Boundary (object)

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.

Boundaryarray of Boundary (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

API endpoint to search boundary entities.

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

POST/location/v2/boundary/_search

Query parameters

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.

Boundaryarray of Boundary (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/_search?tenantId=text&codes=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

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

API endpoint to update Boundary.

Provides functionality to update boundary data.

POST/location/v2/boundary/_update

Body

application/json

RequestInfoRequestInfo (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.

Boundaryarray of Boundary (object)

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.

Boundaryarray of Boundary (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

API endpoint to define hierarchy.

Provides functionality to define hierarchy.

POST/location/v2/boundary/hierarchy-definition/_create

Body

application/json

RequestInfoRequestInfo (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.

BoundaryHierarchyBoundaryTypeHierarchyDefinition (object)

Response

200400

Successful Response.

Body

*/*

RequestInfoResponseInfo (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.

BoundaryHierarchyBoundaryTypeHierarchyDefinition (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/hierarchy-definition/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

API endpoint to search boundary entities.

Provides boundary type hierarchy based on the provided search criteria.

POST/location/v2/boundary/hierarchy-definition/_search

Body

application/json

BoundaryTypeHierarchySearchCriteriaBoundaryTypeHierarchySearchCriteria (object)

Response

200400

Successful Response.

Body

*/*

RequestInfoResponseInfo (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.

BoundaryHierarchyBoundaryTypeHierarchyDefinition (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/hierarchy-definition/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

API endpoint to create relationships between boundaries.

Provides functionality to establish relationships between boundaries.

POST/location/v2/boundary/boundary-relationships/_create

Body

application/json

RequestInfoRequestInfo (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.

BoundaryRelationshipBoundaryRelation (object)

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.

TenantBoundaryarray of BoundaryRelation (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/boundary-relationships/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

API endpoint to search linked boundaries.

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

POST/location/v2/boundary/boundary-relationships/_search

Query parameters

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.

TenantBoundaryarray of HierarchyRelation (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/boundary-relationships/_search?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

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

API endpoint to update relationships between boundaries.

Provides functionality to update relationships between boundaries.

POST/location/v2/boundary/boundary-relationships/_update

Body

application/json

RequestInfoRequestInfo (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.

BoundaryRelationshipBoundaryRelation (object)

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.

TenantBoundaryarray of BoundaryRelation (object)

Request

JavaScriptCurlPython

const response = await fetch('/location/v2/boundary/boundary-relationships/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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