1 of 5

Citizen Engagement Configuration

Service Request

Service Request Module Configuration

Overview

The service request functionality empowers users to define and then create services based on predefined service definitions. These service definitions can be in the form of surveys or checklists that users can refer to. Subsequently, a service created against a service definition can either serve as a response to a survey or represent a completed checklist.

Pre-requisites

Prior knowledge of Java/J2EE.
Prior knowledge of SpringBoot.
Prior knowledge of PostgreSQL.
Prior knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

Key Functionalities

Users can -

Create and search service definitions
Create and search services

API Details

/service-request/service/definition/v1/_create - Include the RequestInfo and ServiceDefinition within the request body. The ServiceDefinition encapsulates all the essential parameters linked to the creation of the service definition.
/service-request/service/definition/v1/_search - Allows searching of existing service definitions. Takes RequestInfo, ServiceDefinitionCriteria and Pagination objects in the request body.
/service-request/service/v1/_create - Takes RequestInfo and Service in the request body. Service has all the parameters related to the service being created against a particular ServiceDefinition.
/service-request/service/v1/_search - Allows searching of existing services created against service definitions. Takes RequestInfo, ServiceCriteria and Pagination objects in the request body.

Swagger Documentation

Citizen Feedback Service

Citizen feedback service configuration details

Overview

This document is a guide to create a new Survey as well as to create Responses.

Sample Configuration

To create a new survey, use following _create api:

curl --location 'http://localhost:8280/service-request/service/definition/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
    "RequestInfo": {
        "apiId": "Rainmaker",
        "authToken": "f1737fa6-8ae3-4476-8279-b966406c6066",
        "userInfo": {
            "id": 12033,
            "uuid": "5b0db5f1-5695-4ce4-ab81-f185a28bfa62",
            "userName": "QAWSCE",
            "name": "WS Counter Employee",
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "PT Counter Employee",
                    "code": "PT_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "WS Counter Employee",
                    "code": "WS_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "SW Counter Employee",
                    "code": "SW_CEMP",
                    "tenantId": "pb.amritsar"
                }
            ],
            "tenantId": "pb.amritsar"
        },
        "msgId": "1669381536763|en_IN",
        "plainAccessRequest": {}
    },
    "ServiceDefinition": {
        "tenantId": "pb.amritsar",
        "code": "PT_PAYMENT",
        "module": "PT",
        "isActive": true,
        "attributes": [
            {
                "tenantId": "pb.amritsar",
                "code": "consumerCode",
                "dataType": "String",
                "values": null,
                "required": true,
                "isActive": true,
                "regex": null,
                "order": "1",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "referenceId",
                "dataType": "String",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "2",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "rating",
                "dataType": "Number",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": "^[1-5]*$",
                "order": "3",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "comments",
                "dataType": "Text",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "4",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "channel",
                "dataType": "SingleValueList",
                "values": ["Sms", "Online", "InApp"],
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "5",
                "additionalDetails": {}
            }
        ],
        "additionalDetails": {
        },
        "clientId": "f1737fa6-8ae3-4476-8279-b966406c6066"
    }
}'

The ServiceDefinition object requires following properties:

"tenantId" => Takes tenantid
"code": "PT_PAYMENT" => This shall contain the name of the survey, usually corresponding to the name of the flow for which the survey is being created,
"module": "PT" => This denotes the module name for which the survey is to be created,
"isActive": true => This would tell if the survey is isActive or not,
"attributes " => This would contain multiple objects each of which will be a linked to a Question/ property. This question would be mentioned in the "code" property.

Currently Surveys have been created for PT module. We have 4 surveys : PT_CREATE, PT_UPDATE, PT_MUTATION, PT_PAYMENT.

Creating New Survey Response:

To create a survey response(i.e. user response to survey), use following _create api:

