Faecal Sludge Management (FSM)
FSM Service APIs
Apply for desludging services, update application details or search applications.
Gets the list of fsm application for a particular ULB based on search criteria.
Unique id for a tenant.
Search by list of UUID
search application by list of application Status(s)
search application by list of Locality (s)
search by list of uuid(s) of the owner of the application
search by the created date faling between the fromdate and today
search by the created date faling between the fromdate and today
search application by list of applicationNo(s)
Search applicationb by mobileNumber of the Owner of the application
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
sort the search results by fields
Successful response sorted by reverse chrnological order of creation
Invalid input.
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
Get the application audit log for every change in the response. Provides a record for each set of change
Unique id for a tenant.
search for audit log based on the application no of FSM
search for audit log based on the unique id of the application
Successful response sorted by reverse chrnological order of creation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful response sorted by reverse chrnological order of creation
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsmAudit": {
"who": "text",
"when": 1,
"what": {}
}
}
Apply for desludging
Request object for FSM
Application submitted successfully
Failed to process the application
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1405
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
Updates service request
Request object for FSM
Application submitted successfully
Failed to process the application
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1405
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
OK
Created
Unauthorized
Forbidden
Not Found
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createperiodicapplications HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 471
{
"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"
},
"applicationNoList": [
"text"
],
"tenantId": "text"
}
{
"applicationNoList": [
"text"
],
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}
tenantId
OK
Created
Unauthorized
Forbidden
Not Found
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_getapplicationsforperiodic HTTP/1.1
Host: virtserver.swaggerhub.com
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"
}
}
{
"applicationNoList": [
"text"
],
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
}
}
OK
Created
Unauthorized
Forbidden
Not Found
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
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"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
OK
Created
Unauthorized
Forbidden
Not Found
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_schedular HTTP/1.1
Host: virtserver.swaggerhub.com
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"
}
}
No content
Request object for BillingSlab
BillingSlab created successfully
Failed to process the BillingSlab
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"fsm": {
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"status": "ACTIVE"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Request object for BillingSlab
BillingSlab updated successfully
Failed to process the BillingSlab
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"fsm": {
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"status": "ACTIVE"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Unique id for a tenant.
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
sort the search results by fields
serch by ids of the billingslab
search by propertyType
search by capacity
search by slum yes or no
Successful response sorted by reverse chrnological order of creation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful response sorted by reverse chrnological order of creation
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Request object for Calcuation
calculated successfully
Failed to process the calcuation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1201
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"CalulationCriteria": {
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"applicationNo": "text"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculations": [
{
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"taxHeadEstimates": [
{
"taxHeadCode": "text",
"estimateAmount": 1,
"category": "TAX"
}
]
}
]
}
Request object for Calcuation
estimate calculated successfully
Failed to process the estimate
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_estimate HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1201
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"CalulationCriteria": {
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"applicationNo": "text"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculations": [
{
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"taxHeadEstimates": [
{
"taxHeadCode": "text",
"estimateAmount": 1,
"category": "TAX"
}
]
}
]
}
Last updated
Was this helpful?