Get Cradle Information | Legacy

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>.perfectomobile.com/services/cradles/<CRADLE ID>?operation=info&securityToken=value

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.

Request parameters

Name

Type

Default

Description

securityToken*

string


A unique cryptographic key assigned to an authorized user.

* Mandatory parameter

Request response

The response is the information for the specific cradle in XML format.

The following are the top-level information items displayed

Attribute

Description

id

Cradle identification as displayed in the System Administration interface.

description

Text description as configured

url

The URL of the cradle (used for diagnostics)

link

Indicates the type of cradle: lab, local, or unknown

status

Current status of the cradle - mode is one of: READY, CONNECTED, LOADING, ERROR

host

Information regarding the network host

camera

Information on the camera (if relevant)

dock

Information regarding the physical connection

board

Information regarding the board that the cradle supports

stream

Information regarding the video/audio streaming supported

handset

Information of device connected to the cradle

power supply

Information on the power connection of the cradle

Copy

Cradle information format

<cradle modelVersion="modelVersion" time="time">
    <id>...</id>
    <description>...</description>
    <url>...</url> 
    <link>
        <type>lab|local|unknown</type>
    </link>
    <status>
        <mode>...</mode>
        <description>...</description>
        <code>...</code>
        <changeTime>
            <millis>...</millis>
            <formatted>...</formatted>
        </changeTime>
        <transitions>
            <number>...</number>
            <interval>...</interval>
        </transitions>
        <evaluation>
            <validity>...</validity>
        </evaluation>
        <operabilityRating>
            <score>...</score>
            <description>...</description>
            <referenceTimestamp>...</referenceTimestamp>
        </operabilityRating>
    </status>
    <host>
        <id>...</id>
        <address>...</address>
        <productVersion>...</productVersion> <!--optional tag-->
    </host>
    <camera>
        <type>...</type>
        <videoSource>...</videoSource>
    </camera>
    <dock>
        <id>...</id>
        <description>...</description>
        <location>...</location>
        <type>...</type>
    </dock>
    <board>
        <type>...</type>
        <serialNumber>...</serialNumber>
    </board>
    <stream>
        <id>...</id>
        <streamStatus>...</streamStatus>
        <recordingStatus>...</recordingStatus>
        <hasAudio>...</hasAudio>
        <audioDevice>...</audioDevice>
        <imageMode>
            <active>...</active>
            <description/>
        </imageMode>
    </stream>
    <handset>
        <deviceId>...</deviceId>
        <manufacturer>...</manufacturer>
        <model>...</model>
        <distributor>...</distributor>
        <description>...</description>
        <firmware>...</firmware>
        <imsi>...</imsi>
        <nativeImei>...</nativeImei>
        <wifiMacAddress>...</wifiMacAddress>
        <link>
            <type>lab|local|all</type>
        </link>
        <operator>
            <name>...</name>
            <country>...</country>
            <code>...</code>
        </operator>
        <location>...</location>
        <language>...</language>
        <deviceId>...</deviceId>
        <status>...</status>
        <inUse>true|false</inUse>
        <cradleId>...</cradleId>
        <dynamicFields>
            <fieldName>fieldValue</fieldName>
        </dynamicFields>
        <os>...</os>
        <osVersion>...</osVersion>
        <resolution>...</resolution>
        <phoneNumber>...</phoneNumber>
        <description>...</description>
    </handset>
    <powerSupply>
        <source>...</source>
        <offlineCharging>...</offlineCharging>
    </powerSupply>
</cradle>