Complaints API Specs
Query parameters
accountIdstringOptional
applicationStatusstring[]Optional
fromDateinteger · int64Optional
idsstring[]Optional
isPlainSearchbooleanOptional
limitinteger · int32Optional
localitystring[]Optional
mobileNumberstringOptional
offsetinteger · int32Optional
serviceCodestring[]Optional
serviceRequestIdstringOptional
slaDeltaMaxLimitinteger · int64Optional
slaDeltaMinLimitinteger · int64Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
userIdsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/v2/request/_countPOST /v2/request/_count HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "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"
}
}{
"ResponseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
},
"count": 1
}Body
Request object to fetch the report data
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/v2/request/_createPOST /v2/request/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1666
{
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "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"
},
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}{
"ServiceWrappers": [
{
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}
],
"averageResolutionTime": 1,
"complaintTypes": 1,
"complaintsResolved": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Query parameters
accountIdstringOptional
applicationStatusstring[]Optional
fromDateinteger · int64Optional
idsstring[]Optional
isPlainSearchbooleanOptional
limitinteger · int32Optional
localitystring[]Optional
mobileNumberstringOptional
offsetinteger · int32Optional
serviceCodestring[]Optional
serviceRequestIdstringOptional
slaDeltaMaxLimitinteger · int64Optional
slaDeltaMinLimitinteger · int64Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
userIdsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/v2/request/_plainsearchPOST /v2/request/_plainsearch HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "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"
}
}{
"ServiceWrappers": [
{
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}
],
"averageResolutionTime": 1,
"complaintTypes": 1,
"complaintsResolved": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Query parameters
accountIdstringOptional
applicationStatusstring[]Optional
fromDateinteger · int64Optional
idsstring[]Optional
isPlainSearchbooleanOptional
limitinteger · int32Optional
localitystring[]Optional
mobileNumberstringOptional
offsetinteger · int32Optional
serviceCodestring[]Optional
serviceRequestIdstringOptional
slaDeltaMaxLimitinteger · int64Optional
slaDeltaMinLimitinteger · int64Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
userIdsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/v2/request/_searchPOST /v2/request/_search HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "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"
}
}{
"ServiceWrappers": [
{
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}
],
"averageResolutionTime": 1,
"complaintTypes": 1,
"complaintsResolved": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Body
Request object to fetch the report data
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/v2/request/_updatePOST /v2/request/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1666
{
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "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"
},
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}{
"ServiceWrappers": [
{
"service": {
"accountId": "text",
"active": true,
"additionalDetail": {},
"address": {
"additionDetails": {},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"additionalDetails": {},
"latitude": 1,
"longitude": 1
},
"id": "text",
"landmark": "text",
"locality": {
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"applicationStatus": "text",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"citizen": {
"active": true,
"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"
},
"description": "text",
"id": "text",
"rating": 1,
"serviceCode": "text",
"serviceRequestId": "text",
"source": "text",
"tenantId": "text"
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"verificationDocuments": [
{
"additionalDetails": {},
"documentType": "text",
"documentUid": "text",
"fileStoreId": "text",
"id": "text"
}
]
}
}
],
"averageResolutionTime": 1,
"complaintTypes": 1,
"complaintsResolved": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}Last updated
Was this helpful?