Overview
Faecal sludge management (FSM) is a system that enables citizen to raise a request for septic tank cleaning with there ULB’s directly or reaching out to ULB counter. Citizen can track the application, make a payment for the charges and rate the service. This document contains the details about how to setup the fsm and describes the functionalities it provides.
...
Code Block |
---|
{ "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", "businessService": "FSM", "business": "fsm", "businessServiceSla": 172800000, "states": [ { "tenantId": "pb", "sla": null, "state": null, "applicationStatus": null, "docUploadRequired": false, "isStartState": true, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "action": "APPLY", "nextState": "PENDING_APPL_FEE_PAYMENT", "roles": [ "FSM_CREATOR_EMP" ] }, { "tenantId": "pb", "action": "CREATE", "nextState": "CREATED", "roles": [ "CITIZEN" ] } ] }, { "tenantId": "pb", "sla": null, "state": "CREATED", "applicationStatus": "CREATED", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "action": "REJECT", "nextState": "REJECTED", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "action": "SUBMIT", "nextState": "PENDING_APPL_FEE_PAYMENT", "roles": [ "FSM_EDITOR_EMP" ] } ] }, { "tenantId": "pb", "sla": null, "state": "PENDING_APPL_FEE_PAYMENT", "applicationStatus": "PENDING_APPL_FEE_PAYMENT", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "action": "REJECT", "nextState": "REJECTED", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "action": "SENDBACK", "nextState": "CREATED", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "action": "PAY", "nextState": "ASSING_DSO", "roles": [ "CITIZEN", "FSM_COLLECTOR" ] } ] }, { "tenantId": "pb", "sla": null, "state": "ASSING_DSO", "applicationStatus": "ASSING_DSO", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "action": "SENDBACK", "nextState": "PENDING_APPL_FEE_PAYMENT", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "action": "CANCEL", "nextState": "CANCELED", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "action": "ASSIGN", "nextState": "PENDING_DSO_APPROVAL", "roles": [ "FSM_EDITOR_EMP" ] } ] }, { "tenantId": "pb", "sla": null, "state": "DSO_REJECTED", "applicationStatus": "DSO_REJECTED", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "currentState": "DSO_REJECTED", "action": "CANCEL", "nextState": "CANCELED", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "currentState": "DSO_REJECTED", "action": "REASSING", "nextState": "PENDING_DSO_APPROVAL", "roles": [ "FSM_EDITOR_EMP" ] }, { "tenantId": "pb", "currentState": "DSO_REJECTED", "action": "SENDBACK", "nextState": "PENDING_DSO_APPROVAL", "roles": [ "FSM_ADMIN" ] } ] }, { "tenantId": "pb", "sla": null, "state": "DSO_INPROGRESS", "applicationStatus": "DSO_INPROGRESS", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "currentState": "DSO_INPROGRESS", "action": "SENDBACK", "nextState": "PENDING_DSO_APPROVAL", "roles": [ "FSM_ADMIN" ] }, { "tenantId": "pb", "currentState": "DSO_INPROGRESS", "action": "DECLINE", "nextState": "ASSING_DSO", "roles": [ "FSM_DSO", "FSM_EDITOR_EMP" ] }, { "tenantId": "pb", "currentState": "DSO_INPROGRESS", "action": "COMPLETED", "nextState": "CITIZEN_FEEDBACK_PENDING", "roles": [ "FSM_DSO", "FSM_EDITOR_EMP" ] }, { "tenantId": "pb", "currentState": "DSO_INPROGRESS", "action": "CANCEL", "nextState": "CANCELED", "roles": [ "FSM_ADMIN" ] } ] }, { "tenantId": "pb", "sla": null, "state": "PENDING_DSO_APPROVAL", "applicationStatus": "PENDING_DSO_APPROVAL", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "tenantId": "pb", "currentState": "PENDING_DSO_APPROVAL", "action": "DSO_REJECT", "nextState": "DSO_REJECTED", "roles": [ "FSM_DSO" ] }, { "tenantId": "pb", "currentState": "PENDING_DSO_APPROVAL", "action": "DSO_ACCEPT", "nextState": "DSO_INPROGRESS", "roles": [ "FSM_DSO" ] }, { "tenantId": "pb", "currentState": "PENDING_DSO_APPROVAL", "action": "CANCEL", "nextState": "CANCELED", "roles": [ "FSM_ADMIN" ] } ] }, { "tenantId": "pb", "sla": null, "state": "COMPLETED", "applicationStatus": "COMPLETED", "docUploadRequired": false, "isStartState": false, "isTerminateState": true, "isStateUpdatable": false }, { "sla": null, "state": "REJECTED", "applicationStatus": "REJECTED", "docUploadRequired": false, "isStartState": false, "isTerminateState": true, "isStateUpdatable": false, "actions": null }, { "tenantId": "pb", "sla": null, "state": "CANCELED", "applicationStatus": "CANCELED", "docUploadRequired": false, "isStartState": false, "isTerminateState": true, "isStateUpdatable": false, "actions": null }, { "tenantId": "pb", "sla": null, "state": "CITIZEN_FEEDBACK_PENDING", "applicationStatus": "CITIZEN_FEEDBACK_PENDING", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": false, "actions": [ { "tenantId": "pb", "currentState": "CITIZEN_FEEDBACK_PENDING", "action": "SUBMIT_FEEDBACK", "nextState": "COMPLETED", "roles": [ "CITIZEN" ] } ] } ] } ] } |
...
Using /localization/messages/v1/_upsert
, add localisation (templates) for notification messages to be sent. Following are the product notification templates:
Code Block |
---|
{ "messages":[ { "code": "FSM_SMS_CREATED_CREATE", "message": "Dear Applicant,Your application for cleaning septic tank/pit is created with application reference no.<2>.You will be notified to make an application fee shortly.Request is expected to be completed within 24hrs<SLA_HOURS>hrs of making the payment.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_PENDING_APPL_FEE_PAYMENT_SUBMIT", "message": "Dear Applicant, Please pay the application fee Rs.<AMOUNT_TO_BE_PAID>/- for cleaning the septic tank/pit with request number <2>.Click this link <PAY_LINK> to make the payment.Request is expected to be completed within 24hrs<SLA_HOURS>hrs of making the payment.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_PENDING_APPL_FEE_PAYMENT_APPLY", "message": "Dear Applicant, Your application for cleaning septic tank /pit is created with application number <2>.Please click this link <PAY_LINK> to pay the application fee for processing the application.Request is expected to be completed within 24hrs<SLA_HOURS>hrs of making the payment.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_ASSING_DSO_PAY", "message": "Dear Applicant, Amount of Rs.<AMOUNT_TO_BE_PAID>/- is received towards the payment of cleaning septic tank /pit with reference no. <RECEIPT_NO>.You will be notified when an operator is assigned to a request. Please click this link <RECEIPT_LINK> to download the receipt", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_DSO_INPROGRESS_DSO_ACCEPT", "message": "Dear Applicant, Vehicle <VEHICLE_REG_NO> will be reaching your location to clean the septic tank/pit on <POSSIBLE_SERVICE_DATE> with reference to your application number <2>. You can contact the operator in +91 <DSO_MOBILE_NUMBER>.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_CITIZEN_FEEDBACK_PENDING_COMPLETED", "message": "Dear Applicant, Your request for cleaning septic tank/pit is completed.Please take some time to rate us using the link <FSM_APPL_LINK>.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_DSO_REJECTED_DSO_REJECT", "message": "Dear Applicant, Your request for cleaning the septic tank/pit is rejected with the reason <FSM_DSO_REJECT_REASON> . Please use this link <NEW_FSM_LINK> to create a new request if needed.", "module": "rainmaker-common", "locale": "en_IN" }, { "code": "FSM_SMS_CANCELED_CANCEL", "message": "Dear Applicant, Your request for cleaning the septic tank/pit is cancelled with the reason <FSM_CANCEL_REASON> . Please use this link <NEW_FSM_LINK> to create a new request if needed.", "module": "rainmaker-common", "locale": "en_IN" } ] } |
...
Title | Link |
Workflow Technical Document | |
User Technical Document | |
MDMS Technical Document | NEEDS TO BE UPDATED |
IDGen Technical Document | NEEDS TO BE UPDATED |
Localization Technical Document | NEEDS TO BE UPDATED |
Persister Technical Document | NEEDS TO BE UPDATED |
SMS Notification Technical Document | NEEDS TO BE UPDATED |
HRMS Technical Document | NEEDS TO BE UPDATED |
API Contract | |
Postman Collection |
...