Trade License API

TL Service Contract

Create new Trade Licenses.

To create new Trade License in the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one Trade License, please pass array with one Trade License object.

Following Conditions are applied -

1. PropertyId and OldPropertyId is not mandatory, If entered then validate. Invalid number fails trade license creation
2. supportDocuments for a given Trade License will created. In case of not attaching the Mandatory Supported Documents creation of New Trade License Fails.
3. LicenseNumber will be autogenerated on final approval for new License.
4. ApplicationNumber will be autogenerated for new Trade License

POST/tl-service/v1/_create

Body

application/json

Details for the new TradeLicense(s) + RequestInfo meta data.

Licensesarray of TradeLicense (object)

Used for search result and create only

Response

201400

ReponseInfo with Trade License(s) created successfully

Body

*/*

Licensesarray of any

Used for search result and create only

Request

JavaScriptCurlPythonHTTP

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

Response

201

{
  "Licenses": []
}

update existing licenses.

To update existing Trade License in the system. API supports bulk updation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Trade License, please pass array with one Trade License object.

Following Conditions are applied -

1. Before payment Employee or Citizen can update any details of trade license
2. After payment Citizen or Employee can't change any details of TL.

POST/tl-service/v1/_update

Body

application/json

Details for the new TradeLicense(s) + RequestInfo meta data.

Licensesarray of TradeLicense (object)

Used for search result and create only

Response

201400

ReponseInfo with Trade License(s) updated sudcessfully

Body

*/*

Licensesarray of any

Used for search result and create only

Request

JavaScriptCurlPythonHTTP

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

Response

201

{
  "Licenses": []
}

TL Calculator Service Contract

update existing licenses.

To update existing Trade License in the system. API supports bulk updation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Trade License, please pass array with one Trade License object.

Following Conditions are applied -

1. Before payment Employee or Citizen can update any details of trade license
2. After payment Citizen or Employee can't change any details of TL.

POST/tl-service/v1/_update

Body

application/json

Details for the new TradeLicense(s) + RequestInfo meta data.

any

Response

201400

ReponseInfo with Trade License(s) updated sudcessfully

Body

*/*

Licensesarray of TradeLicense (object)

Used for search result and create only

Request

JavaScriptCurlPythonHTTP

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

Response

201

{
  "Licenses": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "licenseType": "TEMPORARY",
      "licenseNumber": "text",
      "oldLicenseNumber": "text",
      "propertyId": "text",
      "oldPropertyId": "text",
      "applicationDate": 0,
      "commencementDate": 0,
      "issuedDate": 0,
      "financialYear": "text",
      "validFrom": 0,
      "validTo": 0,
      "action": "INITIATE",
      "status": "INITIATED"
    }
  ]
}