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:
{
"RequestInfo": {
"apiId": "Rainmaker",
"action": "",
"did": 1,
"key": "",
"msgId": "20170310130900|en_IN",
"requesterId": "",
"ts": 1513579888683,
"ver": ".01",
"authToken": "{{devAuth}}",
"userInfo": {
"id": 73,
"userName": null,
"name": null,
"type": "EMPLOYEE",
"mobileNumber": null,
"emailId": null,
"roles": [
{
"id": 2,
"name": "Customer Support Representative",
"code": null,
"tenantId": null
}
],
"tenantId": null,
"uuid": "uuid"
}
},
"BusinessServices": [
{
"tenantId": "pb.amritsar",
"businessService": "NewTL",
"business": "tl-services",
"businessServiceSla": 172800000,
"states": [
{
"tenantId": "pb.amritsar",
"sla": null,
"state": null,
"applicationStatus": null,
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "INITIATE",
"nextState": "INITIATED",
"roles": [
"CITIZEN",
"TL_CEMP"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "INITIATED",
"applicationStatus": "INITIATED",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "APPLY",
"nextState": "APPLIED",
"roles": [
"CITIZEN",
"TL_CEMP"
]
},
{
"tenantId": "pb.amritsar",
"action": "INITIATE",
"nextState": "INITIATED",
"roles": [
"CITIZEN",
"TL_CEMP"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "APPLIED",
"applicationStatus": "APPLIED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "FORWARD",
"nextState": "FIELDINSPECTION",
"roles": [
"TL_DOC_VERIFIER"
]
},
{
"tenantId": "pb.amritsar",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"TL_DOC_VERIFIER"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "REJECTED",
"applicationStatus": "REJECTED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"tenantId": "pb.amritsar",
"sla": 86400000,
"state": "FIELDINSPECTION",
"applicationStatus": "FIELDINSPECTION",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "SENDBACKTOCITIZEN",
"nextState": "CITIZENACTIONREQUIRED",
"roles": [
"TL_FIELD_INSPECTOR"
]
},
{
"tenantId": "pb.amritsar",
"action": "FORWARD",
"nextState": "PENDINGAPPROVAL",
"roles": [
"TL_FIELD_INSPECTOR"
]
},
{
"tenantId": "pb.amritsar",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"TL_FIELD_INSPECTOR"
]
},
{
"tenantId": "pb.amritsar",
"action": "SENDBACK",
"nextState": "APPLIED",
"roles": [
"TL_FIELD_INSPECTOR"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": 43200000,
"state": "PENDINGAPPROVAL",
"applicationStatus": "PENDINGAPPROVAL",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "SENDBACK",
"nextState": "FIELDINSPECTION",
"roles": [
"TL_APPROVER"
]
},
{
"tenantId": "pb.amritsar",
"action": "APPROVE",
"nextState": "PENDINGPAYMENT",
"roles": [
"TL_APPROVER"
]
},
{
"tenantId": "pb.amritsar",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"TL_APPROVER"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": 43200000,
"state": "PENDINGPAYMENT",
"applicationStatus": "PENDINGPAYMENT",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "ADHOC",
"nextState": "PENDINGPAYMENT",
"roles": [
"TL_CEMP"
]
},
{
"tenantId": "pb.amritsar",
"action": "PAY",
"nextState": "APPROVED",
"roles": [
"CITIZEN",
"TL_CEMP",
"SYSTEM_PAYMENT"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "APPROVED",
"applicationStatus": "APPROVED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "EXPIRE",
"nextState": "EXPIRED",
"roles": [
"SYSTEM"
]
},
{
"tenantId": "pb.amritsar",
"action": "CANCEL",
"nextState": "CANCELLED",
"roles": [
"TL_APPROVER"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "CANCELLED",
"applicationStatus": "CANCELLED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "CITIZENACTIONREQUIRED",
"applicationStatus": "CITIZENACTIONREQUIRED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",
"action": "RESUBMIT",
"nextState": "FIELDINSPECTION",
"roles": [
"TL_CEMP"
]
},
{
"tenantId": "pb.amritsar",
"action": "FORWARD",
"nextState": "FIELDINSPECTION",
"roles": [
"CITIZEN",
"TL_CEMP"
]
}
]
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "EXPIRED",
"applicationStatus": "EXPIRED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
}
]
}
]
}