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

A object to bind the metadata contract and main application contract

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

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

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

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

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: 926

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

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

search

post

Query parameters

accountIdstring[]Optional

applicationNostringOptional

idsstring[]Optional

limitinteger · int32Optional

mobileNumberstringOptional

nocNostringOptional

nocTypestringOptional

offsetinteger · int32Optional

ownerIdsstring[]Optional

sourcestringOptional

sourceRefIdstringOptional

statusstring[]Optional

tenantIdstringRequired

Body

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

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

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

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