Skip to content

findToolboxAssets ​

Returns a list of "Available" and "Assigned" Assets for a "connected" MI User for a given Company. Intended usage is within Toolbox HTML assets to allow end users to self-assign/unassign assets to/from a wall themselves

Request ​

http
GET /rest/user/toolbox/asset

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
remoteAppUUIDYesThe UUID from the Remote App configured in SAM that has been setup specifically for Toolbox usage.
deviceTypeYesThe device type of the requesting device. Must be one of the following values ("iPad", "iPhone", "Desktop", "Android Tablet", "Android Phone")

Response ​

200 OK ​

JSON Response: NOTE: availableBrochures - those that can be assigned via assignAssetToUserViaToolbox()assignedBrochures - those already assigned to user and can be unassigned via unassignAssetFromUserViaToolbox()

json
{
  "availableBrochures": [
    {
      "userId": 8,
      "bId": 62,
      "bName": "Apple",
      "bBody": "Apple Description",
      "cId": 3,
      "pId": 15,
      "pName": "Event Product 14",
      "bStatus": "A",
      "bIsInternal": "N",
      "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochures/null/null"
    },
    {
      "userId": 8,
      "bId": 63,
      "bName": "Microsoft",
      "bBody": "Microsoft Description",
      "cId": 3,
      "pId": 15,
      "pName": "Event Product 14",
      "bStatus": "A",
      "bIsInternal": "N",
      "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochures/null/null"
    }
  ],
  "assignedBrochures": [
    {
      "userId": 8,
      "bId": 61,
      "bName": "Google",
      "bBody": "Microsoft Description",
      "cId": 3,
      "pId": 13,
      "pName": "Event Product 12",
      "bStatus": "A",
      "bIsInternal": "N",
      "bvAsset": "https://s3.amazonaws.com/DEV.com.nextinteract.brochures/3/brochures/null/null"
    }
  ]
}

Errors ​

ExceptionDescription
WSCompanyServiceUnavailableExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSInsufficientPermissionsExceptionSee Error Definitions
WSCompanyServiceExceptionSee Error Definitions
WSEventServiceExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInternalExceptionSee Error Definitions