No Objection Certificate

No Objection Certificate Application Registry APIs

API specs to apply for NOC, search or update NOC details, and allow users to take necessary actions on the NOC application.

create

post

Body

Nocobjectoptional

NOC application object to capture the details of noc related information, landid and related documents.

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/v1/noc/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "Noc": {
      "accountId": "text",
      "additionalDetails": {},
      "applicationType": "NEW",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "additionalDetails": {},
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text"
        }
      ],
      "landId": "text",
      "nocType": "text",
      "source": "text",
      "sourceRefId": "text",
      "status": "ACTIVE",
      "tenantId": "text",
      "workflow": {
        "action": "text",
        "assignes": [
          "text"
        ],
        "comment": "text",
        "documents": [
          {
            "additionalDetails": {},
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ]
      }
    },
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

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

OK

Update existing application.

post

Updates a given application with newer details.

Body

Nocobjectoptional

NOC application object to capture the details of noc related information, landid and related documents.

RequestInfoobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/v1/noc/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "Noc": {
      "accountId": "text",
      "additionalDetails": {},
      "applicationType": "NEW",
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "additionalDetails": {},
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text"
        }
      ],
      "landId": "text",
      "nocType": "text",
      "source": "text",
      "sourceRefId": "text",
      "status": "ACTIVE",
      "tenantId": "text",
      "workflow": {
        "action": "text",
        "assignes": [
          "text"
        ],
        "comment": "text",
        "documents": [
          {
            "additionalDetails": {},
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ]
      }
    },
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

202

400

202

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

Application updated successfully

search

post

Query parameters

accountIdstring[]optional

applicationNostringoptional

idsstring[]optional

limitinteger · int32optional

mobileNumberstringoptional

nocNostringoptional

nocTypestringoptional

offsetinteger · int32optional

ownerIdsstring[]optional

sourcestringoptional

sourceRefIdstringoptional

statusstring[]optional

tenantIdstringrequired

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://egov-micro-dev.egovernments.org/v1/noc/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

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

OK