Trade License

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:

Requirements:

Prior Knowledge of Java/J2EE.
Prior Knowledge of Spring Boot.
Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.
Prior knowledge of Git.
Prior knowledge of eGov-mdms service, eGov-persister, eGov-user, eGov-location, eGov-localization, eGov-idgen, billing-service and eGov-URL-shortener

Functionalities:

1.Creation:

The /_create 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.

2.Search

The /_search API is used to search the applications in the system based on various search parameters like mobile number, application number,status etc.

3.Updation:

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

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
renewal.pending.interval	86400000	The interval (in milliseconds) before which we should be able to renew the license after expiration
egov.applicationcount.period	12	The interval (in months) till which application count is required
egov.application.validity	1	The validity(in years) of a trade license.

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:

The workflow is similar to a state-machine comprising of various states and machines. The next state in the workflow is a function if the current state and the action. There are 3 business services in trade license NewTL, EDITRENEWAL, DIRECTRENEWAL. Each of these business services has a workflow associated to it. The following is an example of the NewTL workflow.

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

Persister file:

The following is the link to the persister file for the Trade License service
https://github.com/egovernments/DIGIT-Dev/blob/master/municipal-services/tl-services/src/main/resources/tradelicense.yml

External API URLs

eGov mdms
egov.mdms.host = https://egov-micro-dev.egovernments.org
eGov -idGen
egov.idgen.host = https://egov-micro-dev.egovernments.org/
eGov - workflow
workflow.host = https://egov-micro-dev.egovernments.org/
eGov - user
egov.user.host=https://egov-micro-dev.egovernments.org
boundary service
egov.location.host=https://egov-micro-dev.egovernments.org
tl- Calculation service
egov.calculation.host = https://egov-micro-dev.egovernments.org
localization service
egov.localization.host = https://egov-micro-dev.egovernments.org
billing-service
egbs.host=https://egov-micro-dev.egovernments.org/
Url-Shortner
egov.url.shortner.host=http://egov-url-shortening.egov:8080

Kafka Topics:

persister.save.tradelicense.topic=save-tl-tradelicense

persister.update.tradelicense.topic=update-tl-tradelicense

persister.update.tradelicense.workflow.topic=update-tl-workflow

persister.update.tradelicense.adhoc.topic=update-tl-adhoc-tradelicense

kafka.topics.receipt.create=egov.collection.payment-create

kafka.topics.notification.sms=egov.core.notification.sms

kafka.topics.notification.email=egov.core.notification.email

egov.usr.events.create.topic=persist-user-events-async

egov.tl.batch.reminder.error.topic=tl-batch-reminder-error-topic

egov.tl.batch.expire.error.topic=tl-batch-expire-error-topic

ID Gen Configs:

egov.idgen.path=egov-idgen/id/_generate

egov.idgen.tl.applicationNum.name=tl.aplnumber

egov.idgen.tl.applicationNum.format=PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_TL_APL]

egov.idgen.tl.licensenumber.name=tl.licensenumber

egov.idgen.tl.licensenumber.format=PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_PT_LN]

egov.idgen.bpareg.applicationNum.name=bpareg.aplnumber

egov.idgen.bpareg.applicationNum.format=PB-SK-[cy:yyyy-MM-dd]-[SEQ_EG_TL_APL]

egov.idgen.bpareg.licensenumber.name=bpareg.licensenumber

egov.idgen.bpareg.licensenumber.format=PB-SK-[cy:yyyy-MM-dd]-[SEQ_EG_PT_LN]

Search parameter configs:

citizen.allowed.search.params=tenantId,applicationNumber,limit,offset,licenseNumbers,mobileNumber,status,fromDate,toDate,applicationType

employee.allowed.search.params=tenantId,applicationNumber,applicationType,status,mobileNumber,fromDate,toDate,licenseNumbers,oldLicenseNumber,limit,offset

MDMS Data:

The MDMS data for the trade license module is saved in the following directory:
https://github.com/egovernments/egov-mdms-data/tree/UAT/data/pg/TradeLicense

The following is an example of ReminderPeriods.json file in mdms. This file configures reminder period(in milliseconds) for each tenant.

{
    "tenantId": "pg.citya",
    "moduleName": "TradeLicense",
    "ReminderPeriods": [
      {
        "tenantId": "pg.citya",
        "reminderInterval": 12345
      },
      {
        "tenantId": "pg.cityb",
        "reminderInterval": 12345
      },
      {
        "tenantId": "pg.cityc",
        "reminderInterval": 12345  
      }
    ]
  }

Search Response:

The following is the sample search response when the search API of trade license services is hit.

{
    "ResponseInfo": {
        "apiId": "Rainmaker",
        "ver": null,
        "ts": null,
        "resMsgId": "uief87324",
        "msgId": "1652949470097|en_IN",
        "status": "successful"
    },
    "Licenses": [
        {
            "comment": null,
            "id": "f805bc01-63ee-4897-a1cc-153b4cd5599f",
            "tenantId": "pb.amritsar",
            "businessService": "TL",
            "licenseType": "PERMANENT",
            "applicationType": "NEW",
            "workflowCode": "NewTL",
            "licenseNumber": "PB-TL-2022-04-21-002375",
            "applicationNumber": "PB-TL-2022-04-21-024662",
            "oldLicenseNumber": null,
            "propertyId": null,
            "oldPropertyId": null,
            "accountId": "22cc711c-b6a0-4dc1-8a2b-b99f8ead333e",
            "tradeName": "BusinessName",
            "applicationDate": 1650517445996,
            "commencementDate": 1686700800000,
            "issuedDate": 1650519301691,
            "financialYear": "2022-23",
            "validFrom": 1648751400000,
            "validTo": 1680287399000,
            "action": "PAY",
            "assignee": null,
            "wfDocuments": null,
            "status": "APPROVED",
            "tradeLicenseDetail": {
                "id": "74e375f8-a617-4e20-89f8-7604bc686083",
                "surveyNo": null,
                "subOwnerShipCategory": "INDIVIDUAL.MULTIPLEOWNERS",
                "structureType": "IMMOVABLE.PUCCA",
                "operationalArea": null,
                "noOfEmployees": null,
                "adhocExemption": null,
                "adhocPenalty": null,
                "adhocExemptionReason": null,
                "adhocPenaltyReason": null,
                "owners": [
                    {
                        "id": 48574,
                        "uuid": "944ca11e-aace-4451-b0b6-8fce1dc83a17",
                        "userName": "b30258d2-0a0d-4665-b25c-160bb318acd5",
                        "password": null,
                        "salutation": null,
                        "name": "TOwnerName",
                        "gender": "MALE",
                        "mobileNumber": "9222222222",
                        "emailId": null,
                        "altContactNumber": null,
                        "pan": null,
                        "aadhaarNumber": null,
                        "permanentAddress": "HouseNo 576, StreetName, Ajit Nagar - Area1, Amritsar, ",
                        "permanentCity": null,
                        "permanentPinCode": null,
                        "correspondenceCity": null,
                        "correspondencePinCode": null,
                        "correspondenceAddress": null,
                        "active": true,
                        "dob": null,
                        "pwdExpiryDate": 1658293446000,
                        "locale": null,
                        "type": "CITIZEN",
                        "signature": null,
                        "accountLocked": false,
                        "roles": [
                            {
                                "id": null,
                                "name": "Citizen",
                                "code": "CITIZEN",
                                "tenantId": "pb"
                            }
                        ],
                        "fatherOrHusbandName": "TGuardianName",
                        "bloodGroup": null,
                        "identificationMark": null,
                        "photo": null,
                        "createdBy": "15195",
                        "createdDate": 1650517446000,
                        "lastModifiedBy": "12032",
                        "lastModifiedDate": 1650519062000,
                        "otpReference": null,
                        "tenantId": "pb",
                        "isPrimaryOwner": null,
                        "ownerShipPercentage": null,
                        "ownerType": null,
                        "institutionId": null,
                        "documents": null,
                        "userActive": true,
                        "relationship": "FATHER"
                    }
                ],
                "channel": "CITIZEN",
                "address": {
                    "id": "a7aa5ed9-3dc4-4cb1-9a05-1cff079f7326",
                    "tenantId": "pb.amritsar",
                    "doorNo": "HouseNo 576",
                    "latitude": null,
                    "longitude": null,
                    "addressId": null,
                    "addressNumber": null,
                    "type": null,
                    "addressLine1": null,
                    "addressLine2": null,
                    "landmark": null,
                    "city": null,
                    "pincode": null,
                    "detail": null,
                    "buildingName": null,
                    "street": "StreetName",
                    "locality": {
                        "code": "SUN04",
                        "name": "Ajit Nagar - Area1",
                        "label": "Locality",
                        "latitude": null,
                        "longitude": null,
                        "children": [],
                        "materializedPath": null
                    }
                },
                "tradeUnits": [
                    {
                        "id": "042d9980-ee7a-4aa9-8f64-0ee2b8d4e4d0",
                        "tenantId": "pb.amritsar",
                        "active": true,
                        "tradeType": "GOODS.RETAIL.TST-118",
                        "uom": null,
                        "uomValue": null,
                        "auditDetails": null
                    }
                ],
                "accessories": [
                    {
                        "id": "a70998e7-0517-4c21-9756-1d89dd0fb37b",
                        "tenantId": "pb.amritsar",
                        "active": true,
                        "accessoryCategory": "ACC-1",
                        "uom": "HP",
                        "uomValue": "2",
                        "count": 5,
                        "auditDetails": null
                    }
                ],
                "applicationDocuments": [
                    {
                        "id": "1aa010d6-d347-4ff6-99ff-247518cc940f",
                        "active": true,
                        "tenantId": "pb.amritsar",
                        "documentType": "OWNERIDPROOF",
                        "fileStoreId": "4ba78876-3501-4328-825f-ca9258879e8b",
                        "documentUid": null,
                        "auditDetails": null
                    },
                    {
                        "id": "12ea690d-72fa-4cf8-869c-3a55680f589b",
                        "active": true,
                        "tenantId": "pb.amritsar",
                        "documentType": "OWNERSHIPPROOF",
                        "fileStoreId": "fee95769-ee6d-4b0d-adba-365581c80294",
                        "documentUid": null,
                        "auditDetails": null
                    }
                ],
                "verificationDocuments": null,
                "additionalDetail": {
                    "propertyId": "PB-PT-2022-04-20-027963"
                },
                "institution": null,
                "auditDetails": {
                    "createdBy": "22cc711c-b6a0-4dc1-8a2b-b99f8ead333e",
                    "lastModifiedBy": "4dc1010d-4b31-4b31-a596-cec2986ac04c",
                    "createdTime": 1650517445996,
                    "lastModifiedTime": 1650517445996
                }
            },
            "calculation": null,
            "auditDetails": {
                "createdBy": "22cc711c-b6a0-4dc1-8a2b-b99f8ead333e",
                "lastModifiedBy": "4dc1010d-4b31-4b31-a596-cec2986ac04c",
                "createdTime": 1650517445996,
                "lastModifiedTime": 1650519061850
            },
            "fileStoreId": "1934c8d1-3cfc-4853-848f-8c6bd720fb18"
        }
    ],
    "Count": 1,
    "applicationsIssued": 4006,
    "applicationsRenewed": 547,
    "applicationValidity": 1
}

Licenses : This is a list of the licenses in the database according to the search criteria defined.
Count : Total count of the licenses in the database which match the defined search criteria.
applicationsIssued : Total applications created in the respective tenant in the last 30 days.
applicationsRenewed : Total renewal applications in the respective tenant in the last 30 days.

Localization Messages:

The following is the curl for retrieving the localization messages.