This service is used to issue license to user after verification. The service is designed in such way that it can be used to serve different type of licenses. Currently used to issue trade licenses, perform stakeholder registration and issue lock down pass. The service is integrated with workflow where we can define the steps for approval of the application. Once the application is approved the license is generated.The module contains three API as describe below:
_create:
This API is used to create an application for the license in the system. Whenever an application is created a application number is generated and assigned to the application for future reference.
_search:
This API is used to search the applications in the system based on various search parameters like mobile number, application number,status etc.
_update:
The _update API is used to update the application information or to forward the application from one state to another.
Configurable Properties:
Following are the properties in application.properties file in trade license service which are configurable.
Property | Value | Remarks |
|---|---|---|
egov.idgen.tl.applicationNum.format | PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_TL_APL] | The format of the application number |
egov.idgen.tl.licensenumber.format | PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_PT_LN] | The format of the license number |
egov.tl.max.limit | 100 | Max number of records to be returned |
citizen.allowed.search.params | tenantId,applicationNumber,limit,offset,licenseNumbers | The search parameters on which citizen can search |
employee.allowed.search.params | tenantId,applicationNumber,applicationType,status,mobileNumber,fromDate,toDate,licenseNumbers,oldLicenseNumber,limit,offset | The search parameters on which employee can search |
persister.save.tradelicense.topic | save-tl-tradelicense | The name of kafka topic on which create request are published |
persister.update.tradelicense.topic | update-tl-tradelicense | The name of kafka topic on which update request are published |
persister.update.tradelicense.workflow.topic | update-tl-workflow | The name of kafka topic on which status update request are published |
Postman Collection: https://www.getpostman.com/collections/99f98723c45f97024831
API contract: https://raw.githubusercontent.com/egovernments/egov-services/master/docs/rainmaker/trade-license/tl-service.yml
Web Sequence Diagram:
Workflow Configuration:
{
"ResponseInfo": {
"apiId": "Rainmaker",
"ver": ".01",
"ts": 1513579888683,
"resMsgId": "uief87324",
"msgId": "20170310130900|en_IN",
"status": "successful"
},
"BusinessServices": [
{
"tenantId": "pb.amritsar",
"uuid": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"businessService": "NewTL",
"business": "tl-services",
"businessServiceSla": 172800000,
"states": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "dfb54936-8e33-40c1-8fb7-2b78f835e1ba",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": null,
"applicationStatus": null,
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "c658b2b9-8d8c-4ce6-a63d-a924edc3d57d",
"tenantId": "pb.amritsar",
"currentState": "dfb54936-8e33-40c1-8fb7-2b78f835e1ba",
"action": "INITIATE",
"nextState": "4d4fbfb7-8b47-43bd-b235-d4dcb90ac6c1",
"roles": [
"CITIZEN",
"TL_CEMP"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "4d4fbfb7-8b47-43bd-b235-d4dcb90ac6c1",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "INITIATED",
"applicationStatus": "INITIATED",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "0acfc6ab-029f-4ed6-aabe-3c3e551a9ff8",
"tenantId": "pb.amritsar",
"currentState": "4d4fbfb7-8b47-43bd-b235-d4dcb90ac6c1",
"action": "APPLY",
"nextState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"roles": [
"CITIZEN",
"TL_CEMP"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "d499ff8f-9c7b-4526-9203-c61e847573ed",
"tenantId": "pb.amritsar",
"currentState": "4d4fbfb7-8b47-43bd-b235-d4dcb90ac6c1",
"action": "INITIATE",
"nextState": "4d4fbfb7-8b47-43bd-b235-d4dcb90ac6c1",
"roles": [
"CITIZEN",
"TL_CEMP"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "APPLIED",
"applicationStatus": "APPLIED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "ae513e6b-6c32-4f56-92b9-2ad4fd9291aa",
"tenantId": "pb.amritsar",
"currentState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"action": "FORWARD",
"nextState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"roles": [
"TL_DOC_VERIFIER"
],
"active": true
},
{
"auditDetails": {
"createdBy": "746412f0-93cc-4da2-8aff-33301aad92fc",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1626351117905,
"lastModifiedTime": 1631013999749
},
"uuid": "e7ab7368-eb1e-4861-8fb5-bf044964adf2",
"tenantId": "pb.amritsar",
"currentState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"action": "SENDBACKTOCITIZEN",
"nextState": "c4a30c94-9a18-4f9f-888f-d78f601579d3",
"roles": [
"TL_DOC_VERIFIER"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "c7790280-1d26-4cb1-9e47-240a781806e6",
"tenantId": "pb.amritsar",
"currentState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"action": "REJECT",
"nextState": "9be5a925-7a05-4067-8c7d-3d712296f163",
"roles": [
"TL_DOC_VERIFIER"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "9be5a925-7a05-4067-8c7d-3d712296f163",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "REJECTED",
"applicationStatus": "REJECTED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "fb207155-367e-4da3-9340-2ccfed531fa5",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": 86400000,
"state": "FIELDINSPECTION",
"applicationStatus": "FIELDINSPECTION",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "761ca6c4-5980-4548-a85e-88343125fd1a",
"tenantId": "pb.amritsar",
"currentState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"action": "SENDBACK",
"nextState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"roles": [
"TL_FIELD_INSPECTOR"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "21a89337-a1c0-4b22-879b-4a25ac30f52b",
"tenantId": "pb.amritsar",
"currentState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"action": "FORWARD",
"nextState": "92cb64ed-6d27-49d1-800e-2a79c46240e6",
"roles": [
"TL_FIELD_INSPECTOR"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1577343048587,
"lastModifiedTime": 1631013999749
},
"uuid": "824971b4-ec99-4bde-95ed-f8635434d3b0",
"tenantId": "pb.amritsar",
"currentState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"action": "SENDBACKTOCITIZEN",
"nextState": "c4a30c94-9a18-4f9f-888f-d78f601579d3",
"roles": [
"TL_FIELD_INSPECTOR"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "259bb7df-21ea-4a19-8f5d-b00dc3eae9b4",
"tenantId": "pb.amritsar",
"currentState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"action": "REJECT",
"nextState": "9be5a925-7a05-4067-8c7d-3d712296f163",
"roles": [
"TL_FIELD_INSPECTOR"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "92cb64ed-6d27-49d1-800e-2a79c46240e6",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "PENDINGAPPROVAL",
"applicationStatus": "PENDINGAPPROVAL",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "d51c5a43-3046-4f8b-8764-ea3fb262aab0",
"tenantId": "pb.amritsar",
"currentState": "92cb64ed-6d27-49d1-800e-2a79c46240e6",
"action": "APPROVE",
"nextState": "154d6f0d-e849-4ccd-ae5b-a599e264fdd9",
"roles": [
"TL_APPROVER"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "59a11357-b5ca-42ef-bc84-8373135c8ad9",
"tenantId": "pb.amritsar",
"currentState": "92cb64ed-6d27-49d1-800e-2a79c46240e6",
"action": "REJECT",
"nextState": "9be5a925-7a05-4067-8c7d-3d712296f163",
"roles": [
"TL_APPROVER"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "d15afbcd-496d-485e-bce2-783af0c91564",
"tenantId": "pb.amritsar",
"currentState": "92cb64ed-6d27-49d1-800e-2a79c46240e6",
"action": "SENDBACK",
"nextState": "fb207155-367e-4da3-9340-2ccfed531fa5",
"roles": [
"TL_APPROVER"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "154d6f0d-e849-4ccd-ae5b-a599e264fdd9",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": 43200000,
"state": "PENDINGPAYMENT",
"applicationStatus": "PENDINGPAYMENT",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "93860493-75f2-45f0-ae70-fe64b66b5bf3",
"tenantId": "pb.amritsar",
"currentState": "154d6f0d-e849-4ccd-ae5b-a599e264fdd9",
"action": "ADHOC",
"nextState": "154d6f0d-e849-4ccd-ae5b-a599e264fdd9",
"roles": [
"TL_CEMP"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "066dbe57-0544-49b5-99ff-8a41db47fe4e",
"tenantId": "pb.amritsar",
"currentState": "154d6f0d-e849-4ccd-ae5b-a599e264fdd9",
"action": "PAY",
"nextState": "100b4f89-4919-4707-869c-27cdae233510",
"roles": [
"CITIZEN",
"TL_CEMP",
"SYSTEM_PAYMENT"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "100b4f89-4919-4707-869c-27cdae233510",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "APPROVED",
"applicationStatus": "APPROVED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"auditDetails": {
"createdBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1631013999749,
"lastModifiedTime": 1631013999749
},
"uuid": "34fdc858-0de7-458e-878e-de0687fd288d",
"tenantId": "pb.amritsar",
"currentState": "100b4f89-4919-4707-869c-27cdae233510",
"action": "MANUALEXPIRE",
"nextState": "46b6b561-8865-4430-8d87-125241959d44",
"roles": [
"TL_APPROVER"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1582783848282,
"lastModifiedTime": 1631013999749
},
"uuid": "9dc96dec-c765-4c4a-9117-0eda51464032",
"tenantId": "pb.amritsar",
"currentState": "100b4f89-4919-4707-869c-27cdae233510",
"action": "EXPIRE",
"nextState": "eca7b42f-098b-492c-bcae-d0172eea87ac",
"roles": [
"SYSTEM"
],
"active": true
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "dc9db8fe-7d88-4f58-a936-ea9eed0f9cc8",
"tenantId": "pb.amritsar",
"currentState": "100b4f89-4919-4707-869c-27cdae233510",
"action": "CANCEL",
"nextState": "d2a67ae6-115c-47a0-90a9-06e1681838fd",
"roles": [
"TL_APPROVER"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
},
"uuid": "d2a67ae6-115c-47a0-90a9-06e1681838fd",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "CANCELLED",
"applicationStatus": "CANCELLED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1577343048587,
"lastModifiedTime": 1631013999749
},
"uuid": "c4a30c94-9a18-4f9f-888f-d78f601579d3",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": 10000,
"state": "CITIZENACTIONREQUIRED",
"applicationStatus": "CITIZENACTIONREQUIRED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"auditDetails": {
"createdBy": "746412f0-93cc-4da2-8aff-33301aad92fc",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1626351791203,
"lastModifiedTime": 1631013999749
},
"uuid": "22631b2f-cd9c-4c12-871e-fae3b5c70a78",
"tenantId": "pb.amritsar",
"currentState": "c4a30c94-9a18-4f9f-888f-d78f601579d3",
"action": "FORWARD",
"nextState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"roles": [
"CITIZEN",
"TL_CEMP"
],
"active": true
},
{
"auditDetails": {
"createdBy": "746412f0-93cc-4da2-8aff-33301aad92fc",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1626351791203,
"lastModifiedTime": 1631013999749
},
"uuid": "1daf3475-2b3a-4515-8438-e5ca54159b5e",
"tenantId": "pb.amritsar",
"currentState": "c4a30c94-9a18-4f9f-888f-d78f601579d3",
"action": "RESUBMIT",
"nextState": "0ce1cd2e-1d9f-4f69-83db-cb94953d97de",
"roles": [
"TL_CEMP",
"CITIZEN"
],
"active": true
}
]
},
{
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1582783848282,
"lastModifiedTime": 1631013999749
},
"uuid": "eca7b42f-098b-492c-bcae-d0172eea87ac",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "EXPIRED",
"applicationStatus": "EXPIRED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"auditDetails": {
"createdBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1631013999749,
"lastModifiedTime": 1631013999749
},
"uuid": "46b6b561-8865-4430-8d87-125241959d44",
"tenantId": "pb.amritsar",
"businessServiceId": "dcbab4f5-613b-4a4e-b242-3909e602c20f",
"sla": null,
"state": "MANUALEXPIRED",
"applicationStatus": "MANUALEXPIRED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
}
],
"auditDetails": {
"createdBy": "f6b0e1cf-5764-4570-9a95-5051d41ef468",
"lastModifiedBy": "33fcada3-984b-4906-a528-7336e3f03af1",
"createdTime": 1554799584412,
"lastModifiedTime": 1631013999749
}
}
]
}