Public Grievance Redressal Service API

Rainmaker-PGR Service Contract

Get service requests

post

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_search'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 1,
      "long": 1,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "attributes": {},
      "status": "New",
      "source": "sms",
      "expectedTime": 1,
      "feedback": "text",
      "rating": "text",
      "landmark": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 1,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

Create service requests

post

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

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

servicesobject[] · max: 100required

Instance of Service request raised for a particular service. As per extension propsed in the Service definition "attributes" carry the input values requried by metadata definition in the structure as described by the corresponding schema.

• Any one of 'address' or '(lat and lang)' or 'addressid' is mandatory

actionInfoobject[] · max: 100optional

Capture the details of action on service request.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "services": [
      {
        "citizen": {
          "tenantId": "text",
          "name": "text",
          "mobileNumber": "text"
        },
        "tenantId": "text",
        "serviceCode": "text",
        "description": "text",
        "lat": 1,
        "long": 1,
        "address": "text",
        "addressId": "text",
        "email": "text",
        "deviceId": "text",
        "accountId": "text",
        "firstName": "text",
        "lastName": "text",
        "phone": "text",
        "attributes": {},
        "status": "New",
        "source": "sms",
        "expectedTime": 1,
        "feedback": "text",
        "rating": "text",
        "landmark": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "actionInfo": [
      {
        "tenantId": "text",
        "isInternal": "text",
        "action": "text",
        "assignee": "text",
        "media": [
          "text"
        ],
        "comment": "text"
      }
    ]
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 1,
      "long": 1,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "attributes": {},
      "status": "New",
      "source": "sms",
      "expectedTime": 1,
      "feedback": "text",
      "rating": "text",
      "landmark": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 1,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}

Service Request Created

Update service requests

post

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

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

servicesobject[] · max: 100required

Instance of Service request raised for a particular service. As per extension propsed in the Service definition "attributes" carry the input values requried by metadata definition in the structure as described by the corresponding schema.

• Any one of 'address' or '(lat and lang)' or 'addressid' is mandatory

actionInfoobject[] · max: 100optional

Capture the details of action on service request.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/rainmaker-pgr/v2/requests/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "services": [
      {
        "citizen": {
          "tenantId": "text",
          "name": "text",
          "mobileNumber": "text"
        },
        "tenantId": "text",
        "serviceCode": "text",
        "description": "text",
        "lat": 1,
        "long": 1,
        "address": "text",
        "addressId": "text",
        "email": "text",
        "deviceId": "text",
        "accountId": "text",
        "firstName": "text",
        "lastName": "text",
        "phone": "text",
        "attributes": {},
        "status": "New",
        "source": "sms",
        "expectedTime": 1,
        "feedback": "text",
        "rating": "text",
        "landmark": "text",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "actionInfo": [
      {
        "tenantId": "text",
        "isInternal": "text",
        "action": "text",
        "assignee": "text",
        "media": [
          "text"
        ],
        "comment": "text"
      }
    ]
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "services": [
    {
      "citizen": {
        "tenantId": "text",
        "name": "text",
        "mobileNumber": "text"
      },
      "tenantId": "text",
      "serviceCode": "text",
      "serviceRequestId": "text",
      "description": "text",
      "lat": 1,
      "long": 1,
      "address": "text",
      "addressId": "text",
      "email": "text",
      "deviceId": "text",
      "accountId": "text",
      "firstName": "text",
      "lastName": "text",
      "phone": "text",
      "attributes": {},
      "status": "New",
      "source": "sms",
      "expectedTime": 1,
      "feedback": "text",
      "rating": "text",
      "landmark": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "actionHistory": [
    {
      "actions": [
        {
          "tenantId": "text",
          "by": "text",
          "isInternal": "text",
          "when": 1,
          "businessKey": "text",
          "action": "text",
          "status": "text",
          "assignee": "text",
          "media": [
            "text"
          ],
          "comment": "text"
        }
      ]
    }
  ]
}

Service Request updated