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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
licenseDetailsForUserList object[]
Array [
fname string
lname string
dealerCount int32
dealerUuids string[]
roleUuidToNameMap object
property name* string
defaultRoleUuid string
licenseStatus string
Possible values: [ASSIGNED, UNASSIGNED]
userUuid string
]
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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
licenseDetailsForUserList object[]
Array [
fname string
lname string
dealerCount int32
dealerUuids string[]
roleUuidToNameMap object
property name* string
defaultRoleUuid string
licenseStatus string
Possible values: [ASSIGNED, UNASSIGNED]
userUuid string
]
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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
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[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Loading...