Fire NOC API

FireNOC Service

Apply for an NOC.

post

Citizen or Employee, can apply for new build plan approval

Body

A object to bind the metadata contract and main application contract

Responses

202

Application submitted successfully

*/*

400

Failed to process the application

*/*

post

HTTPcURLJavaScriptPython

POST /v1/noc/_create HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Noc": {
    "tenantId": "text",
    "applicationType": "PROVISIONAL",
    "nocType": "text",
    "accountId": "text",
    "source": "text",
    "sourceRefId": "text",
    "landId": "text",
    "status": "ACTIVE",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comment": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "additionalDetails": {}
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Noc": {
    "id": "text",
    "tenantId": "text",
    "applicationNo": "text",
    "nocNo": "text",
    "applicationType": "PROVISIONAL",
    "nocType": "text",
    "accountId": "text",
    "source": "text",
    "sourceRefId": "text",
    "landId": "text",
    "status": "ACTIVE",
    "applicationStatus": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comment": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {}
  }
}

Update existing application.

post

Updates a given application with newer details.

Body

A object to bind the metadata contract and main application contract

Responses

202

Application updated successfully

*/*

400

Failed to update

*/*

post

HTTPcURLJavaScriptPython

POST /v1/noc/_update HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Noc": {
    "tenantId": "text",
    "applicationType": "PROVISIONAL",
    "nocType": "text",
    "accountId": "text",
    "source": "text",
    "sourceRefId": "text",
    "landId": "text",
    "status": "ACTIVE",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comment": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "additionalDetails": {}
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Noc": {
    "id": "text",
    "tenantId": "text",
    "applicationNo": "text",
    "nocNo": "text",
    "applicationType": "PROVISIONAL",
    "nocType": "text",
    "accountId": "text",
    "source": "text",
    "sourceRefId": "text",
    "landId": "text",
    "status": "ACTIVE",
    "applicationStatus": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comment": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {}
  }
}

Get the list of application by passing the diffrent search criteria.

post

Get the properties list based on the input parameters.

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[]Optional

List of system generated ids of Noc applications.

applicationNostringOptional

application numbers

nocNostringOptional

approval no

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

HTTPcURLJavaScriptPython

POST /v1/noc/_search HTTP/1.1
Host: egov-micro-dev.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text"
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Noc": {
    "id": "text",
    "tenantId": "text",
    "applicationNo": "text",
    "nocNo": "text",
    "applicationType": "PROVISIONAL",
    "nocType": "text",
    "accountId": "text",
    "source": "text",
    "sourceRefId": "text",
    "landId": "text",
    "status": "ACTIVE",
    "applicationStatus": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "workflow": {
      "action": "text",
      "assignes": [
        "text"
      ],
      "comment": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalDetails": {}
  }
}

FireNOC Calculator Service

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.

application/json

400

Error response in case of failures.

application/json

post

HTTPcURLJavaScriptPython

POST /_calculate HTTP/1.1
Host: v1
Content-Type: application/json
Accept: */*
Content-Length: 1986

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "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"
                }
              ]
            }
          ],
          "propertyDetails": {
            "propertyId": "text",
            "address": "[Circular Reference]"
          },
          "applicantDetails": {
            "ownerShipType": "text",
            "owners": [
              {
                "id": 1,
                "userName": "text",
                "password": "password",
                "salutation": "text",
                "name": "text",
                "gender": [
                  "MALE"
                ],
                "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-05-19",
                "locale": "text",
                "type": [
                  "EMPLOYEE"
                ],
                "signature": "text",
                "accountLocked": true,
                "roles": [
                  {
                    "id": 1,
                    "name": "text",
                    "code": "text",
                    "description": "text",
                    "createdBy": 1,
                    "createdDate": "2025-05-19",
                    "lastModifiedBy": 1,
                    "lastModifiedDate": "2025-05-19",
                    "tenantId": "text"
                  }
                ],
                "fatherOrHusbandName": "text",
                "bloodGroup": [
                  "A+"
                ],
                "identificationMark": "text",
                "photo": "text",
                "createdBy": 1,
                "createdDate": "2025-05-19",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-05-19",
                "otpReference": "text",
                "tenantId": "text",
                "isPrimaryOwner": true,
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "relationship": "FATHER",
                "documents": [
                  {
                    "tenantId": "text",
                    "documentType": "text",
                    "fileStoreId": "text",
                    "documentUid": "text"
                  }
                ]
              }
            ],
            "additionalDetail": {}
          },
          "additionalDetail": {}
        }
      },
      "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": [
                  "MALE"
                ],
                "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-05-19",
                "pwdExpiryDate": "2025-05-19",
                "locale": "text",
                "type": [
                  "EMPLOYEE"
                ],
                "signature": "text",
                "accountLocked": true,
                "roles": [
                  {
                    "id": 1,
                    "name": "text",
                    "code": "text",
                    "description": "text",
                    "createdBy": 1,
                    "createdDate": "2025-05-19",
                    "lastModifiedBy": 1,
                    "lastModifiedDate": "2025-05-19",
                    "tenantId": "text"
                  }
                ],
                "fatherOrHusbandName": "text",
                "bloodGroup": [
                  "A+"
                ],
                "identificationMark": "text",
                "photo": "text",
                "createdBy": 1,
                "createdDate": "2025-05-19",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-05-19",
                "otpReference": "text",
                "tenantId": "text",
                "isPrimaryOwner": true,
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "relationship": "FATHER",
                "documents": [
                  {
                    "tenantId": "text",
                    "documentType": "text",
                    "fileStoreId": "text",
                    "documentUid": "text",
                    "auditDetails": {
                      "createdBy": "text",
                      "lastModifiedBy": "text",
                      "createdTime": 1,
                      "lastModifiedTime": 1
                    }
                  }
                ]
              }
            ],
            "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.

body

requestInfoanyOptional

Parameter to carry Request metadata in the request body

Query parameters

tenantIdanyRequired

Unique id for a tenant.

consumerCodestringRequired

Unique Fire NOC application number.

Responses

200

Success response calculated tax amount.

application/json

400

Error response in case of failures.

application/json

post

HTTPcURLJavaScriptPython

POST /_getbill?tenantId=null&consumerCode=text HTTP/1.1
Host: v1
Accept: */*

{
  "id": "text",
  "mobileNumber": "text",
  "payerName": "text",
  "payerAddress": "text",
  "payerEmail": "text",
  "isActive": true,
  "isCancelled": true,
  "additionalDetails": {},
  "taxAndPayments": [],
  "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.

body

requestInfoanyOptional

Parameter to carry Request metadata in the request body

Query parameters

tenantIdanyRequired

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:

Responses

200

Successful response

application/json

400

Invalid input.

application/json

post

HTTPcURLJavaScriptPython

POST /_search?tenantId=null HTTP/1.1
Host: billingslab
Accept: */*

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

application/json

400

Billing Slab(s) creation failed

application/json

post

HTTPcURLJavaScriptPython

POST /_create HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "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

application/json

400

Update Billing Slab(s) failed

application/json

post

HTTPcURLJavaScriptPython

POST /_update HTTP/1.1
Host: billingslab
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "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
      }
    }
  ]
}