Public Grievance Redressal

DIGIT Specifications

Platform Urban Sanitation

search

post

Query parameters

offsetinteger · int32Optional

serviceRequestIdsstring[]Optional

tenantIdsstring[]Optional

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v2/_migrate HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "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"
  }
}

{}

getReports

post

Body

reportNamestringRequired

tenantIdstringRequired

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/reports/_get HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 506

{
  "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"
}

{}

count

post

Query parameters

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

activebooleanOptional

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

createdBystringOptional

endDateinteger · int64Optional

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

lastUpdatedSinceinteger · int64Optional

noOfRecordsinteger · int64Optional

offsetinteger · int64Optional

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

serviceCodesstring[]Optional

serviceRequestIdstring[]Optional

startDateinteger · int64Optional

statusstring[]Optional

tenantIdstring · min: 2 · max: 25RequiredPattern: ^[a-zA-Z.]*$

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v1/requests/_count HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "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"
  }
}

{}

create

post

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v1/requests/_create HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 1691

{
  "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"
    }
  ]
}

{}

plainsearch

post

Query parameters

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

activebooleanOptional

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

createdBystringOptional

endDateinteger · int64Optional

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

lastUpdatedSinceinteger · int64Optional

noOfRecordsinteger · int64Optional

offsetinteger · int64Optional

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

serviceCodesstring[]Optional

serviceRequestIdstring[]Optional

startDateinteger · int64Optional

statusstring[]Optional

tenantIdstring · min: 2 · max: 25RequiredPattern: ^[a-zA-Z.]*$

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v1/requests/_plainsearch HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "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"
  }
}

{}

search

post

Query parameters

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

activebooleanOptional

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

createdBystringOptional

endDateinteger · int64Optional

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

lastUpdatedSinceinteger · int64Optional

noOfRecordsinteger · int64Optional

offsetinteger · int64Optional

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

serviceCodesstring[]Optional

serviceRequestIdstring[]Optional

startDateinteger · int64Optional

statusstring[]Optional

tenantIdstring · min: 2 · max: 25RequiredPattern: ^[a-zA-Z.]*$

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v1/requests/_search HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "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"
  }
}

{}

update

post

Body

Responses

200

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

POST /rainmaker-pgr/v2/v1/requests/_update HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 1691

{
  "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"
    }
  ]
}

{}