curl --location 'http://localhost:8280/service-request/service/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
    "RequestInfo": {
        "apiId": "Rainmaker",
        "authToken": "f1737fa6-8ae3-4476-8279-b966406c6066",
        "userInfo": {
            "id": 12033,
            "uuid": "5b0db5f1-5695-4ce4-ab81-f185a28bfa62",
            "userName": "QAWSCE",
            "name": "WS Counter Employee",
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "PT Counter Employee",
                    "code": "PT_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "WS Counter Employee",
                    "code": "WS_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "SW Counter Employee",
                    "code": "SW_CEMP",
                    "tenantId": "pb.amritsar"
                }
            ],
            "tenantId": "pb.amritsar"
        },
        "msgId": "1669381536763|en_IN",
        "plainAccessRequest": {}
    },
    "Service": {
        "tenantId": "pb.amritsar",
        "serviceDefId": "7fe72b01-32fc-4baa-8024-166f5367a93a",
        "isActive": true,
        "attributes": [
            {
                "attributeCode": "consumerCode",
                "value": "PB-PT-1234",
                "additionalDetails": {}
            },
            {
                "attributeCode": "referenceId",
                "value": "REF-1",
                "additionalDetails": {}
            },
            {
                "attributeCode": "rating",
                "value": 4,
                "additionalDetails": {}
            },
            {
                "attributeCode": "comments",
                "value": "10256",
                "additionalDetails": {}
            },
            {
                "attributeCode": "channel",
                "value": "Online",
                "additionalDetails": {}
            }
        ],
        "additionalDetails": {
        },
        "accountId" : "5b0db5f1-5695-4ce4-ab81-f185a28bfa62"
    }
}'

The Service object requires following properties:

"tenantId" => Takes tenantid
"serviceDefId": "7fe72b01-32fc-4baa-8024-166f5367a93a" => This takes the id of the survey for which the response has to be created,
"isActive": true => This would tell if the survey is active or not,
"attributes " => This would contain multiple objects related to the answer to the questions in the survey.

Reference Docs

For searching existing surveys or their response use _search APIS from the below collection.

Postman-collection : https://api.postman.com/collections/19481088-f3d5018c-aad2-46de-a5a9-609d2acb1e6e?access_key=PMAT-01GVN63T0S1B6G641TD5DWF12P

Citizen Feedback UI

Feedback flow for citizens - UI screens and configuration details

Objective: To provide the user facility to submit feedback/ratings at the end of the service.

Citizen Feedback Flow

Users can provide feedback for the following at the end of the flows for create, mutate, update and payment for property tax. If the review is skipped, users can provide their reviews once the property is active on my application details page. The user will receive a pop-up for the feedback.

In the My Application screen, the service search API is called with tenantId and referenceIds (an array of acknowledgement numbers retrieved from property search) in order to get the data of the submitted feedback. The following labels are displayed on the action button:

If the review is done and active: View.
If the review is not done and active: Rate Us.
If the application is in progress: Track.

API Curl

curl 'https://qa.digit.org/service-request/service/v1/_search?_=1681472244925' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/pt/property/my-applications' \
  -H 'sec-ch-ua: "Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"ServiceCriteria":{"tenantId":"pb.amritsar","referenceIds":["PB-AC-2023-04-13-029319","PB-AC-2023-04-13-029315","PB-AC-2023-04-13-029314","PB-AC-2023-04-11-029112"]},"RequestInfo":{"apiId":"Rainmaker","authToken":"47980bef-b2bb-44d3-80e6-a36354690735","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681472244925|en_IN","plainAccessRequest":{}}}' \
  --compressed

Inside the Application details page also service search is also called in order to check whether the feedback has been done or not, if it has been done for that particular application popup is not visible otherwise pop-up displays once the application details page opens up.

Citizen Feedback Screen

On this screen, the user is able to give a rating by clicking on the stars (out of 5). Once the stars are clicked, according to the value, “What went wrong?” or “What went good?” comment box is visible, which is a non-mandatory field where the user can add their comment for the review/rating.

Citizen Feedback Acknowledgement

