Trade Licence

Trade Licence APIs

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

sendReminderSMS

POST/tl-service/v1/_batch

Path parameters

servicename*string

servicename

jobname*string

jobname

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

bodyobject

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCodeValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_batch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "statusCode": "ACCEPTED"
}

create

POST/tl-service/v1/_create

Path parameters

servicename*string

servicename

Body

application/json

Licensesarray of TradeLicenseReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

plainsearch

POST/tl-service/v1/_plainsearch

Query parameters

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_plainsearch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

search

POST/tl-service/v1/_search

Path parameters

servicename*string

servicename

Query parameters

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

test

POST/tl-service/v1/_test

Body

application/json

Other propertiesobject

Response

200201401403404

OK

Body

*/*

bodyobject

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCodeValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_test', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "statusCode": "ACCEPTED"
}

test1

POST/tl-service/v1/_test1

Body

application/json

Licensesarray of TradeLicenseReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

bodyobject

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCodeValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_test1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "statusCode": "ACCEPTED"
}

update

POST/tl-service/v1/_update

Path parameters

servicename*string

servicename

Body

application/json

Licensesarray of TradeLicenseReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

create

POST/tl-service/v1/{servicename}/_create

Path parameters

servicename*string

servicename

Body

application/json

Licensesarray of TradeLicenseReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/{servicename}/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

search

POST/tl-service/v1/{servicename}/_search

Path parameters

servicename*string

servicename

Query parameters

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/{servicename}/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

update

POST/tl-service/v1/{servicename}/_update

Path parameters

servicename*string

servicename

Body

application/json

Licensesarray of TradeLicenseReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

Countinteger (int32)

Licensesarray of TradeLicenseRes

ResponseInfoResponseInfo

applicationValidityinteger (int32)

applicationsIssuedinteger (int32)

applicationsRenewedinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/{servicename}/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        },
        "applicationNumber": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            "text"
          ],
          "fee": 0,
          "id": "text"
        }
      },
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "accessories": [
          {
            "accessoryCategory": "text",
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "additionalDetail": {
          "array": false,
          "bigDecimal": false,
          "bigInteger": false,
          "binary": false,
          "boolean": false,
          "containerNode": false,
          "double": false,
          "empty": false,
          "float": false,
          "floatingPointNumber": false,
          "int": false,
          "integralNumber": false,
          "long": false,
          "missingNode": false,
          "nodeType": "ARRAY",
          "null": false,
          "number": false,
          "object": false,
          "pojo": false,
          "short": false,
          "textual": false,
          "valueNode": false
        },
        "address": {
          "addressId": "text",
          "addressLine1": "text",
          "addressLine2": "text",
          "addressNumber": "text",
          "buildingName": "text",
          "city": "text",
          "detail": "text",
          "doorNo": "text",
          "id": "text",
          "landmark": "text",
          "latitude": 0,
          "locality": {
            "children": [],
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          },
          "longitude": 0,
          "pincode": "text",
          "street": "text",
          "tenantId": "text",
          "type": "text"
        },
        "adhocExemption": 0,
        "adhocExemptionReason": "text",
        "adhocPenalty": 0,
        "adhocPenaltyReason": "text",
        "applicationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        },
        "channel": "CITIZEN",
        "id": "text",
        "institution": {
          "active": false,
          "address": "text",
          "contactNo": "text",
          "designation": "text",
          "id": "text",
          "instituionName": "text",
          "name": "text",
          "organisationRegistrationNo": "text",
          "tenantId": "text",
          "type": "text"
        },
        "operationalArea": 0,
        "owners": [
          {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "documents": [
              {
                "active": false,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text"
                },
                "documentType": "text",
                "documentUid": "text",
                "fileStoreId": "text",
                "id": "text",
                "tenantId": "text"
              }
            ],
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "identificationMark": "text",
            "institutionId": "text",
            "isPrimaryOwner": false,
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "ownerShipPercentage": 0,
            "ownerType": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userActive": false,
            "userName": "text",
            "uuid": "text"
          }
        ],
        "structureType": "text",
        "subOwnerShipCategory": "text",
        "surveyNo": "text",
        "tradeUnits": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "id": "text",
            "tenantId": "text",
            "tradeType": "text",
            "uom": "text",
            "uomValue": "text"
          }
        ],
        "verificationDocuments": [
          {
            "active": false,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text"
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ]
      },
      "tradeName": "text",
      "wfDocuments": [
        {
          "active": false,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

sendReminderSMS

POST/tl-service/v1/{servicename}/{jobname}/_batch

Path parameters

servicename*string

servicename

jobname*string

jobname

Body

application/json

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

bodyobject

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCodeValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/tl-service/v1/{servicename}/{jobname}/_batch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "statusCode": "ACCEPTED"
}