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.

post

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

body

requestInfoanyOptional

Parameter to carry Request metadata in the request body

Query parameters

tenantIdanyRequired

Unique id for a tenant.

boundaryTypeintegerOptional

lable of boundary within the tenant boundary structure

hierarchyTypeCodestring · varcharOptional

Type Of the BoundaryType Like REVENUE, ADMIN

codesstring · varchar[]Optional

Unique List of boundary codes.

Responses

200

Successful Response.

application/json

400

Tenantid was not provided or General service error

application/json

post

HTTPcURLJavaScriptPython

POST /location/v11/boundarys/_search?tenantId=null HTTP/1.1
Host: 
Accept: */*

{
  "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",
          "children": [
            "[Circular Reference]"
          ],
          "materializedPath": "text"
        }
      ]
    }
  ]
}

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

post

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

Query parameters

tenantIdanyRequired

Unique id for a tenant.

filterstringOptional

JSON path filter string for filtering the output

Body

Responses

200

Successful Response.

application/json

400

Invalid tenant Id provided

application/json

post

HTTPcURLJavaScriptPython

POST /location/v11/geography/_search?tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

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

Resolves a given latitude / longitude to the corresponding tenant Id

post

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

Query parameters

tenantIdanyRequired

Unique id for a tenant.

latnumberRequired

Latitude

lngnumberRequired

Longitude

Body

Responses

200

Successful Response.

application/json

400

Unable to resolve tenant

application/json

post

HTTPcURLJavaScriptPython

POST /location/v11/tenant/_search?tenantId=null&lat=1&lng=1 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }
}

{
  "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",
    "type": "CITY",
    "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"
    }
  }
}