Provides a list of boundary entities based on the provided search criteria.
unique id for a tenant.
unique list of boundary codes.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
Provides functionality to update relationships between boundaries.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Salutation of the authenticated user
Name of the authenticated user
Gender of the authenticated user
Alternate mobile number of the authenticated user
Alternate Contact number of the authenticated user
Pan details of the authenticated user
Aadhaar number of the authenticated user
Permanent address of the user.
City of the permanent address.
City of the correspondence address.
Permanent address pincode.
Correspondence address of the user.
True if the user is active and False if the user is inactive.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Set to True if account is locked after several incorrect password
Date when account is locked after several incorrect password
Name of user's father or husband.
Relationship of user with the guardian. "FATHER, MOTHER, HUSBAND OR OTHER"
Image to be loaded for the signature of the employee
Blood group of the user.
Image to be loaded for the photo of the user
Any identification mark of user.
Id of the user who created the record.
password of the user.
This is the UUID token that we genarate as part of OTP.
Id of the user who last modified the record.
Date on which the user master data was added into the system.
Date on which the user master data was last modified.
Date of birth of the User
read-only db entity uuid.
Code of the boundary.
Unique tenant identifier.
Code of the hierarchy type for which boundary relationship is being created.
Boundary type from master data.
Parent boundary code.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
read-only db entity uuid.
Code of the boundary.
Unique tenant identifier.
Code of the hierarchy type for which boundary relationship is being created.
Boundary type from master data.
Parent boundary code.
Provides functionality to establish relationships between boundaries.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Salutation of the authenticated user
Name of the authenticated user
Gender of the authenticated user
Alternate mobile number of the authenticated user
Alternate Contact number of the authenticated user
Pan details of the authenticated user
Aadhaar number of the authenticated user
Permanent address of the user.
City of the permanent address.
City of the correspondence address.
Permanent address pincode.
Correspondence address of the user.
True if the user is active and False if the user is inactive.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Set to True if account is locked after several incorrect password
Date when account is locked after several incorrect password
Name of user's father or husband.
Relationship of user with the guardian. "FATHER, MOTHER, HUSBAND OR OTHER"
Image to be loaded for the signature of the employee
Blood group of the user.
Image to be loaded for the photo of the user
Any identification mark of user.
Id of the user who created the record.
password of the user.
This is the UUID token that we genarate as part of OTP.
Id of the user who last modified the record.
Date on which the user master data was added into the system.
Date on which the user master data was last modified.
Date of birth of the User
read-only db entity uuid.
Code of the boundary.
Unique tenant identifier.
Code of the hierarchy type for which boundary relationship is being created.
Boundary type from master data.
Parent boundary code.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
read-only db entity uuid.
Code of the boundary.
Unique tenant identifier.
Code of the hierarchy type for which boundary relationship is being created.
Boundary type from master data.
Parent boundary code.
Provides functionality to create boundary data.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Salutation of the authenticated user
Name of the authenticated user
Gender of the authenticated user
Alternate mobile number of the authenticated user
Alternate Contact number of the authenticated user
Pan details of the authenticated user
Aadhaar number of the authenticated user
Permanent address of the user.
City of the permanent address.
City of the correspondence address.
Permanent address pincode.
Correspondence address of the user.
True if the user is active and False if the user is inactive.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Set to True if account is locked after several incorrect password
Date when account is locked after several incorrect password
Name of user's father or husband.
Relationship of user with the guardian. "FATHER, MOTHER, HUSBAND OR OTHER"
Image to be loaded for the signature of the employee
Blood group of the user.
Image to be loaded for the photo of the user
Any identification mark of user.
Id of the user who created the record.
password of the user.
This is the UUID token that we genarate as part of OTP.
Id of the user who last modified the record.
Date on which the user master data was added into the system.
Date on which the user master data was last modified.
Date of birth of the User
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
Provides functionality to update boundary data.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Salutation of the authenticated user
Name of the authenticated user
Gender of the authenticated user
Alternate mobile number of the authenticated user
Alternate Contact number of the authenticated user
Pan details of the authenticated user
Aadhaar number of the authenticated user
Permanent address of the user.
City of the permanent address.
City of the correspondence address.
Permanent address pincode.
Correspondence address of the user.
True if the user is active and False if the user is inactive.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Set to True if account is locked after several incorrect password
Date when account is locked after several incorrect password
Name of user's father or husband.
Relationship of user with the guardian. "FATHER, MOTHER, HUSBAND OR OTHER"
Image to be loaded for the signature of the employee
Blood group of the user.
Image to be loaded for the photo of the user
Any identification mark of user.
Id of the user who created the record.
password of the user.
This is the UUID token that we genarate as part of OTP.
Id of the user who last modified the record.
Date on which the user master data was added into the system.
Date on which the user master data was last modified.
Date of birth of the User
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
Provides functionality to search linked boundaries based on the provided search criteria
unique id for a tenant.
boundary type within the tenant boundary structure.
Type Of the BoundaryType Like REVENUE, ADMIN
boolean flag to inform the service if children need to be part of search.
boolean flag to inform the service if parents need to be part of search.
unique List of boundary codes.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
unique id of the boundary tenant.
Hierarchy type from master data
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
type of the boundary.
children boundaries of the current boundary
read-only db entity uuid.
Unique tenant identifier.
code of the boundary.
type of the boundary.
children boundaries of the current boundary
Provides functionality to define hierarchy.
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.
unique API ID
API version - for HTTP based request this will be same as used in path
time in epoch
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
Device ID from which the API is called
API key (API key provided to the caller in case of server to server communication)
Unique request message id from the caller
UserId of the user calling
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
Unique Identifier of the tenant to which user primarily belongs
User id of the authenticated user. Will be deprecated in future
UUID of the user
Unique user name of the authenticated user
mobile number of the autheticated user
email address of the authenticated user
List of all the roles
TenantId for which the role is given
id of the role
Unique name of the role
brief description of the role
Salutation of the authenticated user
Name of the authenticated user
Gender of the authenticated user
Alternate mobile number of the authenticated user
Alternate Contact number of the authenticated user
Pan details of the authenticated user
Aadhaar number of the authenticated user
Permanent address of the user.
City of the permanent address.
City of the correspondence address.
Permanent address pincode.
Correspondence address of the user.
True if the user is active and False if the user is inactive.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Set to True if account is locked after several incorrect password
Date when account is locked after several incorrect password
Name of user's father or husband.
Relationship of user with the guardian. "FATHER, MOTHER, HUSBAND OR OTHER"
Image to be loaded for the signature of the employee
Blood group of the user.
Image to be loaded for the photo of the user
Any identification mark of user.
Id of the user who created the record.
password of the user.
This is the UUID token that we genarate as part of OTP.
Id of the user who last modified the record.
Date on which the user master data was added into the system.
Date on which the user master data was last modified.
Date of birth of the User
unique id of the boundary tenant.
Hierarchy type from master data
boundary type code.
UUID
unique code for parent boundary.
attribute that defines if the given boundary hierarchy is active or not
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
unique id of the boundary tenant.
Hierarchy type from master data
boundary type code.
UUID
unique code for parent boundary.
attribute that defines if the given boundary hierarchy is active or not
Provides boundary type hierarchy based on the provided search criteria.
Unique id for a tenant.
Search by hierarchy type.
Successful Response.
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.
unique API ID
API version
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing - to be enhanced in futuer to include INPROGRESS
unique id of the boundary tenant.
Hierarchy type from master data
boundary type code.
UUID
unique code for parent boundary.
attribute that defines if the given boundary hierarchy is active or not