get detailed license data for given dealer and Product
ApiScope: manage.license.read
API Scope Level: ServiceSubscriberScope
Path Parameters
ServiceSubscriberDealer string required
productUuid string required
Query Parameters
page int32 required
page number
maxResults int32 required
max result size
application/json
Request Body required
searchText string
roleUuids string[]
licenseStatus string[]
Possible values: [ASSIGNED
, UNASSIGNED
]
sortField string
Possible values: [NAME
, ROLE
, DEALERSHIP
, LICENSE_STATUS
]
sortType string
Possible values: [ASC
, DESC
]
Responses
- 200
- 400
- 401
- 403
- 500
OK
application/json
application/x-protobuf
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
licenseDetailsForUserList object[]
totalLicenseCount int32
licenseCount int32
totalElementsCount int32
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"licenseDetailsForUserList": [
{
"fname": "string",
"lname": "string",
"dealerCount": 0,
"dealerUuids": [
"string"
],
"roleUuidToNameMap": {},
"defaultRoleUuid": "string",
"licenseStatus": "ASSIGNED",
"userUuid": "string"
}
],
"totalLicenseCount": 0,
"licenseCount": 0,
"totalElementsCount": 0
}
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
licenseDetailsForUserList object[]
totalLicenseCount int32
licenseCount int32
totalElementsCount int32
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"licenseDetailsForUserList": [
{
"fname": "string",
"lname": "string",
"dealerCount": 0,
"dealerUuids": [
"string"
],
"roleUuidToNameMap": {},
"defaultRoleUuid": "string",
"licenseStatus": "ASSIGNED",
"userUuid": "string"
}
],
"totalLicenseCount": 0,
"licenseCount": 0,
"totalElementsCount": 0
}
Bad Request
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Unauthorized
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Forbidden
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Internal Server Error
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
POST /v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search
Authorization
name: basicAuthtype: httpscheme: basic
Request
Request
curl / cURL
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
python / requests
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
go / native
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
nodejs / axios
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
ruby / Net::HTTP
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
csharp / RestSharp
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
php / cURL
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
java / OkHttp
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'
powershell / RestMethod
curl -L -X POST '/manage/v2/license/dealers/:ServiceSubscriberDealer/products/:productUuid/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"searchText": "string",
"roleUuids": [
"string"
],
"licenseStatus": [
"ASSIGNED"
],
"sortField": "NAME",
"sortType": "ASC"
}'