Get Cradles List | Legacy

Tip: A new endpoint is now available for this action. See 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>.perfectomobile.com/services/cradles?operation=list&securityToken=value

Method

GET

Request parameters

A unique cryptographic key assigned to an authorized user.

Name

Type

Default

Description

securityToken*

string


A unique cryptographic key assigned to an authorized user.

link.type 

string 

lab

The type of device. The possible values are: all, local or lab. 

* Mandatory parameter

Request response

The response is the list of cradles in XML format.

For each cradle, 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 list response format

<cradles modelVersion="modelVersion" time="time" items="2">
   <cradle>
        <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>
    <cradle>
    ...
    </cradle>
 </cradles>