Location

Swagger Editor

Swagger API Contract Link

It Will provide the List of boundaries based on search criteria Like "Srikakulam Municipality","Zone-1","Zone-2" etc.

Provides a list of boundaries based on TenantId And List of Boundary id's And List Of codes And BoundaryType And HierarchyType

post

/boundarys/_search

Query parameters

boundaryTypeinteger

lable of boundary within the tenant boundary structure

hierarchyTypeCodestring · varchar

Type Of the BoundaryType Like REVENUE, ADMIN

codesstring · varchar[]

Unique List of boundary codes.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v11/boundarys/_search'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Boundary": [
    {
      "tenantId": "text",
      "hierarchyType": {
        "id": "text",
        "code": "text",
        "name": "text",
        "label": "text"
      },
      "boundary": [
        {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "children": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Successful Response.

Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data

Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data based on tenantId or lat/long etc

post

/geography/_search

Query parameters

filterstring

JSON path filter string for filtering the output

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.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v11/geography/_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"}]}]}}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Geography": [
    {
      "name": "text",
      "division": "text",
      "geoJson": {},
      "geoJsonChildren": {},
      "tenantId": "text"
    }
  ]
}

Successful Response.

Resolves a given latitude / longitude to the corresponding tenant Id

Tries to resolve a given lat, long to a corresponding tenant, provided there exists a mapping between the reverse geocoded city to tenant.

post

/tenant/_search

Query parameters

latnumberrequired

Latitude

lngnumberrequired

Longitude

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.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/location/v11/tenant/_search?lat=1&lng=1' \
  --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"}]}]}}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Tenant": {
    "code": "text",
    "name": "text",
    "description": "text",
    "imageId": "text",
    "logoId": "text",
    "domainUrl": "text",
    "address": "text",
    "contactNumber": "text",
    "helpLineNumber": "text",
    "twitterUrl": "text",
    "facebookUrl": "text",
    "emailId": "text",
    "city": {
      "name": "text",
      "localName": "text",
      "districtCode": "text",
      "districtName": "text",
      "regionName": "text",
      "longitude": 1,
      "latitude": 1,
      "shapeFilePath": "text",
      "captcha": "text"
    },
    "type": "CITY"
  }
}

Successful Response.