Fire NOC

Fire NOC APIs

API specs to apply for Fire No Objection Certificates, search and update Fire No Objection Certificates.

Get the list of Fire NOC(s) defined in the system.

1. Search and get Fire NOC(s) based on defined search criteria.

POST/firenoc-services/v1/_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

Fire NOC(s) Retrived Successfully

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.

FireNOCsarray of FireNOC (object)

Used for search result and create only

Request

JavaScriptCurl

const response = await fetch('/firenoc-services/v1/_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"
  },
  "FireNOCs": [
    {
      "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-26",
              "pwdExpiryDate": "2024-04-26",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-04-26",
                  "lastModifiedDate": "2024-04-26",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-04-26",
              "lastModifiedDate": "2024-04-26",
              "otpReference": "text",
              "tenantId": "text",
              "isPrimaryOwner": false,
              "ownerShipPercentage": 0,
              "ownerType": "text",
              "relationship": "FATHER"
            }
          ],
          "additionalDetail": {}
        },
        "additionalDetail": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create new Fire NOC.

To create new Fire NOC in the system. API supports bulk creation with max limit as defined in the Fire NOC Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one Fire NOC, please pass array with one Fire NOC object.

Following Conditions are applied -

1. Support Documents for a given Fire NOC will created. In case of not attaching the Mandatory Supported Documents creation of Fire NOC Fails.
2. Noc Number will be autogenerated on final approval for new License.
3. ApplicationNumber will be autogenerated for new Fire NOC

POST/firenoc-services/v1/_create

Body

*/*

Details for the new Fire NOC(s) + 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.

FireNOCs*array of FireNOC (object)

Used for search result and create only

Response

201400

ReponseInfo with Fire NOC(s) created successfully

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.

FireNOCsarray of FireNOC (object)

Used for search result and create only

Request

JavaScriptCurl

const response = await fetch('/firenoc-services/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "FireNOCs": [
        {
          "fireNOCDetails": {
            "action": "INITIATE",
            "applicantDetails": {},
            "channel": "COUNTER",
            "financialYear": "text",
            "fireNOCType": "text",
            "firestationId": "text",
            "propertyDetails": {}
          },
          "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"
  },
  "FireNOCs": [
    {
      "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-26",
              "pwdExpiryDate": "2024-04-26",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-04-26",
                  "lastModifiedDate": "2024-04-26",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-04-26",
              "lastModifiedDate": "2024-04-26",
              "otpReference": "text",
              "tenantId": "text",
              "isPrimaryOwner": false,
              "ownerShipPercentage": 0,
              "ownerType": "text",
              "relationship": "FATHER"
            }
          ],
          "additionalDetail": {}
        },
        "additionalDetail": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

update existing Fire NOCs.

To update existing Fire NOC in the system. API supports bulk updation with max limit as defined in the Fire NOC Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Fire NOC, please pass array with one Fire NOC object.

Following Conditions are applied -

1. Before payment Employee or Citizen can update any details of Fire NOC
2. After payment Citizen or Employee can't change any details of Fire NOC.

POST/firenoc-services/v1/_update

Body

*/*

Details for the new Fire NOC(s) + 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.

FireNOCs*array of FireNOC (object)

Used for search result and create only

Response

201400

ReponseInfo with Fire NOC(s) updated sudcessfully

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.

FireNOCsarray of FireNOC (object)

Used for search result and create only

Request

JavaScriptCurl

const response = await fetch('/firenoc-services/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "FireNOCs": [
        {
          "fireNOCDetails": {
            "action": "INITIATE",
            "applicantDetails": {},
            "channel": "COUNTER",
            "financialYear": "text",
            "fireNOCType": "text",
            "firestationId": "text",
            "propertyDetails": {}
          },
          "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"
  },
  "FireNOCs": [
    {
      "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-26",
              "pwdExpiryDate": "2024-04-26",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-04-26",
                  "lastModifiedDate": "2024-04-26",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-04-26",
              "lastModifiedDate": "2024-04-26",
              "otpReference": "text",
              "tenantId": "text",
              "isPrimaryOwner": false,
              "ownerShipPercentage": 0,
              "ownerType": "text",
              "relationship": "FATHER"
            }
          ],
          "additionalDetail": {}
        },
        "additionalDetail": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}