Once the user submits the rating, the Search API is called in order to retrieve the service definition for the particular business service, and with that ID the Create API is called for the submission of the review. Based on the success or failure of the call, the screen displays the acknowledgement page. Once the review is submitted, a toast message is displayed providing the status of the submission as a popup.

Search definition API Curl

curl 'https://qa.digit.org/service-request/service/definition/v1/_search?_=1681191005369' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'cookie: _ga=GA1.2.2133756512.1676450222; __cuid=7b0fe5a8761f49f6bff7ede48649b0dc; amp_fef1e8=248239ce-459d-4f23-8e85-6eaecb3b54d0R...1gpckta4o.1gpckta4s.2.0.2' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/feedback?redirectedFrom=/digit-ui/citizen/pt/property/new-application/acknowledgement&propertyId=PB-PT-2023-04-11-029030&acknowldgementNumber=PB-AC-2023-04-11-029111&creationReason=CREATE&tenantId=pb.amritsar' \
  -H 'sec-ch-ua: "Google Chrome";v="111", "Not(A:Brand";v="8", "Chromium";v="111"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"ServiceDefinitionCriteria":{"tenantId":"pb.amritsar","code":["PT_CREATE"],"module":["PT"]},"RequestInfo":{"apiId":"Rainmaker","authToken":"810eb623-32e8-43d3-bf9f-cd1152faf856","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681191005368|en_IN","plainAccessRequest":{}}}' \
  --compressed

For Service Create following request object is needed :

{
    "tenantId": "pb.amritsar",
    "serviceDefId": "aa85214f-8c8c-4f26-a064-6e324479e6bb",
    "isActive": true,
    "attributes": [
        {
            "attributeCode": "consumerCode",
            "value": "PB-PT-2023-04-13-029231",
            "additionalDetails": {}
        },
        {
            "attributeCode": "rating",
            "value": 3,
            "additionalDetails": {}
        },
        {
            "attributeCode": "comments",
            "value": "12345678901234567890123456789012345678901234567890",
            "additionalDetails": {}
        },
        {
            "attributeCode": "channel",
            "value": "Online",
            "additionalDetails": {}
        }
    ],
    "additionalDetails": {
        "locality": "SUN02"
    },
    "accountId": "7d82122e-1e91-4f34-893f-d16963af217a",
    "referenceId": "PB-AC-2023-04-13-029319"
}

Service Create API curl :

curl 'https://qa.digit.org/service-request/service/v1/_create' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/pt/property/application/PB-AC-2023-04-13-029319/pb.amritsar' \
  -H 'sec-ch-ua: "Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"Service":{"tenantId":"pb.amritsar","serviceDefId":"aa85214f-8c8c-4f26-a064-6e324479e6bb","isActive":true,"attributes":[{"attributeCode":"consumerCode","value":"PB-PT-2023-04-13-029231","additionalDetails":{}},{"attributeCode":"rating","value":3,"additionalDetails":{}},{"attributeCode":"comments","value":"12345678901234567890123456789012345678901234567890","additionalDetails":{}},{"attributeCode":"channel","value":"Online","additionalDetails":{}}],"additionalDetails":{"locality":"SUN02"},"accountId":"7d82122e-1e91-4f34-893f-d16963af217a","referenceId":"PB-AC-2023-04-13-029319"},"RequestInfo":{"apiId":"Rainmaker","authToken":"47980bef-b2bb-44d3-80e6-a36354690735","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681472454112|en_IN","plainAccessRequest":{}}}' \
  --compressed

Technical Implementation

The citizen feedback screen and acknowledgement screen can be found inside the core module, path for the same respectively are :

In the Citizen feedback component, the card header, card text and the rating value are fetched from the MDMS file. This is configurable in nature and the following hook is being used to get the MDMS data.

  const { data: RatingAndFeedBack, isLoading: RatingAndFeedBackLoading } = Digit.Hooks.pt.useRatingAndFeedbackMDMS.RatingAndFeedBack(stateId);

MDMS Data

