Trade Licence

Trade Licence APIs

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

sendReminderSMS

post

Path parameters

servicenamestringrequired

servicename

jobnamestringrequired

jobname

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_batch' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

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

OK

create

post

Path parameters

servicenamestringrequired

servicename

Body

Licensesobject[]optional

A Object holds the basic data for a Trade License

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "Licenses": [
      {
        "accountId": "text",
        "action": "text",
        "applicationDate": 1,
        "applicationNumber": "text",
        "applicationType": "NEW",
        "assignee": [
          "text"
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "calculation": "[Circular Reference]",
        "commencementDate": 1,
        "comment": "text",
        "fileStoreId": "text",
        "financialYear": "text",
        "id": "text",
        "issuedDate": 1,
        "licenseNumber": "text",
        "licenseType": "PERMANENT",
        "oldLicenseNumber": "text",
        "oldPropertyId": "text",
        "propertyId": "text",
        "status": "text",
        "tenantId": "text",
        "tradeLicenseDetail": "[Circular Reference]",
        "tradeName": "text",
        "validFrom": 1,
        "validTo": 1,
        "wfDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "workflowCode": "text"
      }
    ],
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

plainsearch

post

Query parameters

accountIdstringoptional

applicationNumberstringoptional

applicationTypestringoptional

businessServicestringoptional

financialYearstringoptional

fromDateinteger · int64optional

idsstring[]optional

issuedFrominteger · int64optional

issuedTointeger · int64optional

licenseNumbersstring[]optional

limitinteger · int32optional

localitystringoptional

mobileNumberstringoptional

offsetinteger · int32optional

oldLicenseNumberstringoptional

onlyMobileNumberbooleanoptional

ownerIdsstring[]optional

ownerNamestringoptional

renewalPendingbooleanoptional

statusstring[]optional

tenantIdstringoptional

toDateinteger · int64optional

tradeNamestringoptional

tradeTypestringoptional

validTointeger · int64optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

search

post

Path parameters

servicenamestringrequired

servicename

Query parameters

accountIdstringoptional

applicationNumberstringoptional

applicationTypestringoptional

businessServicestringoptional

financialYearstringoptional

fromDateinteger · int64optional

idsstring[]optional

issuedFrominteger · int64optional

issuedTointeger · int64optional

licenseNumbersstring[]optional

limitinteger · int32optional

localitystringoptional

mobileNumberstringoptional

offsetinteger · int32optional

oldLicenseNumberstringoptional

onlyMobileNumberbooleanoptional

ownerIdsstring[]optional

ownerNamestringoptional

renewalPendingbooleanoptional

statusstring[]optional

tenantIdstringoptional

toDateinteger · int64optional

tradeNamestringoptional

tradeTypestringoptional

validTointeger · int64optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

test

post

Body

Other propertiesobjectoptional

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": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 1
}

OK

test1

post

Body

Licensesobject[]optional

