Faecal Sludge Management Service API
Last updated
Was this helpful?
Last updated
Was this helpful?
Gets the list of Vehicle for a particular ULB based on search criteria.
Unique id for a tenant.
Allows search for service type - comma separated list
Search by list of UUID
Search by mobile number of service requester
Search by uuid of service requester
Search by type of the vehicle
Search by model of the vehicle
Search by tankCapacity of the vehicle
sort the search results by fields
type, model, suctionType, pollutionCertiValidTill, InsuranceCertValidTill, fitnessValidTill, roadTaxPaidTill, tankCapicity, createdTimesorting order of the search resulsts
Search by model of the vehicle
limit on the resulsts
offset index of the overall search resulsts
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search?tenantId=text'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"totalCount": "text"
}Successful response sorted by reverse chrnological order of creation
Gets the list of VehicleLog for a particular ULB based on search criteria.
Unique id for a tenant.
Allows search for service type - comma separated list
Search by list of UUID of vehicleLog
Search by list of UUID of of the trip owners
Search by list of UUID of of the drivers
Search by list of UUID of vehicle(s)
Search by the referenceNo(s)
Search by the applicationNo(s)
search by the businessService of the vehicleLog
search by the list of applicationStatus of the vehicleLog
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
ASC, DESCsort the search results by fields
applicationStatus, applicationiNo, referenceNo, vehicle, tripStartTime, tripEndTime, createdTimecurl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search?tenantId=text'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"VehicleTrip": [
{
"tripOwner": {
"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"
}
]
}
]
},
"driver": {
"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",
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text",
"additionalDetail": {},
"status": "ACTIVE",
"businessService": "text",
"tripDetails": [
{
"id": "text",
"tenantId": "text",
"referenceNo": "text",
"referenceStatus": "text",
"additionalDetail": {},
"status": "ACTIVE",
"itemStartTime": 1,
"itemEndTime": 1,
"volume": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationStatus": "text",
"tripStartTime": 1,
"tripEndTime": 1,
"fstpEntryTime": 1,
"fstpExitTime": 1,
"volumeCarried": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"totalCount": "text"
}Successful response sorted by reverse chrnological order of creation
Add the vehicle details into the system
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
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.
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
"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",
"userInfo": {
"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"
}
]
}
]
},
"signature": "text"
},
"vehicle": {
"vehicleOwner": {
"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"
}
]
}
]
},
"tenantId": "text",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"totalCount": "text"
}Request submitted successfully
Updates the details of the vehicle
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
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.
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update' \
--header 'Content-Type: application/json' \
--data '{
"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",
"userInfo": {
"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"
}
]
}
]
},
"signature": "text"
},
"vehicle": {
"vehicleOwner": {
"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"
}
]
}
]
},
"tenantId": "text",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"totalCount": "text"
}Request submitted successfully
Add the vehicleLog details into the system
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
vehicle Trip will be created for each trip for a specific service
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
"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",
"userInfo": {
"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"
}
]
}
]
},
"signature": "text"
},
"VehicleTrip": {
"tripOwner": {
"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"
}
]
}
]
},
"driver": {
"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"
}
]
}
]
},
"tenantId": "text",
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text",
"additionalDetail": {},
"status": "ACTIVE",
"businessService": "text",
"tripDetails": [
{
"id": "text",
"tenantId": "text",
"referenceNo": "text",
"referenceStatus": "text",
"additionalDetail": {},
"status": "ACTIVE",
"itemStartTime": 1,
"itemEndTime": 1,
"volume": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationStatus": "text",
"tripStartTime": 1,
"tripEndTime": 1,
"fstpEntryTime": 1,
"fstpExitTime": 1,
"volumeCarried": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"VehicleTrip": [
{
"tripOwner": {
"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"
}
]
}
]
},
"driver": {
"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",
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text",
"additionalDetail": {},
"status": "ACTIVE",
"businessService": "text",
"tripDetails": [
{
"id": "text",
"tenantId": "text",
"referenceNo": "text",
"referenceStatus": "text",
"additionalDetail": {},
"status": "ACTIVE",
"itemStartTime": 1,
"itemEndTime": 1,
"volume": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationStatus": "text",
"tripStartTime": 1,
"tripEndTime": 1,
"fstpEntryTime": 1,
"fstpExitTime": 1,
"volumeCarried": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"totalCount": "text"
}Request submitted successfully
Updates the details of the vehicleLog
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
vehicle Trip will be created for each trip for a specific service
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update' \
--header 'Content-Type: application/json' \
--data '{
"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",
"userInfo": {
"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"
}
]
}
]
},
"signature": "text"
},
"VehicleTrip": {
"tripOwner": {
"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"
}
]
}
]
},
"driver": {
"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"
}
]
}
]
},
"tenantId": "text",
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text",
"additionalDetail": {},
"status": "ACTIVE",
"businessService": "text",
"tripDetails": [
{
"id": "text",
"tenantId": "text",
"referenceNo": "text",
"referenceStatus": "text",
"additionalDetail": {},
"status": "ACTIVE",
"itemStartTime": 1,
"itemEndTime": 1,
"volume": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationStatus": "text",
"tripStartTime": 1,
"tripEndTime": 1,
"fstpEntryTime": 1,
"fstpExitTime": 1,
"volumeCarried": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}'{
"responseInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"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"
}
]
}
]
},
"correlationId": "text",
"signature": "text"
},
"VehicleTrip": [
{
"tripOwner": {
"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"
}
]
}
]
},
"driver": {
"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",
"vehicle": {
"vehicleOwner": {
"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",
"registrationNumber": "text",
"model": "text",
"type": "text",
"tankCapicity": 1,
"suctionType": "text",
"pollutionCertiValidTill": 1,
"InsuranceCertValidTill": 1,
"fitnessValidTill": 1,
"roadTaxPaidTill": 1,
"gpsEnabled": true,
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"status": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text",
"additionalDetail": {},
"status": "ACTIVE",
"businessService": "text",
"tripDetails": [
{
"id": "text",
"tenantId": "text",
"referenceNo": "text",
"referenceStatus": "text",
"additionalDetail": {},
"status": "ACTIVE",
"itemStartTime": 1,
"itemEndTime": 1,
"volume": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"applicationStatus": "text",
"tripStartTime": 1,
"tripEndTime": 1,
"fstpEntryTime": 1,
"fstpExitTime": 1,
"volumeCarried": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"totalCount": "text"
}Request submitted successfully
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
ASC, DESCsort the search results by fields
applicationStatus, applicationNumber, propertyUsage, vehicle, locality, createdTimecurl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search?tenantId=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": "[Circular Reference]",
"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"
}Successful response sorted by reverse chrnological order of creation
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
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit?tenantId=text'{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsmAudit": {
"who": "text",
"when": 1,
"what": {}
}
}Successful response sorted by reverse chrnological order of creation
Unique id for a tenant.
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
ASC, DESCsort the search results by fields
id, propertyType, capacityserch by ids of the billingslab
search by propertyType
search by capacity
search by slum yes or no
YES, NOcurl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search?tenantId=text'{
"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"
}
]
}Successful response sorted by reverse chrnological order of creation
Apply for desludging
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
Request schema of FSM application.
BPA application object to capture the details of land, land owners, and address of the land.
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create' \
--header 'Content-Type: application/json' \
--data '{
"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": {
"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"
}
]
}
]
},
"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": {
"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": "[Circular Reference]",
"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": {}
}
]
}
}'{
"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": "[Circular Reference]",
"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"
}Application submitted successfully
Updates service request
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
Request schema of FSM application.
BPA application object to capture the details of land, land owners, and address of the land.
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update' \
--header 'Content-Type: application/json' \
--data '{
"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": {
"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"
}
]
}
]
},
"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": {
"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": "[Circular Reference]",
"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": {}
}
]
}
}'{
"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": "[Circular Reference]",
"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"
}Application submitted successfully
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
Representation of billing slab
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
]
}BillingSlab created successfully
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
Representation of billing slab
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
]
}BillingSlab updated successfully
RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.
Calculation Criteria to calcaulte and generate Demand
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate' \
--header 'Content-Type: application/json' \
--data '{
"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": {
"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"
}
]
}
]
},
"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": {
"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": "[Circular Reference]",
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNo": "text"
}
}'{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculations": [
{
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": "[Circular Reference]",
"applicationNumber": "text",
"taxHeadEstimates": [
{
"taxHeadCode": "text",
"estimateAmount": 1,
"category": "TAX"
}
]
}
]
}calculated successfully