Name of the workflow confguration.
Unique id for a tenant.
unique identifier of Application
Module name to which workflow application belongs
The list of businessIds
The unique Old license number for a Application.
Boolean flag to return history of the workflow
Number of records to be returned
Starting offset for returning search response
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Application(s) Retrived Successfully
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
BusinessService code of the businessService
Unique id for a tenant.
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Trade License(s) Retrived Successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Unique id for a tenant.
unique identifier of Application
Name of the workflow confguration.
Module name to which workflow application belongs
The list of businessIds
The unique Old license number for a Application.
Boolean flag to return history of the workflow
Number of records to be returned
Starting offset for returning search response
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Application(s) Retrived Successfully
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Unique id for a tenant.
unique identifier of Application
Name of the workflow confguration.
Module name to which workflow application belongs
The list of businessIds
The unique Old license number for a Application.
Boolean flag to return history of the workflow
Number of records to be returned
Starting offset for returning search response
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Application(s) Retrived Successfully
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
Used for search result and create only
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Can be used only to add new state or action in the workflow. Can update any existing field. Removing of any state is not allowed as applications in that state will be in invalid state
Following Conditions are applied -
Details for the new BusinessService(s) + RequestInfo meta 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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
ReponseInfo withBusinessService(s) created successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
BusinessService code of the businessService
Unique id for a tenant.
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Trade License(s) Retrived Successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Can be used only to add new state or action in the workflow. Can update any existing field. Removing of any state is not allowed as applications in that state will be in invalid state
Following Conditions are applied -
Details for the new BusinessService(s) + RequestInfo meta 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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
ReponseInfo withBusinessService(s) created successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Unique id for a tenant.
unique identifier of trade licence
Unique application number for a trade license application.
The list of businessIds
The unique Old license number for a Trade license.
Boolean flag to return history of the workflow
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Trade License(s) Retrived Successfully
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Unique id for a tenant.
unique identifier of Application
Name of the workflow confguration.
Module name to which workflow application belongs
The list of businessIds
The unique Old license number for a Application.
Boolean flag to return history of the workflow
Number of records to be returned
Starting offset for returning search response
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
status of request processing - to be enhanced in futuer to include INPROGRESS
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
The unique Old license number for a Application.
unique identifier of Application
Boolean flag to return history of the workflow
Date from which the operation is registered
Date to which the operation is registered
Starting offset for returning search response
Number of records to be returned
Used for search result and create only
Module name to which workflow application belongs
Application(s) Retrived Successfully
To create new workflow configuration(BuinessService) in the system. API supports bulk creation with max limit as defined in the BuinessService Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one BuinessService, please pass array with one BuinessService object.
Following Conditions are applied -
Details for the new BusinessService(s) + RequestInfo meta 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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
ReponseInfo withBusinessService(s) created successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
To create new workflow configuration(BuinessService) in the system. API supports bulk creation with max limit as defined in the BuinessService Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one BuinessService, please pass array with one BuinessService object.
Following Conditions are applied -
Details for the new BusinessService(s) + RequestInfo meta 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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
ReponseInfo withBusinessService(s) created successfully
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
Used for search result and create only
Unique Identifier of ULB
Unique Identifier uuid
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
State Unique Identifier uuid
Unique Identifier of ULB
Unique Identifier of the Trade License (UUID)
Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
Application status as in module
Boolean to describe if documents are mandatory
Boolean to describe if the workflow can be started from this state
Boolean to describe if the state is the last state of workflow
State Unique Identifier uuid
TenantId of the ULB
The uuid of the state on which action is to performed
The action to be performed
The uuid of the resultant state
Used for search result and create only
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
To create new workflow applicationin the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one workflow(ProcessInstance) instance, please pass array with one workflow(ProcessInstance) object.
Following Conditions are applied -
Details for the new Workflow(s) + RequestInfo meta 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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
ReponseInfo with Workflow(s) created successfully
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Unique id for a tenant.
unique identifier of Application
Name of the workflow confguration.
Module name to which workflow application belongs
The list of businessIds
The unique Old license number for a Application.
Boolean flag to return history of the workflow
Number of records to be returned
Starting offset for returning search response
Parameter to carry Request metadata in the request body
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
System Generated User id of the authenticated user.
Unique user name of the authenticated user
password of the user.
This will be the OTP.
mobile number of the autheticated user
email address of the authenticated user
List of all the roles for the primary tenant
Unique name of the role
Unique code of the role
brief description of the role
array of additional tenantids authorized for the authenticated user
tenantid for the tenant
Roles assigned for a particular tenant - array of role codes/names
Unique name of the role
Unique code of the role
brief description of the role
Application(s) Retrived Successfully
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
Used for search result and create only
Unique process instance id (UUID)
Unique Identifier of ULB
Business service key.
Business id is a unique identifier of a task. eg(Propertyid, TLid, ServiceRequestid)
Actions are define for each business service.
Status will be populate by efengine for each action, if it is configured.
consumer can pass the comment on each action.
Documents can be attached with each of the action.
State Unique Identifier uuid
Unique Identifier of ULB
1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
Unique file store id of uploaded document.
document number(eg.Pan number, aadhar number).
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
The unique id an user.
The unique username used for user login.
Password for user login.
The salutation of user name. Example- Mr, Miss, Mrs
The full name of the user.
Gender of the user.
Mobile number ofuser the user
Email address of the user
Alternate contact number of the user
PAN number of the user
Aadhaar number of the user
[0-9]Permanent address of the user.
City of the permanent address.
Permanent address pincode.
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.
Data of bith of the user in dd/mm/yyyy format.
Date on which the password registered will expire.
Value will be set to "en_IN".
System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
Image to be loaded for the signature of the employee
Set to True if account is locked after several incorrect password attempt. False if account is not locked.
List of roles that are attached to the user.
Unique identifier of the role.
The Name of the Role.
The Code of the Role.
The description of the Role.
Id of the user who created the record.
Date on which the role master data was added into the system.
Id of the user who last modified the record.
Date on which the role master data was last modified.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Name of user's father or husband.
Blood group of the user.
Any identification mark of the person.
Image to be loaded for the photo of the user
Id of the user who created the record.
Date on which the user master data was added into the system.
Id of the user who last modified the record.
Date on which the user master data was last modified.
This is the UUID token that we genarate as part of OTP.
Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
Wf will return next possible action based on .
Date from when license is valid as epoch.
Status after action performed
Status before action performed
Collection of audit related fields used by most models
username (preferred) or userid of the user that created the object
username (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified