Trade Licence

Trade Licence APIs

API specs for creating new trade licence applications, searching and paying for trade licences.

sendReminderSMS

post

Path parameters

servicenamestringRequired

servicename

jobnamestringRequired

jobname

Body

application/json

Responses

200

OK

*/*

bodyobjectOptional

statusCodestring · enumOptionalPossible values:

statusCodeValueinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_batch

HTTPcURLJavaScriptPython

POST /tl-service/v1/_batch HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "body": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 1
}

create

post

Path parameters

servicenamestringRequired

servicename

Body

application/json

Contract class to receive request. Array of tradelicense items are used in case of create, whereas single tradelicense item is used for update

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_create

HTTPcURLJavaScriptPython

POST /tl-service/v1/_create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8715

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {},
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 1,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

plainsearch

post

Query parameters

accountIdstringOptional

applicationNumberstringOptional

applicationTypestringOptional

businessServicestringOptional

financialYearstringOptional

fromDateinteger · int64Optional

idsstring[]Optional

issuedFrominteger · int64Optional

issuedTointeger · int64Optional

licenseNumbersstring[]Optional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldLicenseNumberstringOptional

onlyMobileNumberbooleanOptional

ownerIdsstring[]Optional

ownerNamestringOptional

renewalPendingbooleanOptional

statusstring[]Optional

tenantIdstringOptional

toDateinteger · int64Optional

tradeNamestringOptional

tradeTypestringOptional

validTointeger · int64Optional

Body

application/json

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_plainsearch

HTTPcURLJavaScriptPython

POST /tl-service/v1/_plainsearch HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

search

post

Path parameters

servicenamestringRequired

servicename

Query parameters

accountIdstringOptional

applicationNumberstringOptional

applicationTypestringOptional

businessServicestringOptional

financialYearstringOptional

fromDateinteger · int64Optional

idsstring[]Optional

issuedFrominteger · int64Optional

issuedTointeger · int64Optional

licenseNumbersstring[]Optional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldLicenseNumberstringOptional

onlyMobileNumberbooleanOptional

ownerIdsstring[]Optional

ownerNamestringOptional

renewalPendingbooleanOptional

statusstring[]Optional

tenantIdstringOptional

toDateinteger · int64Optional

tradeNamestringOptional

tradeTypestringOptional

validTointeger · int64Optional

Body

application/json

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_search

HTTPcURLJavaScriptPython

POST /tl-service/v1/_search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

test

post

Body

application/json

Other propertiesobjectOptional

Responses

200

OK

*/*

bodyobjectOptional

statusCodestring · enumOptionalPossible values:

statusCodeValueinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_test

HTTPcURLJavaScriptPython

POST /tl-service/v1/_test HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "ANY_ADDITIONAL_PROPERTY": {}
}

{
  "body": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 1
}

test1

post

Body

application/json

Contract class to receive request. Array of tradelicense items are used in case of create, whereas single tradelicense item is used for update

Responses

200

OK

*/*

bodyobjectOptional

statusCodestring · enumOptionalPossible values:

statusCodeValueinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_test1

HTTPcURLJavaScriptPython

POST /tl-service/v1/_test1 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8715

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {},
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 1,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "body": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 1
}

update

post

Path parameters

servicenamestringRequired

servicename

Body

application/json

Contract class to receive request. Array of tradelicense items are used in case of create, whereas single tradelicense item is used for update

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/_update

HTTPcURLJavaScriptPython

POST /tl-service/v1/_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8715

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {},
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 1,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

create

post

Path parameters

servicenamestringRequired

servicename

Body

application/json

Contract class to receive request. Array of tradelicense items are used in case of create, whereas single tradelicense item is used for update

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/{servicename}/_create

HTTPcURLJavaScriptPython

POST /tl-service/v1/{servicename}/_create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8715

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {},
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 1,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

search

post

Path parameters

servicenamestringRequired

servicename

Query parameters

accountIdstringOptional

applicationNumberstringOptional

applicationTypestringOptional

businessServicestringOptional

financialYearstringOptional

fromDateinteger · int64Optional

idsstring[]Optional

issuedFrominteger · int64Optional

issuedTointeger · int64Optional

licenseNumbersstring[]Optional

limitinteger · int32Optional

localitystringOptional

mobileNumberstringOptional

offsetinteger · int32Optional

oldLicenseNumberstringOptional

onlyMobileNumberbooleanOptional

ownerIdsstring[]Optional

ownerNamestringOptional

renewalPendingbooleanOptional

statusstring[]Optional

tenantIdstringOptional

toDateinteger · int64Optional

tradeNamestringOptional

tradeTypestringOptional

validTointeger · int64Optional

Body

application/json

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/{servicename}/_search

HTTPcURLJavaScriptPython

POST /tl-service/v1/{servicename}/_search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

update

post

Path parameters

servicenamestringRequired

servicename

Body

application/json

Contract class to receive request. Array of tradelicense items are used in case of create, whereas single tradelicense item is used for update

Responses

200

OK

*/*

Contract class to send response. Array of tradelicense items are used in case of search results or response for create, whereas single tradelicense item is used for update

Countinteger · int32Optional

applicationValidityinteger · int32Optional

applicationsIssuedinteger · int32Optional

applicationsRenewedinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/{servicename}/_update

HTTPcURLJavaScriptPython