{
    "tenantId": "pb",
    "moduleName": "common-masters",
    "RatingAndFeedback": [
        {
            "type" : "isCitizenRatingEnabled",
            "value" : true
        },
        {
            "type" : "headerByRating",
            "value" : [
                {
                    "minvalue" : 1,
                    "maxvalue" : 3,
                    "code" : "CS_WHAT_WENT_WRONG"
                },
                {
                    "minvalue" : 4,
                    "maxvalue" : 5,
                    "code" : "CS_WHAT_WENT_GOOD"
                }
            ]
        },
        {
            "type" : "enabledScreensList",
            "value" : [
                {
                    "module" : "PT",
                    "bussinessService" : "PT_CREATE",
                    "screenfrom" : "pt/property/new-application/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_CREATE",
                    "cardText" : "PT_RATE_CARD_TEXT_CREATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT_MUTATION",
                    "screenfrom" : "pt/property/property-mutation/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_MUTATE",
                    "cardText" : "PT_RATE_CARD_TEXT_MUTATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT_UPDATE",
                    "screenfrom" : "pt/property/edit-application/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_UPDATE",
                    "cardText" : "PT_RATE_CARD_TEXT_UPDATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT",
                    "screenfrom" : "digit-ui/citizen/payment/success",
                    "cardHeader" : "PT_RATE_HELP_TEXT_PAY",
                    "cardText" : "PT_RATE_CARD_TEXT_PAY"
                 }
            ]
        }
    ]
}

Localisation

Localization keys are added under the ‘rainmaker-common’ locale module. In future, if any new labels are implemented in the Citizen Feedback (Citizen) they should also be pushed in the locale DB under the rainmaker-common locale module.

API Role Action Mapping

Citizen Consent Form UI

UI details for consent forms for citizen users

Objective: This feature allows users to get consent from the citizen during the citizen login. This is needed only on the citizen/architect side of the login. This feature is present on the citizen login page where the user is allowed to make payments without login.

Workflow Details

Citizen users must enter their mobile number and tick the check box. Clicking on the Next button enables users to log in.

The next screen is visible as below:

Enter mandatory fields and tick the check box. Clicking on the Next button enables users to proceed to the next step.

Clicking on Privacy Policy opens a popup with the policy content.

Technical Implementation

Enabling The Feature

Using the MDMS, we can enable or disable the feature by setting the param isCitizenConsentFormEnabled: true or false in the MDMS file (CitizenConsentForm.json). Setting it to true indicates the feature is enabled. Setting it to false indicates the feature is disabled (old logic will work as it is).

Share the HTML file with the DevOps team with the bucket name, they will provide the s3 link for html file.

{
  "tenantId": "pb",
  "moduleName": "common-masters",
  "CitizenConsentForm": [
    {
      "isCitizenConsentFormEnabled": true,
      "checkBoxLabels": [
        {
          "linkPrefix": "CCF_I_AGREE_THE_DIGITS",
          "link": "CCF_PRIVACY_POLICY",
          "linkId": "PrivacyPolicy",
          "linkPostfix": "",
          "en_IN": "https://qa.digit.org/egov-qa-assets/ProductPrivacypolicy.html"
        }
      ]
    }
  ]
}

Here, 1. isCitizenConsentFormEnabled is used to enable the citizen consent form. 2. checkBoxLabels is used to display labels along with the link. 3. link is used to display the link. 4. linkId is used to pass the id to the header to display the header dynamically. 5. en_IN is the language code and is also used to display the content using the s3 link. 6. linkPrefix is used to display the link pre-content. 7. linkPostfix is used to display the link post content. 8. CitizenConsentForm is the mdms config.

Localisation

Localisation keys are added under the ‘rainmaker-common’ locale module.

Citizen Feedback Service

Citizen feedback service configuration details

Overview

This document is a guide to create a new Survey as well as to create Responses.

Sample Configuration

To create a new survey, use following _create api:

