> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/local-governance/access/local-governance-stack/citizen-engagement-module/citizen-engagement-configuration/citizen-feedback-service.md). # 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 : --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.digit.org/local-governance/access/local-governance-stack/citizen-engagement-module/citizen-engagement-configuration/citizen-feedback-service.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.