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.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
idsstring[]Optional
Search by list of UUID
applicationStatusstring[]Optional
search application by list of application Status(s)
localitystring[]Optional
search application by list of Locality (s)
ownerIdsstring[]Optional
search by list of uuid(s) of the owner of the application
fromDateintegerOptional
search by the created date faling between the fromdate and today
toDateintegerOptional
search by the created date faling between the fromdate and today
applicationNosstring[]Optional
search application by list of applicationNo(s)
mobileNumberstringOptional
Search applicationb by mobileNumber of the Owner of the application
offsetintegerOptional
offset for the pagination results
limitintegerOptional
limit for the pagination results
sortOrderstring · enumOptionalPossible values:
sort the search results in Ascending or descending order
sortBystring · enumOptionalPossible values:
sort the search results by fields
Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
400
Invalid input.
*/*
post
/fsm/v1/_searchPOST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search?tenantId=text 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
post
/fsm/v1/_audit
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
applicationNostringOptional
search for audit log based on the application no of FSM
idstringOptional
search for audit log based on the unique id of the application
Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
post
/fsm/v1/_auditPOST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit?tenantId=text HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
202
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
Body
Request object for FSM
Responses
202
Application submitted successfully
*/*
400
Failed to process the application
*/*
post
/fsm/v1/_createPOST /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
Body
Request object for FSM
Responses
202
Application submitted successfully
*/*
400
Failed to process the application
*/*
post
/fsm/v1/_updatePOST /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"
}Body
applicationNoListstring[]Optional
tenantIdstringOptional
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/fsm/v1/_createperiodicapplicationsPOST /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"
}
}Query parameters
tenantIdstringRequired
tenantId
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/fsm/v1/_getapplicationsforperiodicPOST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_getapplicationsforperiodic?tenantId=text 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"
}
}Query parameters
applicationNosstring[]Optional
applicationStatusstring[]Optional
applicationTypestringOptional
fromDateinteger · int64Optional
idsstring[]Optional
limitinteger · int32Optional
localitystring[]Optional
mobileNumberstringOptional
offsetinteger · int32Optional
oldApplicationNosstring[]Optional
ownerIdsstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
toDateinteger · int64Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/fsm/v1/_plainsearchPOST /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"
}Body
Responses
200
OK
No content
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/fsm/v1/_schedularPOST /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
Create Billing Slab record for the combination of propertyusage, slum ,tancapcity
post
/fsm-calculator/v1/billingSlab/_create
Body
Request object for BillingSlab
Responses
202
BillingSlab created successfully
*/*
400
Failed to process the BillingSlab
*/*
post
/fsm-calculator/v1/billingSlab/_createPOST /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"
}
]
}update Billing Slab record for the combination of propertyusage, slum ,tancapcity
post
/fsm-calculator/v1/billingSlab/_update
Body
Request object for BillingSlab
Responses
202
BillingSlab updated successfully
*/*
400
Failed to process the BillingSlab
*/*
post
/fsm-calculator/v1/billingSlab/_updatePOST /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"
}
]
}Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
offsetintegerOptional
offset for the pagination results
limitintegerOptional
limit for the pagination results
sortOrderstring · enumOptionalPossible values:
sort the search results in Ascending or descending order
sortBystring · enumOptionalPossible values:
sort the search results by fields
idsstring[]Optional
serch by ids of the billingslab
propertyTypestringOptional
search by propertyType
capacitynumber · doubleOptional
search by capacity
slumstring · enumOptionalPossible values:
search by slum yes or no
Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
post
/fsm-calculator/v1/billingSlab/_searchPOST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search?tenantId=text HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
202
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"
}
]
}Calcualte the FSM Charges and generate Demand for the same, based on the billingslab
post
/fsm-calculator/v1/_calculate
Body
Request object for Calcuation
Responses
202
calculated successfully
*/*
400
Failed to process the calcuation
*/*
post
/fsm-calculator/v1/_calculatePOST /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"
}
]
}
]
}Calcualte the FSM Charge, based on the billingslab . Does not create demand
post
/fsm-calculator/v1/_estimate
Body
Request object for Calcuation
Responses
202
estimate calculated successfully
*/*
400
Failed to process the estimate
*/*
post
/fsm-calculator/v1/_estimatePOST /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?