DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Domain Service Specs

Fire NOC Calculator

PreviousFire NOCNextHousehold

Last updated 2 years ago

Was this helpful?

Fire NOC Calculation APIs

APIs to calculate Fire NOC fee.

  • Fire NOC Calculation APIs
  • POSTCalculates Fire NOC fee and generates the respective demands in the system.
  • POSTUpdates demand with time based penalty if applicable and Generates bill for the given criteria.
  • POSTGet the list of bill slabs defined in the system for Fire NOC calculation.
  • POSTCreate new billing slabs for Fire NOC calculation.
  • POSTUpdate existing billing slabs.

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

post

Calculate Fire NOC Fee based on criteria.

Body
Responses
200
Success response with calculated tax amount.
*/*
400
Error response in case of failures.
*/*
post
POST /_calculate HTTP/1.1
Host: v1
Content-Type: */*
Accept: */*
Content-Length: 2483

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "CalulationCriteria": [
    {
      "fireNOC": {
        "tenantId": "text",
        "provisionFireNOCNumber": "text",
        "oldFireNOCNumber": "text",
        "dateOfApplied": 1,
        "fireNOCDetails": {
          "fireNOCType": "text",
          "firestationId": "text",
          "financialYear": "text",
          "validFrom": 1,
          "validTo": 1,
          "action": "INITIATE",
          "channel": "COUNTER",
          "noOfBuildings": "text",
          "buildings": [
            {
              "tenantId": "text",
              "name": "text",
              "usageType": "text",
              "uoms": [
                {
                  "code": "text",
                  "value": "text",
                  "isActiveUom": true,
                  "active": true
                }
              ],
              "applicationDocuments": [
                {
                  "tenantId": "text",
                  "documentType": "text",
                  "fileStoreId": "text",
                  "documentUid": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ],
          "propertyDetails": {
            "propertyId": "text",
            "address": "[Circular Reference]"
          },
          "applicantDetails": {
            "ownerShipType": "text",
            "owners": [
              {
                "id": 1,
                "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": true,
                "dob": "2025-06-01",
                "locale": "text",
                "type": "text",
                "signature": "text",
                "accountLocked": true,
                "roles": [
                  {
                    "id": 1,
                    "name": "text",
                    "code": "text",
                    "description": "text",
                    "createdBy": 1,
                    "createdDate": "2025-06-01",
                    "lastModifiedBy": 1,
                    "lastModifiedDate": "2025-06-01",
                    "tenantId": "text"
                  }
                ],
                "fatherOrHusbandName": "text",
                "bloodGroup": "text",
                "identificationMark": "text",
                "photo": "text",
                "createdBy": 1,
                "createdDate": "2025-06-01",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-06-01",
                "otpReference": "text",
                "tenantId": "text",
                "isPrimaryOwner": true,
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "relationship": "FATHER",
                "documents": {}
              }
            ],
            "additionalDetail": {}
          },
          "additionalDetail": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "applicationNumber": "text",
      "tenantId": "text"
    }
  ]
}
{
  "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": {
          "id": "text",
          "applicationNumber": "text",
          "fireNOCType": "text",
          "firestationId": "text",
          "applicationDate": 1,
          "financialYear": "text",
          "issuedDate": 1,
          "validFrom": 1,
          "validTo": 1,
          "action": "INITIATE",
          "channel": "COUNTER",
          "noOfBuildings": "text",
          "buildings": [
            {
              "id": "text",
              "tenantId": "text",
              "name": "text",
              "usageType": "text",
              "uoms": [
                {
                  "code": "text",
                  "value": "text",
                  "isActiveUom": true,
                  "active": true
                }
              ],
              "applicationDocuments": [
                {
                  "tenantId": "text",
                  "documentType": "text",
                  "fileStoreId": "text",
                  "documentUid": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ],
          "propertyDetails": {
            "id": "text",
            "propertyId": "text",
            "address": "[Circular Reference]"
          },
          "applicantDetails": {
            "ownerShipType": "text",
            "owners": [
              {
                "id": 1,
                "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": true,
                "dob": "2025-06-01",
                "pwdExpiryDate": "2025-06-01",
                "locale": "text",
                "type": "text",
                "signature": "text",
                "accountLocked": true,
                "roles": [
                  {
                    "id": 1,
                    "name": "text",
                    "code": "text",
                    "description": "text",
                    "createdBy": 1,
                    "createdDate": "2025-06-01",
                    "lastModifiedBy": 1,
                    "lastModifiedDate": "2025-06-01",
                    "tenantId": "text"
                  }
                ],
                "fatherOrHusbandName": "text",
                "bloodGroup": "text",
                "identificationMark": "text",
                "photo": "text",
                "createdBy": 1,
                "createdDate": "2025-06-01",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-06-01",
                "otpReference": "text",
                "tenantId": "text",
                "isPrimaryOwner": true,
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "relationship": "FATHER",
                "documents": {}
              }
            ],
            "additionalDetail": {}
          },
          "additionalDetail": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "tenantId": "text",
      "taxHeadEstimates": [
        {
          "category": "text",
          "taxHeadCode": "text",
          "setimateAmount": 1
        }
      ]
    }
  ]
}

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

post

Generates bill for payment.

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

consumerCodestringRequired

Unique Fire NOC application number.

Body

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.

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: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

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: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringRead-onlyOptional
Responses
200
Success response calculated tax amount.
*/*
400
Error response in case of failures.
*/*
post
POST /_getbill?tenantId=text&consumerCode=text HTTP/1.1
Host: v1
Content-Type: */*
Accept: */*
Content-Length: 430

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text",
  "userInfo": {
    "tenantId": "text",
    "uuid": "text",
    "userName": "text",
    "password": "text",
    "idToken": "text",
    "mobile": "text",
    "email": "text",
    "primaryrole": [
      {
        "name": "text",
        "code": "text",
        "description": "text"
      }
    ],
    "additionalroles": [
      {
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ]
      }
    ]
  }
}
{
  "id": "text",
  "mobileNumber": "text",
  "payerName": "text",
  "payerAddress": "text",
  "payerEmail": "text",
  "isActive": true,
  "isCancelled": true,
  "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,
      "collectionModesNotAllowed": [
        "text"
      ],
      "partPaymentAllowed": true,
      "additionalDetails": {},
      "billAccountDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "billDetail": "text",
          "demandDetailId": "text",
          "order": 1,
          "amount": 1,
          "adjustedAmount": 1,
          "isActualDemand": true,
          "glcode": "text",
          "taxHeadCode": "text",
          "additionalDetails": {},
          "purpose": "ARREAR"
        }
      ],
      "status": "CREATED"
    }
  ],
  "tenantId": "text",
  "auditDetails": {
    "createdBy": "text",
    "lastModifiedBy": "text",
    "createdTime": 1,
    "lastModifiedTime": 1
  }
}

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

