Public Grievance Redressal

Public Grievance Redressal APIs

Allows citizens to raise complaints, give feedback on the resolved complaints, or reopen complaints if not satisfied.

search

post

Query parameters

offsetinteger · int32optional

serviceRequestIdsstring[]optional

tenantIdsstring[]optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v2/_migrate' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{}

OK

getReports

post

Body

RequestInfoobjectrequired

reportNamestringrequired

searchParamsobject[]optional

tenantIdstringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/reports/_get' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    },
    "reportName": "text",
    "searchParams": [
      {
        "input": {},
        "name": "text"
      }
    ],
    "tenantId": "text"
  }'

200

201

401

403

404

200

{}

OK

count

post

Query parameters

accountIdstringoptional

Pattern: ^[a-zA-Z0-9]$

activebooleanoptional

assignedTostringoptional

Pattern: ^[a-zA-Z0-9]$

createdBystringoptional

endDateinteger · int64optional

groupstringoptional

Pattern: ^[a-zA-Z.]$

lastUpdatedSinceinteger · int64optional

noOfRecordsinteger · int64optional

offsetinteger · int64optional

phonestringoptional

Pattern: (^$|[0-9]{10})

serviceCodesstring[]optional

serviceRequestIdstring[]optional

startDateinteger · int64optional

statusstring[]optional

tenantIdstring · min: 2 · max: 25required

Pattern: ^[a-zA-Z.]*$

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v1/requests/_count?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{}

OK

create

post

Body

RequestInfoobjectoptional

actionInfoobject[]optional

servicesobject[]required

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v1/requests/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    },
    "actionInfo": [
      {
        "action": "text",
        "assignee": "text",
        "businessKey": "text",
        "by": "text",
        "comments": "text",
        "isInternal": true,
        "media": [
          "text"
        ],
        "status": "text",
        "tenantId": "text",
        "uuid": "text",
        "when": 1
      }
    ],
    "services": [
      {
        "accountId": "text",
        "active": true,
        "address": "text",
        "addressDetail": {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "city": "text",
          "houseNoAndStreetName": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": "text",
          "longitude": 1,
          "mohalla": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "addressId": "text",
        "attributes": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "citizen": {
          "aadhaarNumber": "text",
          "active": true,
          "emailId": "text",
          "gender": "FEMALE",
          "id": 1,
          "mobileNumber": "text",
          "name": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "roles": [
            {
              "code": "text",
              "name": "text",
              "tenantId": "text"
            }
          ],
          "tenantId": "text",
          "type": "BUSINESS",
          "userName": "text",
          "uuid": "text"
        },
        "description": "text",
        "deviceId": "text",
        "email": "text",
        "expectedTime": 1,
        "feedback": "text",
        "firstName": "text",
        "landmark": "text",
        "lastName": "text",
        "lat": 1,
        "long": 1,
        "phone": "text",
        "rating": "text",
        "serviceCode": "text",
        "serviceRequestId": "text",
        "source": "RB Bot",
        "status": "assigned",
        "tenantId": "text"
      }
    ]
  }'

200

201

401

403

404

200

{}

OK

plainsearch

post

Query parameters

accountIdstringoptional

Pattern: ^[a-zA-Z0-9]$

activebooleanoptional

assignedTostringoptional

Pattern: ^[a-zA-Z0-9]$

createdBystringoptional

endDateinteger · int64optional

groupstringoptional

Pattern: ^[a-zA-Z.]$

lastUpdatedSinceinteger · int64optional

noOfRecordsinteger · int64optional

offsetinteger · int64optional

phonestringoptional

Pattern: (^$|[0-9]{10})

serviceCodesstring[]optional

serviceRequestIdstring[]optional

startDateinteger · int64optional

statusstring[]optional

tenantIdstring · min: 2 · max: 25required

Pattern: ^[a-zA-Z.]*$

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v1/requests/_plainsearch?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{}

OK

search

post

Query parameters

accountIdstringoptional

Pattern: ^[a-zA-Z0-9]$

activebooleanoptional

assignedTostringoptional

Pattern: ^[a-zA-Z0-9]$

createdBystringoptional

endDateinteger · int64optional

groupstringoptional

Pattern: ^[a-zA-Z.]$

lastUpdatedSinceinteger · int64optional

noOfRecordsinteger · int64optional

offsetinteger · int64optional

phonestringoptional

Pattern: (^$|[0-9]{10})

serviceCodesstring[]optional

serviceRequestIdstring[]optional

startDateinteger · int64optional

statusstring[]optional

tenantIdstring · min: 2 · max: 25required

Pattern: ^[a-zA-Z.]*$

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v1/requests/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{}

OK

update

post

Body

RequestInfoobjectoptional

actionInfoobject[]optional

servicesobject[]required

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/v1/requests/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    },
    "actionInfo": [
      {
        "action": "text",
        "assignee": "text",
        "businessKey": "text",
        "by": "text",
        "comments": "text",
        "isInternal": true,
        "media": [
          "text"
        ],
        "status": "text",
        "tenantId": "text",
        "uuid": "text",
        "when": 1
      }
    ],
    "services": [
      {
        "accountId": "text",
        "active": true,
        "address": "text",
        "addressDetail": {
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "city": "text",
          "houseNoAndStreetName": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": "text",
          "longitude": 1,
          "mohalla": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "addressId": "text",
        "attributes": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "citizen": {
          "aadhaarNumber": "text",
          "active": true,
          "emailId": "text",
          "gender": "FEMALE",
          "id": 1,
          "mobileNumber": "text",
          "name": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "roles": [
            {
              "code": "text",
              "name": "text",
              "tenantId": "text"
            }
          ],
          "tenantId": "text",
          "type": "BUSINESS",
          "userName": "text",
          "uuid": "text"
        },
        "description": "text",
        "deviceId": "text",
        "email": "text",
        "expectedTime": 1,
        "feedback": "text",
        "firstName": "text",
        "landmark": "text",
        "lastName": "text",
        "lat": 1,
        "long": 1,
        "phone": "text",
        "rating": "text",
        "serviceCode": "text",
        "serviceRequestId": "text",
        "source": "RB Bot",
        "status": "assigned",
        "tenantId": "text"
      }
    ]
  }'

200

201

401

403

404

200

{}

OK