Partner Webservice

Get MSP hardware inventory

MSP only. Every hardware unit under the MSP's PARTNER control with the org it is currently registered in, its device, license state and whether it is bound to an access-controlled door.

post/api/partner/hardware/getInventory

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/hardware/getInventory
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

PartnerMspGetHardwareInventoryWSRequest required

Request for the MSP's controlled hardware (no fields).

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "units": [
    {
      "currentOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "hwUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.