Faecal Sludge Management (FSM)

FSM Service APIs

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

Get application details based on below criteria

Gets the list of fsm application for a particular ULB based on search criteria.

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202400

{
  "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",
    "applicationStatus": "text",
    "source": "whatsapp, ivr etc",
    "sanitationtype": "text",
    "vehicleType": "text",
    "vehicleCapacity": "text",
    "paymentPreference": "text",
    "propertyUsage": "text",
    "status": "ACTIVE",
    "vehicleId": "text",
    "dsoId": "text",
    "wasteCollected": 0,
    "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": 0,
      "length": 0,
      "width": 0,
      "diameter": 0,
      "distanceFromRoad": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

Get the application audit log for every change in the response. Provides a record for each set of change

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit

Query parameters

Response

202

Successful response sorted by reverse chrnological order of creation

Body

*/*

fsmAudit*FSMAudit (object)

Representation of FSM Audit

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202

{
  "fsmAudit": {
    "who": "text"
  }
}

Apply for desludging

Apply for desludging

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

Response

202400

Application submitted successfully

Body

*/*

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "fsm": {
        "tenantId": "text",
        "propertyUsage": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "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",
    "applicationStatus": "text",
    "source": "whatsapp, ivr etc",
    "sanitationtype": "text",
    "vehicleType": "text",
    "vehicleCapacity": "text",
    "paymentPreference": "text",
    "propertyUsage": "text",
    "status": "ACTIVE",
    "vehicleId": "text",
    "dsoId": "text",
    "wasteCollected": 0,
    "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": 0,
      "length": 0,
      "width": 0,
      "diameter": 0,
      "distanceFromRoad": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

Update service requests

Updates service request

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

Response

202400

Application submitted successfully

Body

*/*

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "fsm": {
        "tenantId": "text",
        "propertyUsage": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "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",
    "applicationStatus": "text",
    "source": "whatsapp, ivr etc",
    "sanitationtype": "text",
    "vehicleType": "text",
    "vehicleCapacity": "text",
    "paymentPreference": "text",
    "propertyUsage": "text",
    "status": "ACTIVE",
    "vehicleId": "text",
    "dsoId": "text",
    "wasteCollected": 0,
    "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": 0,
      "length": 0,
      "width": 0,
      "diameter": 0,
      "distanceFromRoad": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

getCreatedByMe

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createdbyme

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createdbyme', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

createPeriodicApplications

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createperiodicapplications

Body

application/json

RequestInfoRequestInfo

applicationNoListarray of string

tenantIdstring

Response

200201401403404

OK

Body

*/*

applicationNoListarray of string

responseInfoResponseInfo

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_createperiodicapplications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "applicationNoList": [
    "text"
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

getFSMApplicationsForPeriodicServices

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_getapplicationsforperiodic

Query parameters

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

applicationNoListarray of string

responseInfoResponseInfo

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_getapplicationsforperiodic?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "applicationNoList": [
    "text"
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

plainsearch

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_plainsearch

Query parameters

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_plainsearch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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",
    "applicationStatus": "text",
    "source": "whatsapp, ivr etc",
    "sanitationtype": "text",
    "vehicleType": "text",
    "vehicleCapacity": "text",
    "paymentPreference": "text",
    "propertyUsage": "text",
    "status": "ACTIVE",
    "vehicleId": "text",
    "dsoId": "text",
    "wasteCollected": 0,
    "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": 0,
      "length": 0,
      "width": 0,
      "diameter": 0,
      "distanceFromRoad": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

schedulePeriodicApplications

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_schedular

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_schedular', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create

Body

application/json

Reuqest Schema for BillingSlab

requestInfo*RequestHeader (object)

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.

fsmBillingSlab (object)

Representation of billing slab

Response

202400

BillingSlab created successfully

Body

*/*

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update

Body

application/json

Reuqest Schema for BillingSlab

requestInfo*RequestHeader (object)

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.

fsmBillingSlab (object)

Representation of billing slab

Response

202400

BillingSlab updated successfully

Body

*/*

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

Get the BillingSlab based on the search criteria

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search

Query parameters

Response

202

Successful response sorted by reverse chrnological order of creation

Body

*/*

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

Calcualte the FSM Charges and generate Demand for the same, based on the billingslab

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate

Body

application/json

Reuqest Schema calculate api

requestInfo*RequestHeader (object)

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.

CalulationCriteria*CalulationCriteria (object)

Calculation Criteria to calcaulte and generate Demand

Response

202400

calculated successfully

Body

*/*

Calculations*array of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "CalulationCriteria": {}
    }),
});
const data = await response.json();

Response

202400

{
  "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",
        "applicationStatus": "text",
        "source": "whatsapp, ivr etc",
        "sanitationtype": "text",
        "vehicleType": "text",
        "vehicleCapacity": "text",
        "paymentPreference": "text",
        "propertyUsage": "text",
        "status": "ACTIVE",
        "vehicleId": "text",
        "dsoId": "text",
        "wasteCollected": 0,
        "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": 0,
          "length": 0,
          "width": 0,
          "diameter": 0,
          "distanceFromRoad": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        },
        "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",
          "geoLocation": {
            "latitude": 0,
            "longitude": 0
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNumber": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 0,
          "category": "TAX"
        }
      ]
    }
  ]
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_estimate

Body

application/json

Reuqest Schema estimate api

requestInfo*RequestHeader (object)

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.

CalulationCriteria*any

Response

202400

estimate calculated successfully

Body

*/*

Calculations*array of Calculation (object)

Request

JavaScriptCurlPython

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "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",
        "applicationStatus": "text",
        "source": "whatsapp, ivr etc",
        "sanitationtype": "text",
        "vehicleType": "text",
        "vehicleCapacity": "text",
        "paymentPreference": "text",
        "propertyUsage": "text",
        "status": "ACTIVE",
        "vehicleId": "text",
        "dsoId": "text",
        "wasteCollected": 0,
        "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": 0,
          "length": 0,
          "width": 0,
          "diameter": 0,
          "distanceFromRoad": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNumber": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 0,
          "category": "TAX"
        }
      ]
    }
  ]
}