Faecal Sludge Management (FSM)

FSM Service APIs

Apply for desludging services, update application details or search applications.

Get application details based on below criteria

post

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 · enumOptional

sort the search results in Ascending or descending order

Available options:

sortBystring · enumOptional

sort the search results by fields

Available options:

Responses

*/*

objectOptional

Response of the FSM

*/*

post

HTTPcURLJavaScriptPython

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

post

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

*/*

objectOptional

Response of the FSM Audit search

post

HTTPcURLJavaScriptPython

POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit 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

post

Apply for desludging

Body

Request object for FSM

requestInfoobjectRequired

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.

fsmobjectRequired

Request schema of FSM application.

workflowobjectOptional

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

objectOptional

Response of the FSM

*/*

post

HTTPcURLJavaScriptPython

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

Update service requests

post

Updates service request

Body

Request object for FSM

requestInfoobjectRequired

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.

fsmobjectRequired

Request schema of FSM application.

workflowobjectOptional

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

objectOptional

Response of the FSM

*/*

post

HTTPcURLJavaScriptPython

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

getCreatedByMe

post

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createdbyme HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

{}

createPeriodicApplications

post

Body

RequestInfoobjectOptional

applicationNoListstring[]Optional

tenantIdstringOptional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

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

getFSMApplicationsForPeriodicServices

post

Query parameters

tenantIdstringRequired

tenantId

Body

RequestInfoobjectOptional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

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

plainsearch

post

Query parameters

applicationNosstring[]Optional

applicationStatusstring[]Optional

applicationTypestringOptional

fromDateinteger · int64Optional

idsstring[]Optional

limitinteger · int32Optional

localitystring[]Optional

mobileNumberstringOptional

offsetinteger · int32Optional

oldApplicationNosstring[]Optional

ownerIdsstring[]Optional

sortBystring · enumOptionalAvailable options:

sortOrderstring · enumOptionalAvailable options:

tenantIdstringOptional

toDateinteger · int64Optional

Body

RequestInfoobjectOptional

Responses

*/*

objectOptional

Response of the FSM

post

HTTPcURLJavaScriptPython

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

schedulePeriodicApplications

post

Body

RequestInfoobjectOptional

Responses

post

HTTPcURLJavaScriptPython

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

Create Billing Slab record for the combination of propertyusage, slum ,tancapcity

post

Body

Request object for BillingSlab

requestInfoobjectRequired

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.

fsmobjectOptional

Representation of billing slab

Responses

*/*

objectOptional

Response of the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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

update Billing Slab record for the combination of propertyusage, slum ,tancapcity

post

Body

Request object for BillingSlab

requestInfoobjectRequired

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.

fsmobjectOptional

Representation of billing slab

Responses

*/*

objectOptional

Response of the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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

Get the BillingSlab based on the search criteria

post

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

offsetintegerOptional

offset for the pagination results

limitintegerOptional

limit for the pagination results

sortOrderstring · enumOptional

sort the search results in Ascending or descending order

Available options:

sortBystring · enumOptional

sort the search results by fields

Available options:

idsstring[]Optional

serch by ids of the billingslab

propertyTypestringOptional

search by propertyType

capacitynumber · doubleOptional

search by capacity

slumstring · enumOptional

search by slum yes or no

Available options:

Responses

*/*

objectOptional

Response of the BillingSlab

post

HTTPcURLJavaScriptPython

POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search 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

Body

Request object for Calcuation

requestInfoobjectRequired

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.

CalulationCriteriaobjectRequired

Calculation Criteria to calcaulte and generate Demand

Responses

*/*

objectOptional

Response of the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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

Calcualte the FSM Charge, based on the billingslab . Does not create demand

post

Body

Request object for Calcuation

requestInfoobjectRequired

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.

CalulationCriteriaobjectRequired

Calculation Criteria to calcaulte and generate Demand

Responses

*/*

objectOptional

Response of the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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