curl --location 'http://localhost:8280/service-request/service/definition/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
    "RequestInfo": {
        "apiId": "Rainmaker",
        "authToken": "f1737fa6-8ae3-4476-8279-b966406c6066",
        "userInfo": {
            "id": 12033,
            "uuid": "5b0db5f1-5695-4ce4-ab81-f185a28bfa62",
            "userName": "QAWSCE",
            "name": "WS Counter Employee",
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "PT Counter Employee",
                    "code": "PT_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "WS Counter Employee",
                    "code": "WS_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "SW Counter Employee",
                    "code": "SW_CEMP",
                    "tenantId": "pb.amritsar"
                }
            ],
            "tenantId": "pb.amritsar"
        },
        "msgId": "1669381536763|en_IN",
        "plainAccessRequest": {}
    },
    "ServiceDefinition": {
        "tenantId": "pb.amritsar",
        "code": "PT_PAYMENT",
        "module": "PT",
        "isActive": true,
        "attributes": [
            {
                "tenantId": "pb.amritsar",
                "code": "consumerCode",
                "dataType": "String",
                "values": null,
                "required": true,
                "isActive": true,
                "regex": null,
                "order": "1",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "referenceId",
                "dataType": "String",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "2",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "rating",
                "dataType": "Number",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": "^[1-5]*$",
                "order": "3",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "comments",
                "dataType": "Text",
                "values": null,
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "4",
                "additionalDetails": {}
            },
            {
                "tenantId": "pb.amritsar",
                "code": "channel",
                "dataType": "SingleValueList",
                "values": ["Sms", "Online", "InApp"],
                "required": true,
                "isActive": true,
                "reGex": null,
                "order": "5",
                "additionalDetails": {}
            }
        ],
        "additionalDetails": {
        },
        "clientId": "f1737fa6-8ae3-4476-8279-b966406c6066"
    }
}'

The ServiceDefinition object requires following properties:

"tenantId" => Takes tenantid
"code": "PT_PAYMENT" => This shall contain the name of the survey, usually corresponding to the name of the flow for which the survey is being created,
"module": "PT" => This denotes the module name for which the survey is to be created,
"isActive": true => This would tell if the survey is isActive or not,
"attributes " => This would contain multiple objects each of which will be a linked to a Question/ property. This question would be mentioned in the "code" property.

Currently Surveys have been created for PT module. We have 4 surveys : PT_CREATE, PT_UPDATE, PT_MUTATION, PT_PAYMENT.

Creating New Survey Response:

To create a survey response(i.e. user response to survey), use following _create api:

curl --location 'http://localhost:8280/service-request/service/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
    "RequestInfo": {
        "apiId": "Rainmaker",
        "authToken": "f1737fa6-8ae3-4476-8279-b966406c6066",
        "userInfo": {
            "id": 12033,
            "uuid": "5b0db5f1-5695-4ce4-ab81-f185a28bfa62",
            "userName": "QAWSCE",
            "name": "WS Counter Employee",
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "PT Counter Employee",
                    "code": "PT_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "WS Counter Employee",
                    "code": "WS_CEMP",
                    "tenantId": "pb.amritsar"
                },
                {
                    "name": "SW Counter Employee",
                    "code": "SW_CEMP",
                    "tenantId": "pb.amritsar"
                }
            ],
            "tenantId": "pb.amritsar"
        },
        "msgId": "1669381536763|en_IN",
        "plainAccessRequest": {}
    },
    "Service": {
        "tenantId": "pb.amritsar",
        "serviceDefId": "7fe72b01-32fc-4baa-8024-166f5367a93a",
        "isActive": true,
        "attributes": [
            {
                "attributeCode": "consumerCode",
                "value": "PB-PT-1234",
                "additionalDetails": {}
            },
            {
                "attributeCode": "referenceId",
                "value": "REF-1",
                "additionalDetails": {}
            },
            {
                "attributeCode": "rating",
                "value": 4,
                "additionalDetails": {}
            },
            {
                "attributeCode": "comments",
                "value": "10256",
                "additionalDetails": {}
            },
            {
                "attributeCode": "channel",
                "value": "Online",
                "additionalDetails": {}
            }
        ],
        "additionalDetails": {
        },
        "accountId" : "5b0db5f1-5695-4ce4-ab81-f185a28bfa62"
    }
}'

