Fire NOC Calculator

Fire NOC Calculation APIs

APIs to calculate Fire NOC fee.

Calculates Fire NOC fee and generates the respective demands in the system.

Calculate Fire NOC Fee based on criteria.

post

/v1/_calculate

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

CalulationCriteriaobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/firenoc-calculator//v1/_calculate' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"CalulationCriteria":[{"fireNOC":{"tenantId":"text","dateOfApplied":1,"fireNOCDetails":{"fireNOCType":"text","firestationId":"text","financialYear":"text","propertyDetails":{"address":"[Circular Reference]"},"auditDetails":{},"action":"INITIATE","channel":"COUNTER","additionalDetail":{},"buildings":[{"tenantId":"text","name":"text","usageType":"text","uoms":[{}],"applicationDocuments":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}]}],"applicantDetails":{"additionalDetail":{},"owners":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}],"documents":{},"relationship":"FATHER"}]}},"auditDetails":{}},"tenantId":"text"}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "applicationNumber": "text",
      "fireNoc": {
        "id": "text",
        "tenantId": "text",
        "fireNOCNumber": "text",
        "provisionFireNOCNumber": "text",
        "oldFireNOCNumber": "text",
        "dateOfApplied": 1,
        "fireNOCDetails": {
          "fireNOCType": "text",
          "firestationId": "text",
          "financialYear": "text",
          "propertyDetails": {
            "address": "[Circular Reference]"
          },
          "auditDetails": {},
          "action": "INITIATE",
          "channel": "COUNTER",
          "additionalDetail": {},
          "buildings": [
            {
              "tenantId": "text",
              "name": "text",
              "usageType": "text",
              "uoms": [
                {}
              ],
              "applicationDocuments": [
                {
                  "tenantId": "text",
                  "documentType": "text",
                  "fileStoreId": "text",
                  "auditDetails": {}
                }
              ]
            }
          ],
          "applicantDetails": {
            "additionalDetail": {},
            "owners": [
              {
                "userName": "text",
                "name": "text",
                "gender": "text",
                "mobileNumber": "text",
                "active": true,
                "locale": "text",
                "type": "text",
                "tenantId": "text",
                "roles": [
                  {
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "documents": {},
                "relationship": "FATHER"
              }
            ]
          }
        },
        "auditDetails": {}
      },
      "tenantId": "text",
      "taxHeadEstimates": [
        {
          "category": "text",
          "taxHeadCode": "text",
          "setimateAmount": 1
        }
      ]
    }
  ]
}

Success response with calculated tax amount.

Updates demand with time based penalty if applicable and Generates bill for the given criteria.

Generates bill for payment.

post

/v1/_getbill

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

consumerCodestringrequired

Unique Fire NOC application number.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/firenoc-calculator//v1/_getbill?tenantId=text&consumerCode=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "id": "text",
  "mobileNumber": "text",
  "payerName": "text",
  "payerAddress": "text",
  "payerEmail": "text",
  "isActive": true,
  "isCancelled": true,
  "tenantId": "text",
  "auditDetails": {
    "createdBy": "text",
    "lastModifiedBy": "text",
    "createdTime": 1,
    "lastModifiedTime": 1
  },
  "additionalDetails": {},
  "taxAndPayments": [
    {
      "businessService": "text",
      "taxAmount": "text",
      "amountPaid": "text"
    }
  ],
  "billDetails": [
    {
      "id": "text",
      "tenantId": "text",
      "demandId": "text",
      "bill": "text",
      "businessService": "text",
      "billNumber": "text",
      "billDate": 1,
      "consumerCode": "text",
      "consumerType": "text",
      "minimumAmount": 1,
      "totalAmount": 1,
      "fromPeriod": 1,
      "toPeriod": 1,
      "collectedAmount": 1,
      "partPaymentAllowed": true,
      "status": "CREATED",
      "additionalDetails": {},
      "collectionModesNotAllowed": [
        "text"
      ],
      "billAccountDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "billDetail": "text",
          "demandDetailId": "text",
          "order": 1,
          "amount": 1,
          "adjustedAmount": 1,
          "isActualDemand": true,
          "glcode": "text",
          "taxHeadCode": "text",
          "purpose": "ARREAR",
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Success response calculated tax amount.

Get the list of bill slabs defined in the system for Fire NOC calculation.

Get the properties list based on the input parameters.

post

/billingslab/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

isActiveboolean · varchar

True will be set in cases where only active billslab entries are needed and False will be set when inactive billslab entries are needed .

fireNOCTypestring · enum

Fire NOC type for bulling slab.

Options: NEW, PROVISIONAL

buildingUsageTypestring · min: 4 · max: 128

buildingUsageType of property.

calculationTypestring · enum · min: 4 · max: 128

Enum for billing slab type.

Options: SINGLESLAB, MULTISLAB, FLAT

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

API version - for HTTP based request this will be same as used in path

tsinteger · int64required

time in epoch

actionstring · max: 32required

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

API key (API key provided to the caller in case of server to server communication)

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoobject

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/firenoc-calculator//billingslab/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "buildingUsageType": "text",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      },
      "fireNOCType": "NEW",
      "calculationType": "SINGLESLAB"
    }
  ]
}

Successful response

Create new billing slabs for Fire NOC calculation.

API to billing slabs for Fire NOC calculation.

post

/billingslab/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BillingSlabsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/firenoc-calculator//billingslab/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BillingSlabs":[{"tenantId":"text","buildingUsageType":"text","rate":1,"uom":"text","fromDate":1,"auditDetails":{"createdBy":"text","createdDate":1,"lastModifiedBy":"text","lastModifiedDate":1},"fireNOCType":"NEW","calculationType":"SINGLESLAB"}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "buildingUsageType": "text",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      },
      "fireNOCType": "NEW",
      "calculationType": "SINGLESLAB"
    }
  ]
}

Billing Slab(s) created sucessfully

Update existing billing slabs.

Updates a given billing slab with new properties

post

/billingslab/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.

BillingSlabsobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/firenoc-calculator//billingslab/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BillingSlabs":[{"tenantId":"text","buildingUsageType":"text","rate":1,"uom":"text","fromDate":1,"auditDetails":{"createdBy":"text","createdDate":1,"lastModifiedBy":"text","lastModifiedDate":1},"fireNOCType":"NEW","calculationType":"SINGLESLAB"}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "buildingUsageType": "text",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      },
      "fireNOCType": "NEW",
      "calculationType": "SINGLESLAB"
    }
  ]
}

Update Billing Slab(s) successful