GET
tenantDeviceInventory
This dataset is addressing the details. tenantApiCode value of "af0813e6-81c0-4a77-89d2-3338d0277c42" and apikey value of "1hKMMPFMmaldnC0rcohvXN0UX7UeWPjb" can be used as url parameters to test this api for accessing sample data.
Note:
- The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only.
- For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant.
- Please register here http://developer.plantronics.com/user/register and generate your apikey for apps when you are ready to integrate with a production tenant data and your app.
Resource URL
https://oda-sandbox.plantronicsmanager.com /reports/assets/tenant/{tenantApiCode}/devices
Query Parameters
Name | Values | Description |
---|---|---|
apikey
(required) |
Key to access this api. |
|
manufacturer |
Manufacturer of the device; Could be plantronics or non plantronics |
|
deviceState |
Device state; Please refer documentation on device states |
|
productId |
Product name e.g. BT600 |
|
deviceType |
productId |
|
lastSeenStartTime
(required) |
Start date time for when the device was last seen filter. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format. |
|
lastSeenEndTime
(required) |
End date time for when the device was last seen filter. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format. |
|
page
(required) |
Page of the result, start from 0 |
|
count
(required) |
Page of the request |
Header Parameters
Name | Values | Description |
---|---|---|
appId
(required) |
Unique Id for the App |
Request Body
tenantApiCode ID of the tenant; Should be a valid hexadecimal af0813e6-81c0-4a77-89d2-3338d0277c42 true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400
Generic malformed request.
-
422
One or more of the required parameters not found in the request URI.
-
401
Unauthorized
-
500
Internal server error.
-
403
Unauthorized token error.
-
404
No device entity could be found for the requested device path parameters
Resource Summary |
|
Security |
|
Content Type |
application/json |
Category |
Asset Management and Adoption |
Name | Type | Description |
---|
Name | Type | Description |
---|
Working...