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/firenoc-calculator//v1/_calculate

Body

*/*

required parameters have to be populated

RequestInfo*RequestInfo (object)

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.

CalulationCriteria*array of CalulationCriteria (object)

Response

200400

Success response with calculated tax amount.

Body

*/*

ResponseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Calculationarray of Calculation (object)

Request

JavaScriptCurl

const response = await fetch('/firenoc-calculator//v1/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "CalulationCriteria": [
        {
          "tenantId": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculation": [
    {
      "applicationNumber": "text",
      "fireNoc": {
        "id": "text",
        "tenantId": "text",
        "fireNOCNumber": "text",
        "provisionFireNOCNumber": "text",
        "oldFireNOCNumber": "text",
        "fireNOCDetails": {
          "id": "text",
          "applicationNumber": "text",
          "fireNOCType": "text",
          "firestationId": "text",
          "financialYear": "text",
          "action": "INITIATE",
          "channel": "COUNTER",
          "noOfBuildings": "text",
          "buildings": [
            {
              "id": "text",
              "tenantId": "text",
              "name": "text",
              "usageType": "text",
              "uoms": [
                {
                  "code": "text",
                  "value": "text",
                  "isActiveUom": false,
                  "active": false
                }
              ],
              "applicationDocuments": [
                {
                  "tenantId": "text",
                  "documentType": "text",
                  "fileStoreId": "text",
                  "documentUid": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text"
                  }
                }
              ]
            }
          ],
          "propertyDetails": {
            "id": "text",
            "propertyId": "text",
            "address": {
              "tenantId": "text",
              "doorNo": "text",
              "latitude": 0,
              "longitude": 0,
              "addressId": "text",
              "addressNumber": "text",
              "type": "text",
              "addressLine1": "text",
              "addressLine2": "text",
              "landmark": "text",
              "city": "text",
              "pincode": "text",
              "detail": "text",
              "buildingName": "text",
              "street": "text",
              "locality": {
                "code": "text",
                "name": "text",
                "label": "text",
                "latitude": "text",
                "longitude": "text",
                "children": [],
                "materializedPath": "text"
              }
            }
          },
          "applicantDetails": {
            "ownerShipType": "text",
            "owners": [
              {
                "userName": "text",
                "password": "password",
                "salutation": "text",
                "name": "text",
                "gender": "text",
                "mobileNumber": "text",
                "emailId": "text",
                "altContactNumber": "text",
                "pan": "text",
                "aadhaarNumber": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPincode": "text",
                "correspondenceCity": "text",
                "correspondencePincode": "text",
                "correspondenceAddress": "text",
                "active": false,
                "dob": "2024-04-28",
                "pwdExpiryDate": "2024-04-28",
                "locale": "text",
                "type": "text",
                "signature": "text",
                "accountLocked": false,
                "roles": [
                  {
                    "name": "text",
                    "code": "text",
                    "description": "text",
                    "createdDate": "2024-04-28",
                    "lastModifiedDate": "2024-04-28",
                    "tenantId": "text"
                  }
                ],
                "fatherOrHusbandName": "text",
                "bloodGroup": "text",
                "identificationMark": "text",
                "photo": "text",
                "createdDate": "2024-04-28",
                "lastModifiedDate": "2024-04-28",
                "otpReference": "text",
                "tenantId": "text",
                "isPrimaryOwner": false,
                "ownerShipPercentage": 0,
                "ownerType": "text",
                "relationship": "FATHER"
              }
            ],
            "additionalDetail": {}
          },
          "additionalDetail": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "tenantId": "text",
      "taxHeadEstimates": [
        {
          "category": "text",
          "taxHeadCode": "text",
          "setimateAmount": 0
        }
      ]
    }
  ]
}

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

Generates bill for payment.

POST/firenoc-calculator//v1/_getbill

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

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

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

Response

200400

Success response calculated tax amount.

Body

*/*

idstring

Id of the bill

mobileNumberstring

MobileNumber of the payer.

payerNamestring

name of the payer.

payerAddressstring

Address details from the payer.

payerEmailstring

email address of the payer.

isActiveboolean

true when active bill is created, false when inactive bill is created.

isCancelledboolean

true when cancelled bill is cancelled, false when non-cancelled bill is created.

additionalDetailsobject

field for capturing any additional details.

taxAndPaymentsarray of taxAndPayment (object)

billDetailsarray of BillDetail (object)

tenantIdstring

Unique Identifier of the tenant

auditDetailsAuditDetails_2 (object)

Collection of audit related fields used by most models

Request

JavaScriptCurl

const response = await fetch('/firenoc-calculator//v1/_getbill', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

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

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

Get the properties list based on the input parameters.

POST/firenoc-calculator//billingslab/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

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

ts*integer (int64)

time in epoch

action*string

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

didstring

Device ID from which the API is called

keystring

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

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

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

userInfoUserInfo (object)

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

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BillingSlabsarray of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('/firenoc-calculator//billingslab/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": false,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 0,
      "uom": "text",
      "fromUom": 0,
      "toUom": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create new billing slabs for Fire NOC calculation.

API to billing slabs for Fire NOC calculation.

POST/firenoc-calculator//billingslab/_create

Body

*/*

Details for the new slab + RequestInfo meta data.

RequestInfo*RequestInfo (object)

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.

BillingSlabs*array of BillingSlab (object)

Response

201400

Billing Slab(s) created sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BillingSlabsarray of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('/firenoc-calculator//billingslab/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "BillingSlabs": [
        {
          "buildingUsageType": "text",
          "calculationType": "SINGLESLAB",
          "fireNOCType": "NEW",
          "rate": 0,
          "tenantId": "text",
          "uom": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": false,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 0,
      "uom": "text",
      "fromUom": 0,
      "toUom": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Update existing billing slabs.

Updates a given billing slab with new properties

POST/firenoc-calculator//billingslab/_update

Body

*/*

Request header for the update of billing slab.

RequestInfo*RequestInfo (object)

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.

BillingSlabs*array of BillingSlab (object)

Response

200400

Update Billing Slab(s) successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BillingSlabsarray of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('/firenoc-calculator//billingslab/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "BillingSlabs": [
        {
          "buildingUsageType": "text",
          "calculationType": "SINGLESLAB",
          "fireNOCType": "NEW",
          "rate": 0,
          "tenantId": "text",
          "uom": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": false,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 0,
      "uom": "text",
      "fromUom": 0,
      "toUom": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}