The Service object requires following properties:

"tenantId" => Takes tenantid
"serviceDefId": "7fe72b01-32fc-4baa-8024-166f5367a93a" => This takes the id of the survey for which the response has to be created,
"isActive": true => This would tell if the survey is active or not,
"attributes " => This would contain multiple objects related to the answer to the questions in the survey.

Reference Docs

For searching existing surveys or their response use _search APIS from the below collection.

Postman-collection : https://api.postman.com/collections/19481088-f3d5018c-aad2-46de-a5a9-609d2acb1e6e?access_key=PMAT-01GVN63T0S1B6G641TD5DWF12P

Citizen Feedback UI

Feedback flow for citizens - UI screens and configuration details

Objective: To provide the user facility to submit feedback/ratings at the end of the service.

Citizen Feedback Flow

If the review is done and active: View.
If the review is not done and active: Rate Us.
If the application is in progress: Track.

API Curl

curl 'https://qa.digit.org/service-request/service/v1/_search?_=1681472244925' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/pt/property/my-applications' \
  -H 'sec-ch-ua: "Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"ServiceCriteria":{"tenantId":"pb.amritsar","referenceIds":["PB-AC-2023-04-13-029319","PB-AC-2023-04-13-029315","PB-AC-2023-04-13-029314","PB-AC-2023-04-11-029112"]},"RequestInfo":{"apiId":"Rainmaker","authToken":"47980bef-b2bb-44d3-80e6-a36354690735","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681472244925|en_IN","plainAccessRequest":{}}}' \
  --compressed

Citizen Feedback Screen

Citizen Feedback Acknowledgement

Search definition API Curl

curl 'https://qa.digit.org/service-request/service/definition/v1/_search?_=1681191005369' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'cookie: _ga=GA1.2.2133756512.1676450222; __cuid=7b0fe5a8761f49f6bff7ede48649b0dc; amp_fef1e8=248239ce-459d-4f23-8e85-6eaecb3b54d0R...1gpckta4o.1gpckta4s.2.0.2' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/feedback?redirectedFrom=/digit-ui/citizen/pt/property/new-application/acknowledgement&propertyId=PB-PT-2023-04-11-029030&acknowldgementNumber=PB-AC-2023-04-11-029111&creationReason=CREATE&tenantId=pb.amritsar' \
  -H 'sec-ch-ua: "Google Chrome";v="111", "Not(A:Brand";v="8", "Chromium";v="111"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"ServiceDefinitionCriteria":{"tenantId":"pb.amritsar","code":["PT_CREATE"],"module":["PT"]},"RequestInfo":{"apiId":"Rainmaker","authToken":"810eb623-32e8-43d3-bf9f-cd1152faf856","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681191005368|en_IN","plainAccessRequest":{}}}' \
  --compressed

For Service Create following request object is needed :

{
    "tenantId": "pb.amritsar",
    "serviceDefId": "aa85214f-8c8c-4f26-a064-6e324479e6bb",
    "isActive": true,
    "attributes": [
        {
            "attributeCode": "consumerCode",
            "value": "PB-PT-2023-04-13-029231",
            "additionalDetails": {}
        },
        {
            "attributeCode": "rating",
            "value": 3,
            "additionalDetails": {}
        },
        {
            "attributeCode": "comments",
            "value": "12345678901234567890123456789012345678901234567890",
            "additionalDetails": {}
        },
        {
            "attributeCode": "channel",
            "value": "Online",
            "additionalDetails": {}
        }
    ],
    "additionalDetails": {
        "locality": "SUN02"
    },
    "accountId": "7d82122e-1e91-4f34-893f-d16963af217a",
    "referenceId": "PB-AC-2023-04-13-029319"
}

