Get Cradles List

Restriction: This API endpoint is not supported in the public cloud.

Restriction: This API endpoint is not supported in the Free Trial cloud.

Retrieves the information of all cradles in the system. This operation requires system administrator credentials and is filtered by the user's location.

URL

Copy

https://<your_cloud>.app.perfectomobile.com/api/v1/device-management/cradles?linkType=all

Method

GET

For information on a previous version of this endpoint, see Get Cradles List | Legacy.

Header parameters

Name	Description
`Perfecto-Authorization`	The Perfecto security token. For more information, see Generate a security token.

Request parameters

Name	Type	Default	Description
`linkType`	string	lab	The type of device. The possible values are: `all`, `local`, or `lab`.

Success response

Code: 200 OK

Copy

Success response format

{
    "cradles": {
        "timeStamp": 1675769474743,
        "productVersion": "master",
        "modelVersion": "2.21.0.0",
        "time": "2023-02-07:11-31-14 GMT",
        "items": 1,
        "cradle": [
            {
                "systemInfo": {
                    "hssModel": "<<HSS_MODEL_VALUE>>",
                    "hssSerialNumber": "<<SERIAL_NUMBER>>"
                },
                "stream": {
                    "hasAudio": false|true,
                    "recordingStatus": "OFF|ON",
                    "id": "<<ID>>",
                    "imageMode": {
                        "active": false|true,
                        "description": "<<DESCRIPTION>>"
                    },
                    "streamStatus": "OFF|ON",
                    "audioDevice": "Digital",
                    "hasAudioStream": false|true
                },
                "link": {
                    "type": "lab|all|unknown"
                },
                "host": {
                    "productVersion": "<<PRODUCT_VERSION>>",
                    "address": "<<HOST_IP_ADDRESS>>",
                    "id": "<<HOST_ID>>"
                },
                "handset": {
                    "osBuild": "<<OS_BUILD>>",
                    "link": {
                        "type": "lab|all|unknwon"
                    },
                    "description": "<<DESCRIPTION>>",
                    "cpuArch": "<<CPU_ARCH_INFO>>",
                    "imsi": <<IMSI_NUMBER>>,
                    "deviceId": "<<DEVICE_ID>>",
                    "originalDeviceId": "<<ORIGINAL_DEVICE_ID>>",
                    "operator": {
                        "country": "<<COUNTRY>>",
                        "code": <<CODE>>,
                        "name": "<<NAME>>",
                        "content": "<<CONTENT>>"
                    },
                    "manufacturer": "<<MANUFACTURER_NAME>>",
                    "wifiMacAddress": "<<WIFI_MAC_ADDRESS>>",
                    "phoneNumber": "<<PHONE_NUMBER>>",
                    "model": "<<MODEL>>",
                    "distributer": "<<DISTRIBUTER>>",
                    "firmware": "<<FIRMWARE_INFO>>",
                    "nativeImei": <<NATIVE_IMEI>>
                },
                "description": "<<DESCRIPTION>>",
                "id": "<<CRADLE_ID>>",
                "dock": {
                    "description": "<<DOCK_DESCRIPTION>>",
                    "location": "<<DOCK_LOCATION>>",
                    "id": "<<ID>>",
                    "type": "<<TYPE>>"
                },
                "url": "<<URL>>",
                "board": {
                    "serialNumber": "<<SERIAL_NUMBER>>",
                    "type": "<<TYPE>>"
                },
                "powerSupply": {
                    "offlineCharging": "<<VALUE>>",
                    "source": "<<SOURCE>>"
                },
                "status": {
                    "mode": "<<MODE>>",
                    "changeTime": {
                        "formatted": "2023-02-07:10-39-07 GMT",
                        "millis": 1675766347732
                    },
                    "evaluation": {
                        "validity": "<<VALIDITY>>"
                    },
                    "code": "<<CODE>>",
                    "description": "<<DESCRIPTION>>",
                    "operabilityRating": {
                        "score": "<<RATING>>"
                    },
                    "transitions": {
                        "number": <<NUMBER>>,
                        "interval": <<INTER>>
                    }
                }
            }
        ]
    }
}

For each cradle, the top-level information items listed in the following table are displayed.

Attribute	Description
systemInfo	Information regarding the system, including hhsModel or hssSerialNumber
stream	Information regarding the video/audio streaming supported
link	Indicates the type of cradle: lab, local, or unknown
host	Information regarding the network host
handset	Information of device connected to the cradle
description	Text description as configured
id	Cradle identification as displayed in the System Administration interface
dock	Information regarding the physical connection
url	The URL of the cradle (used for diagnostics)
power supply	Information on the power connection of the cradle
status	Current status of the cradle. Can be one of the following: READY, CONNECTED, LOADING, ERROR
camera	Information on the camera (if relevant)
board	Information regarding the board that the cradle supports

Error response

Copy

Error response format

[
    {
        "userMessage":"ERROR_MESSAGE",
        "developerMessage": "1-63dbebb1-4521fab52df9f41a578221c8"
    }
]

where:

userMessage is the error message to be shown.
developerMessage is a value that you can send to Perfecto Support to check errors if further investigation is required.

Sample error responses

Copy

A wrong securityToken is passed in the request (Unauthorized Request Code - 401)

[
    {
        "userMessage": "Unable to authenticate bearer token",
        "developerMessage": "Unable to authenticate bearer token"
    }
]

Copy

Invalid linkType is passed in the request (Bad Request Code - 400)

[
    {
        "userMessage": "Invalid link type 'abc'",
        "developerMessage": "6abcdb41bbe648769d2ccb7d0a5a1627"
    }
]