Boundary

PreviousAccess Control NextDocument Uploader

Last updated 9 months ago

Was this helpful?

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

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/boundary-relationships/_search?tenantId=text HTTP/1.1
Host: 
Accept: */*

{
  "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]"
          }
        ]
      }
    }
  ]
}

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

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/_search?tenantId=text&codes=text HTTP/1.1
Host: 
Accept: */*

{
  "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": {}
    }
  ]
}

API endpoint to create Boundary.

post

Provides functionality to create boundary data.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1143

{
  "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-05-09",
      "lastModifiedDate": "2025-05-09",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "Boundary": [
    {
      "tenantId": "text",
      "code": "text",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

{
  "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": {}
    }
  ]
}

API endpoint to update Boundary.

post

Provides functionality to update boundary data.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1143

{
  "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-05-09",
      "lastModifiedDate": "2025-05-09",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "Boundary": [
    {
      "tenantId": "text",
      "code": "text",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      },
      "additionalDetails": {}
    }
  ]
}

{
  "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": {}
    }
  ]
}

API endpoint to define hierarchy.

post

Provides functionality to define hierarchy.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/hierarchy-definition/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1172

{
  "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-05-09",
      "lastModifiedDate": "2025-05-09",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "BoundaryHierarchy": {
    "tenantId": "text",
    "hierarchyType": "text",
    "boundaryHierarchy": [
      {
        "boundaryType": "text",
        "parentBoundaryType": "text",
        "active": true
      }
    ]
  }
}

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

API endpoint to search boundary entities.

post

Provides boundary type hierarchy based on the provided search criteria.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/hierarchy-definition/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 230

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

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

API endpoint to create relationships between boundaries.

post

Provides functionality to establish relationships between boundaries.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/boundary-relationships/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1139

{
  "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-05-09",
      "lastModifiedDate": "2025-05-09",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "BoundaryRelationship": {
    "code": "text",
    "tenantId": "text",
    "hierarchyType": "text",
    "boundaryType": "text",
    "parent": "text"
  }
}

{
  "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"
    }
  ]
}

API endpoint to update relationships between boundaries.

post

Provides functionality to update relationships between boundaries.

Body

Responses

200

Successful Response.

*/*

400

Invalid input.

*/*

post

POST /location/v2/boundary/boundary-relationships/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1139

{
  "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-05-09",
      "lastModifiedDate": "2025-05-09",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "BoundaryRelationship": {
    "code": "text",
    "tenantId": "text",
    "hierarchyType": "text",
    "boundaryType": "text",
    "parent": "text"
  }
}

{
  "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"
    }
  ]
}