Fire NOC API

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

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

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

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 Service

Apply for an NOC.

Update existing application.

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

FireNOC Calculator Service