post

Get the properties list based on the input parameters.

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

isActiveboolean · varcharOptional

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

Fire NOC type for bulling slab.

Possible values:
buildingUsageTypestring · min: 4 · max: 128Optional

buildingUsageType of property.

calculationTypestring · enum · min: 4 · max: 128Optional

Enum for billing slab type.

Possible values:
Body

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.

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: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

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: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringRead-onlyOptional
Responses
200
Successful response
*/*
400
Invalid input.
*/*
post
POST /_search?tenantId=text HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 430

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text",
  "userInfo": {
    "tenantId": "text",
    "uuid": "text",
    "userName": "text",
    "password": "text",
    "idToken": "text",
    "mobile": "text",
    "email": "text",
    "primaryrole": [
      {
        "name": "text",
        "code": "text",
        "description": "text"
      }
    ],
    "additionalroles": [
      {
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text"
          }
        ]
      }
    ]
  }
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}

Create new billing slabs for Fire NOC calculation.

post

API to billing slabs for Fire NOC calculation.

Body
Responses
201
Billing Slab(s) created sucessfully
*/*
400
Billing Slab(s) creation failed
*/*
post
POST /_create HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 754

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}

Update existing billing slabs.

post

Updates a given billing slab with new properties

Body
Responses
200
Update Billing Slab(s) successful
*/*
400
Update Billing Slab(s) failed
*/*
post
POST /_update HTTP/1.1
Host: billingslab
Content-Type: */*
Accept: */*
Content-Length: 754

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BillingSlabs": [
    {
      "tenantId": "text",
      "id": "text",
      "isActive": true,
      "fireNOCType": "NEW",
      "buildingUsageType": "text",
      "calculationType": "SINGLESLAB",
      "rate": 1,
      "uom": "text",
      "fromUom": 1,
      "toUom": 1,
      "fromDate": 1,
      "toDate": 1,
      "auditDetails": {
        "createdBy": "text",
        "createdDate": 1,
        "lastModifiedBy": "text",
        "lastModifiedDate": 1
      }
    }
  ]
}