A Object holds the basic data for a Trade License

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_test1' \
  --header 'Content-Type: application/json' \
  --data '{
    "Licenses": [
      {
        "accountId": "text",
        "action": "text",
        "applicationDate": 1,
        "applicationNumber": "text",
        "applicationType": "NEW",
        "assignee": [
          "text"
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "calculation": "[Circular Reference]",
        "commencementDate": 1,
        "comment": "text",
        "fileStoreId": "text",
        "financialYear": "text",
        "id": "text",
        "issuedDate": 1,
        "licenseNumber": "text",
        "licenseType": "PERMANENT",
        "oldLicenseNumber": "text",
        "oldPropertyId": "text",
        "propertyId": "text",
        "status": "text",
        "tenantId": "text",
        "tradeLicenseDetail": "[Circular Reference]",
        "tradeName": "text",
        "validFrom": 1,
        "validTo": 1,
        "wfDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "workflowCode": "text"
      }
    ],
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

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

OK

update

post

Path parameters

servicenamestringrequired

servicename

Body

Licensesobject[]optional

A Object holds the basic data for a Trade License

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "Licenses": [
      {
        "accountId": "text",
        "action": "text",
        "applicationDate": 1,
        "applicationNumber": "text",
        "applicationType": "NEW",
        "assignee": [
          "text"
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "calculation": "[Circular Reference]",
        "commencementDate": 1,
        "comment": "text",
        "fileStoreId": "text",
        "financialYear": "text",
        "id": "text",
        "issuedDate": 1,
        "licenseNumber": "text",
        "licenseType": "PERMANENT",
        "oldLicenseNumber": "text",
        "oldPropertyId": "text",
        "propertyId": "text",
        "status": "text",
        "tenantId": "text",
        "tradeLicenseDetail": "[Circular Reference]",
        "tradeName": "text",
        "validFrom": 1,
        "validTo": 1,
        "wfDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "workflowCode": "text"
      }
    ],
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

create

post

Path parameters

servicenamestringrequired

servicename

Body

Licensesobject[]optional

A Object holds the basic data for a Trade License

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "Licenses": [
      {
        "accountId": "text",
        "action": "text",
        "applicationDate": 1,
        "applicationNumber": "text",
        "applicationType": "NEW",
        "assignee": [
          "text"
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "calculation": "[Circular Reference]",
        "commencementDate": 1,
        "comment": "text",
        "fileStoreId": "text",
        "financialYear": "text",
        "id": "text",
        "issuedDate": 1,
        "licenseNumber": "text",
        "licenseType": "PERMANENT",
        "oldLicenseNumber": "text",
        "oldPropertyId": "text",
        "propertyId": "text",
        "status": "text",
        "tenantId": "text",
        "tradeLicenseDetail": "[Circular Reference]",
        "tradeName": "text",
        "validFrom": 1,
        "validTo": 1,
        "wfDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "workflowCode": "text"
      }
    ],
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

search

post

Path parameters

servicenamestringrequired

servicename

Query parameters

accountIdstringoptional

applicationNumberstringoptional

applicationTypestringoptional

businessServicestringoptional

financialYearstringoptional

fromDateinteger · int64optional

idsstring[]optional

issuedFrominteger · int64optional

issuedTointeger · int64optional

licenseNumbersstring[]optional

limitinteger · int32optional

localitystringoptional

mobileNumberstringoptional

offsetinteger · int32optional

oldLicenseNumberstringoptional

onlyMobileNumberbooleanoptional

ownerIdsstring[]optional

ownerNamestringoptional

renewalPendingbooleanoptional

statusstring[]optional

tenantIdstringoptional

toDateinteger · int64optional

tradeNamestringoptional

tradeTypestringoptional

validTointeger · int64optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

update

post

Path parameters

servicenamestringrequired

servicename

Body

Licensesobject[]optional

A Object holds the basic data for a Trade License

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "Licenses": [
      {
        "accountId": "text",
        "action": "text",
        "applicationDate": 1,
        "applicationNumber": "text",
        "applicationType": "NEW",
        "assignee": [
          "text"
        ],
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "businessService": "text",
        "calculation": "[Circular Reference]",
        "commencementDate": 1,
        "comment": "text",
        "fileStoreId": "text",
        "financialYear": "text",
        "id": "text",
        "issuedDate": 1,
        "licenseNumber": "text",
        "licenseType": "PERMANENT",
        "oldLicenseNumber": "text",
        "oldPropertyId": "text",
        "propertyId": "text",
        "status": "text",
        "tenantId": "text",
        "tradeLicenseDetail": "[Circular Reference]",
        "tradeName": "text",
        "validFrom": 1,
        "validTo": 1,
        "wfDocuments": [
          {
            "active": true,
            "auditDetails": {
              "createdBy": "text",
              "createdTime": 1,
              "lastModifiedBy": "text",
              "lastModifiedTime": 1
            },
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text",
            "tenantId": "text"
          }
        ],
        "workflowCode": "text"
      }
    ],
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

{
  "Count": 1,
  "Licenses": [
    {
      "accountId": "text",
      "action": "text",
      "applicationDate": 1,
      "applicationNumber": "text",
      "applicationType": "NEW",
      "assignee": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": "[Circular Reference]",
      "commencementDate": 1,
      "comment": "text",
      "fileStoreId": "text",
      "financialYear": "text",
      "id": "text",
      "issuedDate": 1,
      "licenseNumber": "text",
      "licenseType": "PERMANENT",
      "oldLicenseNumber": "text",
      "oldPropertyId": "text",
      "propertyId": "text",
      "status": "text",
      "tenantId": "text",
      "tradeLicenseDetail": "[Circular Reference]",
      "tradeName": "text",
      "validFrom": 1,
      "validTo": 1,
      "wfDocuments": [
        {
          "active": true,
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text",
          "tenantId": "text"
        }
      ],
      "workflowCode": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationValidity": 1,
  "applicationsIssued": 1,
  "applicationsRenewed": 1
}

OK

sendReminderSMS

post

Path parameters

servicenamestringrequired

servicename

jobnamestringrequired

jobname

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tl-service/v1/{servicename}/{jobname}/_batch' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "plainAccessRequest": {
        "plainRequestFields": [
          "text"
        ],
        "recordId": "text"
      },
      "ts": 1,
      "userInfo": {
        "emailId": "text",
        "id": 1,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }
  }'

200

201

401

403

404

200

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

OK