Trade Licence

Trade Licence APIs

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

sendReminderSMS

post

/v1/_batch

Path parameters

servicenamestringrequired

servicename

jobnamestringrequired

jobname

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_batch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

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

OK

create

post

/v1/_create

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoRequestInfo

LicensesTradeLicenseReq[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"Licenses":[{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":"[Circular Reference]","tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{"nodeType":"ARRAY"},"address":"[Circular Reference]","auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]},"tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{},"address":{"locality":{"children":"[Circular Reference]"}},"auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]}]}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

plainsearch

post

/v1/_plainsearch

Query parameters

accountIdstring

applicationNumberstring

applicationTypestring

businessServicestring

financialYearstring

fromDateinteger · int64

idsstring[]

issuedFrominteger · int64

issuedTointeger · int64

licenseNumbersstring[]

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldLicenseNumberstring

onlyMobileNumberboolean

ownerIdsstring[]

ownerNamestring

renewalPendingboolean

statusstring[]

tenantIdstring

toDateinteger · int64

tradeNamestring

tradeTypestring

validTointeger · int64

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

search

post

/v1/_search

Path parameters

servicenamestringrequired

servicename

Query parameters

accountIdstring

applicationNumberstring

applicationTypestring

businessServicestring

financialYearstring

fromDateinteger · int64

idsstring[]

issuedFrominteger · int64

issuedTointeger · int64

licenseNumbersstring[]

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldLicenseNumberstring

onlyMobileNumberboolean

ownerIdsstring[]

ownerNamestring

renewalPendingboolean

statusstring[]

tenantIdstring

toDateinteger · int64

tradeNamestring

tradeTypestring

validTointeger · int64

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

test

post

/v1/_test

Body

Other propertiesobject

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_test' \
  --header 'Content-Type: application/json' \
  --data '{"ANY_ADDITIONAL_PROPERTY":{}}'

200

201

401

403

404

200

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

OK

test1

post

/v1/_test1

Body

RequestInfoRequestInfo

LicensesTradeLicenseReq[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_test1' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"Licenses":[{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":"[Circular Reference]","tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{"nodeType":"ARRAY"},"address":"[Circular Reference]","auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]},"tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{},"address":{"locality":{"children":"[Circular Reference]"}},"auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]}]}'

200

201

401

403

404

200

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

OK

update

post

/v1/_update

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoRequestInfo

LicensesTradeLicenseReq[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"Licenses":[{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":"[Circular Reference]","tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{"nodeType":"ARRAY"},"address":"[Circular Reference]","auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]},"tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{},"address":{"locality":{"children":"[Circular Reference]"}},"auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]}]}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

create

post

/v1/{servicename}/_create

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoRequestInfo

LicensesTradeLicenseReq[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"Licenses":[{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":"[Circular Reference]","tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{"nodeType":"ARRAY"},"address":"[Circular Reference]","auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]},"tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{},"address":{"locality":{"children":"[Circular Reference]"}},"auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]}]}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

search

post

/v1/{servicename}/_search

Path parameters

servicenamestringrequired

servicename

Query parameters

accountIdstring

applicationNumberstring

applicationTypestring

businessServicestring

financialYearstring

fromDateinteger · int64

idsstring[]

issuedFrominteger · int64

issuedTointeger · int64

licenseNumbersstring[]

limitinteger · int32

localitystring

mobileNumberstring

offsetinteger · int32

oldLicenseNumberstring

onlyMobileNumberboolean

ownerIdsstring[]

ownerNamestring

renewalPendingboolean

statusstring[]

tenantIdstring

toDateinteger · int64

tradeNamestring

tradeTypestring

validTointeger · int64

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

update

post

/v1/{servicename}/_update

Path parameters

servicenamestringrequired

servicename

Body

RequestInfoRequestInfo

LicensesTradeLicenseReq[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"Licenses":[{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":{"action":"text","auditDetails":{},"calculation":{"accessoryBillingIds":{"billingSlabIds":[null]},"tenantId":"text","tradeLicense":"[Circular Reference]","tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{"nodeType":"ARRAY"},"address":"[Circular Reference]","auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]},"tradeTypeBillingIds":{"billingSlabIds":[null]},"taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"tenantId":"text","tradeLicenseDetail":{"additionalDetail":{},"address":{"locality":{"children":"[Circular Reference]"}},"auditDetails":{},"institution":{},"channel":"CITIZEN","accessories":[{"auditDetails":{}}],"applicationDocuments":[{"auditDetails":{}}],"owners":[{"mobileNumber":"text","name":"text","relationship":"FATHER","documents":[{"auditDetails":{}}],"roles":[{}]}],"tradeUnits":[{"auditDetails":{}}],"verificationDocuments":[{"auditDetails":{}}]},"applicationType":"NEW","licenseType":"PERMANENT","assignee":[null],"wfDocuments":[{"auditDetails":{}}]}]}'

200

201

401

403

404

200

{
  "Count": 1,
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "auditDetails": {},
      "businessService": "text",
      "calculation": {
        "accessoryBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "tenantId": "text",
        "tradeLicense": "[Circular Reference]",
        "tradeTypeBillingIds": {
          "billingSlabIds": [
            null
          ]
        },
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": {
        "additionalDetail": {
          "nodeType": "ARRAY"
        },
        "address": "[Circular Reference]",
        "auditDetails": {},
        "institution": {},
        "channel": "CITIZEN",
        "accessories": [
          {
            "auditDetails": {}
          }
        ],
        "applicationDocuments": [
          {
            "auditDetails": {}
          }
        ],
        "owners": [
          {
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "documents": [
              {
                "auditDetails": {}
              }
            ],
            "roles": [
              {}
            ]
          }
        ],
        "tradeUnits": [
          {
            "auditDetails": {}
          }
        ],
        "verificationDocuments": [
          {
            "auditDetails": {}
          }
        ]
      },
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "workflowCode": "text",
      "applicationType": "NEW",
      "licenseType": "PERMANENT",
      "assignee": [
        "text"
      ],
      "wfDocuments": [
        {
          "auditDetails": {}
        }
      ]
    }
  ]
}

OK

sendReminderSMS

post

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

Path parameters

servicenamestringrequired

servicename

jobnamestringrequired

jobname

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/{jobname}/_batch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

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

OK