Public Grievance Redressal Service API

Rainmaker-PGR Service Contract

Get service requests

Gets the list of service requests for a particular ULB based on search criteria.

• name: group in: query description: Attribute of service config, it indicate the "Department" for which service type is defined. required: false type: string format: varchar
• name: serviceCode in: query description: Allows search for service type - comma separated list. type: array items: type: string format: varchar
• name: startDate in: query description: Earliest epoch time to include in search - request created time | required: false type: integer format: int64
• name: endDate in: query description: Latest epoch time to include in search - request created time | If search is on start date then end date is mandatory, if end date is null then server will take current date as end date. required: false type: integer format: int64
• name: lastUpdatedSince in: query description: searches all requests that have been modified/created since last modified epoch time as provided here required: false type: integer format: int64

POSThttps://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_search

Response

200400

Successful response sorted by reverse chrnological order of creation

Body

*/*

services*array of Service (object)

actionHistoryarray of ActionHistory (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 0,
      "long": 0,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "status": "New",
      "source": "sms",
      "expectedTime": 0,
      "feedback": "text",
      "rating": "text",
      "landmark": "text"
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 0,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}

Create service requests

Create new service requests - supports batch - please note that in case of errors entire batch is rejected

POSThttps://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_create

Body

application/json

RequestInfo + ServiceRequest array for updation

services*array of Service (object)

actionInfoarray of ActionInfo (object)

Response

200400

Service Request Created

Body

*/*

services*array of Service (object)

actionHistoryarray of ActionHistory (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "services": [
        {
          "tenantId": "text",
          "serviceCode": "text",
          "phone": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 0,
      "long": 0,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "status": "New",
      "source": "sms",
      "expectedTime": 0,
      "feedback": "text",
      "rating": "text",
      "landmark": "text"
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 0,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}

Update service requests

Updates service request - supports batch - please note that in case of errors entire batch is rejected

POSThttps://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_update

Body

application/json

RequestInfo + ServiceRequest array for updation

services*array of Service (object)

actionInfoarray of ActionInfo (object)

Response

200400

Service Request updated

Body

*/*

services*array of Service (object)

actionHistoryarray of ActionHistory (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "services": [
        {
          "tenantId": "text",
          "serviceCode": "text",
          "phone": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 0,
      "long": 0,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "status": "New",
      "source": "sms",
      "expectedTime": 0,
      "feedback": "text",
      "rating": "text",
      "landmark": "text"
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 0,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}