Get Device Information | Legacy

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 for the device specified by <deviceId>

Users can only get information for devices that are accessible by their roles.

URL

Copy 
https://<my-cloud>.perfectomobile.com/services/handsets/<deviceId>?operation=info&securityToken=value

Method

GET

Request parameters

Name

Type

Default

Description

securityToken*

string

A unique cryptographic key assigned to an authorized user.

admin

boolean

false

true to provide administrative information in the response. This is allowed only for users with administrative credentials, for devices user is able to administrate.

* Mandatory parameter

Request response

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

The handset status can be one of the following values:

  • Never Connected
  • Not Connected
  • Ready
  • Connected
  • Loading
  • Error
  • Unknown
  • Invalid
  • Ready to connect
  • Unsupported

The following is a list of the possible return values for the mode field:

  • NEVER_CONNECTED
  • NOT_CONNECTED
  • CONNECTED
  • LOADING
  • ERROR
  • READY_TO_CONNECT
  • UNSUPPORTED
Copy

Handset information format (XML)

<handset modelVersion="2.21.0.0" productVersion="master" time="2016-12-01:13-32-30 GMT" timeStamp="1480599150802">
    <deviceId>...</deviceId>
    <manufacturer>...</manufacturer>
    <model>...</model>
    <distributer>...</distributer>
    <description>...</description>
    <firmware>...</firmware>
    <imsi/>
    <nativeImei>...</nativeImei>
    <wifiMacAddress>...</wifiMacAddress>
    <link>
        <type>lab|local|unknown</type>
    </link>
    <operator>
        <name/>
        <country/>
        <code/>
    </operator>
    <phoneNumber/>
    <location>...</location>
    <lastCradleId>...</lastCradleId>
    <language>...</language>
    <status>...</status>
    <mode>...</mode>
    <available>true|false</available>
    <reserved>true|false</reserved>
    <reservedTo>...</reservedTo>    <!--only if admin=true-->
    <inUse>true|false</inUse>
    <allocatedTo>...</allocatedTo> <!--only if admin=true-->
    <operabilityRating>
        <score>100</score>
    </operabilityRating>
    <cradleId>...</cradleId>
    <cradle>   <!--only if admin=true-->
        <id>...</id>
        <status>
            <mode>...</mode>
            <description>...</description>
            <code>...</code>
        </status>
    </cradle>
    <position>
        <id>...</id>
        <method>...</method>
        <rotation>...</rotation>
    </position>
    <debugLogs>
        <collecting>true|false</collecting>
    </debugLogs>
    <powerSupply>           <!--only if admin=true-->
        <source>...</source>
        <offlineCharging>...</offlineCharging>
    </powerSupply>
    <os>...</os>
    <osVersion>...</osVersion>
    <resolution>...</resolution>
    <roles>                 <!--only if admin=true-->
        <role>...</role>    <!-- repeated #roles-->
    </roles>
    <connectionProperties>   <!--only if admin=true-->
        <property name="mac-host"/>
        <property name="device-host-type">...</property>
        <property name="location">...</property>
        <property name="device-host">...</property>
        <property name="device-id">...</property>
    </connectionProperties>
</handset>