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
Responses
200

OK

*/*
post
/v1/_batch

create

post
Path parameters
servicenamestringRequired

servicename

Body

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

Responses
200

OK

*/*
post
/v1/_create

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
Responses
200

OK

*/*
post
/v1/_plainsearch

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
Responses
200

OK

*/*
post
/v1/_search

test

post
Body
Other propertiesobjectOptional
Responses
200

OK

*/*
post
/v1/_test

test1

post
Body

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

Responses
200

OK

*/*
post
/v1/_test1

update

post
Path parameters
servicenamestringRequired

servicename

Body

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

Responses
200

OK

*/*
post
/v1/_update

create

post
Path parameters
servicenamestringRequired

servicename

Body

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

Responses
200

OK

*/*
post
/v1/{servicename}/_create

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
Responses
200

OK

*/*
post
/v1/{servicename}/_search

update

post
Path parameters
servicenamestringRequired

servicename

Body

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

Responses
200

OK

*/*
post
/v1/{servicename}/_update

sendReminderSMS

post
Path parameters
servicenamestringRequired

servicename

jobnamestringRequired

jobname

Body
Responses
200

OK

*/*
post
/v1/{servicename}/{jobname}/_batch

Last updated

Was this helpful?