POST /tl-service/v1/{servicename}/_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8715

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {},
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 1,
          "locality": {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 1,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 1,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeLicense": {
          "accountId": "text",
          "action": "text",
          "applicationDate": 1,
          "applicationNumber": "text",
          "applicationType": "NEW",
          "assignee": [
            "text"
          ],
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "businessService": "text",
          "calculation": {
            "accessoryBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            },
            "applicationNumber": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION",
                "estimateAmount": 1,
                "taxHeadCode": "text"
              }
            ],
            "tenantId": "text",
            "tradeLicense": "[Circular Reference]",
            "tradeTypeBillingIds": {
              "billingSlabIds": [
                "text"
              ],
              "fee": 1,
              "id": "text"
            }
          },
          "commencementDate": 1,
          "comment": "text",
          "fileStoreId": "text",
          "financialYear": "text",
          "id": "text",
          "issuedDate": 1,
          "licenseNumber": "text",
          "licenseType": "PERMANENT",
          "oldLicenseNumber": "text",
          "oldPropertyId": "text",
          "propertyId": "text",
          "status": "text",
          "tenantId": "text",
          "tradeLicenseDetail": {
            "accessories": [
              {
                "accessoryCategory": "text",
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "count": 1,
                "id": "text",
                "tenantId": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "additionalDetail": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "empty": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "address": "[Circular Reference]",
            "adhocExemption": 1,
            "adhocExemptionReason": "text",
            "adhocPenalty": 1,
            "adhocPenaltyReason": "text",
            "applicationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "channel": "CITIZEN",
            "id": "text",
            "institution": {
              "active": true,
              "address": "text",
              "contactNo": "text",
              "designation": "text",
              "id": "text",
              "instituionName": "text",
              "name": "text",
              "organisationRegistrationNo": "text",
              "tenantId": "text",
              "type": "text"
            },
            "noOfEmployees": 1,
            "operationalArea": 1,
            "owners": [
              {
                "aadhaarNumber": "text",
                "accountLocked": true,
                "active": true,
                "altContactNumber": "text",
                "bloodGroup": "text",
                "correspondenceAddress": "text",
                "correspondenceCity": "text",
                "correspondencePinCode": "text",
                "createdBy": "text",
                "createdDate": 1,
                "dob": 1,
                "documents": [
                  {
                    "active": true,
                    "auditDetails": {
                      "createdBy": "text",
                      "createdTime": 1,
                      "lastModifiedBy": "text",
                      "lastModifiedTime": 1
                    },
                    "documentType": "text",
                    "documentUid": "text",
                    "fileStoreId": "text",
                    "id": "text",
                    "tenantId": "text"
                  }
                ],
                "emailId": "text",
                "fatherOrHusbandName": "text",
                "gender": "text",
                "id": 1,
                "identificationMark": "text",
                "institutionId": "text",
                "isPrimaryOwner": true,
                "lastModifiedBy": "text",
                "lastModifiedDate": 1,
                "locale": "text",
                "mobileNumber": "text",
                "name": "text",
                "otpReference": "text",
                "ownerShipPercentage": 1,
                "ownerType": "text",
                "pan": "text",
                "password": "text",
                "permanentAddress": "text",
                "permanentCity": "text",
                "permanentPinCode": "text",
                "photo": "text",
                "pwdExpiryDate": 1,
                "relationship": "FATHER",
                "roles": [
                  {
                    "code": "text",
                    "id": 1,
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "salutation": "text",
                "signature": "text",
                "tenantId": "text",
                "type": "text",
                "userActive": true,
                "userName": "text",
                "uuid": "text"
              }
            ],
            "structureType": "text",
            "subOwnerShipCategory": "text",
            "surveyNo": "text",
            "tradeUnits": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "id": "text",
                "tenantId": "text",
                "tradeType": "text",
                "uom": "text",
                "uomValue": "text"
              }
            ],
            "verificationDocuments": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ]
          },
          "tradeName": "text",
          "validFrom": 1,
          "validTo": 1,
          "wfDocuments": [
            {
              "active": true,
              "auditDetails": {
                "createdBy": "text",
                "createdTime": 1,
                "lastModifiedBy": "text",
                "lastModifiedTime": 1
              },
              "documentType": "text",
              "documentUid": "text",
              "fileStoreId": "text",
              "id": "text",
              "tenantId": "text"
            }
          ],
          "workflowCode": "text"
        },
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 1,
          "id": "text"
        }
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "count": 1,
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "empty": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "address": "[Circular Reference]",
        "adhocExemption": 1,
        "adhocExemptionReason": "text",
        "adhocPenalty": 1,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": true,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "noOfEmployees": 1,
        "operationalArea": 1,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "documents": [
              {
                "active": true,
                "auditDetails": {
                  "createdBy": "text",
                  "createdTime": 1,
                  "lastModifiedBy": "text",
                  "lastModifiedTime": 1
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": true,
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 1,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": true,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

sendReminderSMS

post

Path parameters

servicenamestringRequired

servicename

jobnamestringRequired

jobname

Body

application/json

Responses

200

OK

*/*

bodyobjectOptional

statusCodestring · enumOptionalPossible values:

statusCodeValueinteger · int32Optional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/v1/{servicename}/{jobname}/_batch

HTTPcURLJavaScriptPython

POST /tl-service/v1/{servicename}/{jobname}/_batch HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "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"
  }
}

{
  "body": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 1
}