Service Create API curl :

curl 'https://qa.digit.org/service-request/service/v1/_create' \
  -H 'authority: qa.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/citizen/pt/property/application/PB-AC-2023-04-13-029319/pb.amritsar' \
  -H 'sec-ch-ua: "Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?1' \
  -H 'sec-ch-ua-platform: "Android"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36' \
  --data-raw '{"Service":{"tenantId":"pb.amritsar","serviceDefId":"aa85214f-8c8c-4f26-a064-6e324479e6bb","isActive":true,"attributes":[{"attributeCode":"consumerCode","value":"PB-PT-2023-04-13-029231","additionalDetails":{}},{"attributeCode":"rating","value":3,"additionalDetails":{}},{"attributeCode":"comments","value":"12345678901234567890123456789012345678901234567890","additionalDetails":{}},{"attributeCode":"channel","value":"Online","additionalDetails":{}}],"additionalDetails":{"locality":"SUN02"},"accountId":"7d82122e-1e91-4f34-893f-d16963af217a","referenceId":"PB-AC-2023-04-13-029319"},"RequestInfo":{"apiId":"Rainmaker","authToken":"47980bef-b2bb-44d3-80e6-a36354690735","userInfo":{"id":16490,"uuid":"7d82122e-1e91-4f34-893f-d16963af217a","userName":"7979797979","name":"Debasish","mobileNumber":"7979797979","emailId":"gubbi678@gmail.com","locale":null,"type":"CITIZEN","roles":[{"name":"Citizen","code":"CITIZEN","tenantId":"pb"}],"active":true,"tenantId":"pb","permanentCity":null},"msgId":"1681472454112|en_IN","plainAccessRequest":{}}}' \
  --compressed

Technical Implementation

The citizen feedback screen and acknowledgement screen can be found inside the core module, path for the same respectively are :

https://github.com/egovernments/DIGIT-Dev/blob/develop/frontend/micro-ui/web/micro-ui-internals/packages/modules/core/src/components/CitizenFeedback.jsgithub.com

https://github.com/egovernments/DIGIT-Dev/blob/develop/frontend/micro-ui/web/micro-ui-internals/packages/modules/core/src/components/AcknowledgementCF.jsgithub.com

  const { data: RatingAndFeedBack, isLoading: RatingAndFeedBackLoading } = Digit.Hooks.pt.useRatingAndFeedbackMDMS.RatingAndFeedBack(stateId);

MDMS Data

RatingAndFeedback.json

{
    "tenantId": "pb",
    "moduleName": "common-masters",
    "RatingAndFeedback": [
        {
            "type" : "isCitizenRatingEnabled",
            "value" : true
        },
        {
            "type" : "headerByRating",
            "value" : [
                {
                    "minvalue" : 1,
                    "maxvalue" : 3,
                    "code" : "CS_WHAT_WENT_WRONG"
                },
                {
                    "minvalue" : 4,
                    "maxvalue" : 5,
                    "code" : "CS_WHAT_WENT_GOOD"
                }
            ]
        },
        {
            "type" : "enabledScreensList",
            "value" : [
                {
                    "module" : "PT",
                    "bussinessService" : "PT_CREATE",
                    "screenfrom" : "pt/property/new-application/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_CREATE",
                    "cardText" : "PT_RATE_CARD_TEXT_CREATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT_MUTATION",
                    "screenfrom" : "pt/property/property-mutation/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_MUTATE",
                    "cardText" : "PT_RATE_CARD_TEXT_MUTATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT_UPDATE",
                    "screenfrom" : "pt/property/edit-application/acknowledgement",
                    "cardHeader" : "PT_RATE_HELP_TEXT_UPDATE",
                    "cardText" : "PT_RATE_CARD_TEXT_UPDATE"
                },
                {
                    "module" : "PT",
                    "bussinessService" : "PT",
                    "screenfrom" : "digit-ui/citizen/payment/success",
                    "cardHeader" : "PT_RATE_HELP_TEXT_PAY",
                    "cardText" : "PT_RATE_CARD_TEXT_PAY"
                 }
            ]
        }
    ]
}

