Get Cradle Information

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

Retrieves the information for the cradle specified by <CRADLE ID>.

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/cradle?cradleId=<CRADLE_ID>

Method

GET

where <CRADLE ID> is the ID of the cradle as returned by the Cradles List command or from the list of cradles in the System Administration interface.

For information on a previous version of this endpoint, see Get Cradle Information | Legacy.

Header parameters

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

Request parameters

Name	Type	Default	Description
cradleId	string		The ID of the cradle as returned by the Cradles List command or from the list of cradles in the System Administrator interface

Name

Type

Default

Description

cradleId

string

The ID of the cradle as returned by the Cradles List command or from the list of cradles in the System Administrator interface

Success response

Code: 200 OK

Copy

Success response format

{
    "cradle": {
        "modelVersion": "<<MODEL_VERSION>>",
        "link": {
            "type": "<<LINK_TYPE>>"
        },
        "description": "<<DESCRIPTION>>",
        "url": "<<URL>>",
        "powerSupply": {
            "offlineCharging": "<<OFFLINE_CHARGING_VALUE>>",
            "source": "<<SOURCE_VALUE>>"
        },
        "timeStamp": <<TIMESTAMP>>,
        "systemInfo": {
            "hssModel": "<<HSS_MODEL_VALUE>>",
            "hssSerialNumber": "<<HSS_SERIAL_NUMBER_VALUE>>"
        },
        "productVersion": "<<PRODUCT_VERSION_VALUE>>",
        "stream": {
            "hasAudio": true|false,
            "recordingStatus": "OFF|ON",
            "id": "<<STREAM_ID>>",
            "imageMode": {
                "active": false|true,
                "description": "<<IMAGE_MODE_DESCRIPTION>>"
            },
            "streamStatus": "OFF|ON",
            "audioDevice": "<<AUDIO_DEVICE_VALUE>>",
            "hasAudioStream": false|true
        },
        "host": {
            "productVersion": "<<PRODUCT_VERSION_VALUE>>",
            "address": "<<HOST_ADDRESS_VALUE>>",
            "id": "<<HOST_ID>>"
        },
        "handset": {
            "osBuild": "<<OS_BUILD_VALUE>>",
            "link": {
                "type": "<<LINK_TYPE_VALUE>>"
            },
            "description": "<<DESCRIPTION>>",
            "cpuArch": "<<CPU_ARCH_VALUE>>",
            "imsi": "<<IMSI_VALUE>>",
            "deviceId": "<<DEVICE_ID>>",
            "originalDeviceId": "<<ORIGINAL_DEVICE_ID>>",
            "operator": {
                "country": "<<COUNTRY_NAME>>",
                "code": <<COUNTRY_CODE>>,
                "name": "<<OPERATOR_NAME>>",
                "content": "<<CONTENT_VALUE>>"
            },
            "manufacturer": "<<MANUFACTURER_VALUE>>",
            "wifiMacAddress": "<<WIFI_MAC_ADDRESS_VALUE>>",
            "phoneNumber": "<<PHONE_NUMBER>>",
            "model": "<<MODEL_VALUE>>",
            "distributer": "<<DISTRIBUTER_VALUE>>",
            "firmware": <<FIRMWARE_VALUE>>,
            "nativeImei": "NATIVE_IMEI_VALUE"
        },
        "time": "<<TIME>>",
        "id": "<<CRADLE_ID>>",
        "dock": {
            "description": "<<DOCK_DESCRIPTION>>",
            "location": "<<LOCATION>>",
            "id": "<<ID>>",
            "type": "<<DOCK_TYPE>>"
        },
        "board": {
            "serialNumber": "<<SERIAL_NUMBER>>",
            "type": "<<BOARD_TYPE>>"
        },
        "status": {
            "mode": "<<MODE_VALUE>>",
            "changeTime": {
                "formatted": "<<TIME>>",
                "millis": <<TIME_IN_MILLIS>>
            },
            "evaluation": {
                "validity": "<<VALIDITY>>"
            },
            "code": "<<CODE_VALUE>>",
            "description": "<<DESCRIPTION>>",
            "operabilityRating": {
                "score": <<SCORE_VALUE>>
            },
            "transitions": {
                "number": <<TRANSITIONS_NUMBER_VALUE>>,
                "interval": <<TRANSITIONS_INTERVAL_VALUE>>
            }
        }
    }
}

The following are the top-level information items displayed in the response.

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

Request 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 cradleId is passed in the request (Bad Request Code - 400)

[
    {
        "userMessage": "Failed to get cradle item - Failed to get cradle",
        "developerMessage": "15d81f547c424ac3bb15e9419522f0c9"
    }
]