Localisation

API Role Action Mapping

API

Action Id

Role

Citizen Consent Form UI

UI details for consent forms for citizen users

Workflow Details

Citizen users must enter their mobile number and tick the check box. Clicking on the Next button enables users to log in.

The next screen is visible as below:

Enter mandatory fields and tick the check box. Clicking on the Next button enables users to proceed to the next step.

Clicking on Privacy Policy opens a popup with the policy content.

Technical Implementation

Enabling The Feature

The first step is to enable the feature in MDMS and add the check box labels checkBoxLabels in the MDMS file CitizenConsentForm.json.

File Path: SelectMobileNumber.js Component: CitizenConsentForm (File path: CitizenConsentForm.js )

The first step is to enable the feature in MDMS and add the check box labels checkBoxLabels in the MDMS file CitizenConsentForm.json File Path: index.js Component: CitizenConsentForm (File path: CitizenConsentForm.js )

Write the documentation then convert it into HTML. (There are multiple conversion tools online like Convert Word and PDF files to HTML | Free online HTML editor). Use anyone to convert the document to HTML. Before converting make sure to format the document using the above link.
Share the HTML file with the DevOps team with the bucket name, they will provide the s3 link for html file.
Take that link and update it in the MDMS file where we configured before CitizenConsentForm.json. For each instance, we need to create a separate s3 link. Here, use the language as the key and the URL as the param. Example: for English, the language key is en_IN and value is https://qa.digit.org/egov-qa-assets/ProductPrivacypolicy.html

MDMS file: CitizenConsentForm.json

{
  "tenantId": "pb",
  "moduleName": "common-masters",
  "CitizenConsentForm": [
    {
      "isCitizenConsentFormEnabled": true,
      "checkBoxLabels": [
        {
          "linkPrefix": "CCF_I_AGREE_THE_DIGITS",
          "link": "CCF_PRIVACY_POLICY",
          "linkId": "PrivacyPolicy",
          "linkPostfix": "",
          "en_IN": "https://qa.digit.org/egov-qa-assets/ProductPrivacypolicy.html"
        }
      ]
    }
  ]
}

MDMS: The same file is used in OLD UI also i.e. ( CitizenConsentForm.json ) File Path: Added one more object in the login form config. (login.js ) The logic of the Citizen Consent Form is in the below files.

Localisation

Localisation keys are added under the ‘rainmaker-common’ locale module.

Citizen Engagement Configuration

Service Request

Overview

Pre-requisites

Key Functionalities

API Details

Swagger Documentation

Citizen Feedback Service

Overview

Sample Configuration

Creating New Survey Response:

Reference Docs

Citizen Feedback UI

Citizen Feedback Flow

API Curl

Citizen Feedback Screen

Citizen Feedback Acknowledgement

Search definition API Curl

Technical Implementation

MDMS Data

Localisation

API Role Action Mapping

Citizen Consent Form UI

Workflow Details

Technical Implementation

Enabling The Feature

Citizen Login Page

Make Payments Without Login

Configure Consent Form Data - Steps

Citizen Consent Form Old UI Login

Localisation

Citizen Feedback Service

Overview

Sample Configuration

Creating New Survey Response:

Reference Docs

Service Request

Overview

Pre-requisites

Key Functionalities

API Details

Swagger Documentation

Citizen Feedback UI

Citizen Feedback Flow

API Curl

Citizen Feedback Screen

Citizen Feedback Acknowledgement

Search definition API Curl

Technical Implementation

MDMS Data

Localisation

API Role Action Mapping

Citizen Consent Form UI

Workflow Details

Technical Implementation

Enabling The Feature

Citizen Login Page

Make Payments Without Login

Configure Consent Form Data - Steps

Citizen Consent Form Old UI Login

Localisation