Cisco WebEx Social API Reference Guide, Release 3.1
Mobile Client Operations
Downloads: This chapterpdf (PDF - 142.0KB) The complete bookPDF (PDF - 16.07MB) | Feedback

Mobile Client Operations

Table Of Contents

Mobile Client Operations

Get Information about a Mobile Client Device Type

Get Information about Custom Applications that are Supported for a Mobile Client Device Type


Mobile Client Operations


This chapter describes the Cisco WebEx Social API Mobile Client operations. These operations let you obtain information that relates to mobile clients.

Table 12-1 provides a summary of the Mobile Client operations. Each operation is described in detail in the section that is listed.

These sections provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Examples—Sample requests and responses for the operation

Table 12-1 Mobile Client Operations Summary 

Operation and Reference
Purpose

Get Information about a Mobile Client Device Type

Retrieves information about a designated Cisco WebEx Social mobile client device type

Get Information about Custom Applications that are Supported for a Mobile Client Device Type

Retrieves information about custom applications that are supported for a designated mobile client device type


Get Information about a Mobile Client Device Type

Purpose

Retrieves information about a designated Cisco WebEx Social mobile client device type.

Availability

Cisco WebEx Social 3.1 and later.

Request

HTTP Method
URI

GET

http://server[:port_number]/api/quad/rest/client/device/device_type
[?query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port_number—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

device_type—Type of mobile client device about which to retrieve branding information. Valid values are:

mobile.client.iphone—iPhone 3GS, iPod Touch third generation devices

mobile.client.iphone_retina—iPhone 4, iPhone 4S, iPod Touch fourth generation devices

mobile.client.ipad—iPad first and second generation devices

mobile.client.ipad_retina—iPad third generation device

query_parameters—Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:

The fields query parameter is supported for selecting fields from the ClientAppConfig resource to include in a response (Table 3-7 describes these fields)

The filterBy query parameter is not supported for filtering resources in a response

The sortOrder query parameter does not apply

The startIndex query parameter does not apply

The count query parameter does not apply

The meta query parameter does not apply

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one Device resource (the "ClientAppConfig Resource" section describes this resource). XML and JSON formats are supported.

XML Example

Request

GET http://webexsocialserver/api/quad/rest/client/device/mobile.client.iphone
Accept:application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<ns2:response xmlns:ns2="http://quad.cisco.com/ns/1.0/xml">
   <statusCode>200</statusCode>
   <startIndex>0</startIndex>
   <itemsPerPage>1</itemsPerPage>
   <totalResults>1</totalResults>
   <filtered>false</filtered>
   <sorted>false</sorted>
   <entry>
      <device>
         <brandingLastUpdated>1349208180280</brandingLastUpdated>
         <brandingLocation>c/mobile_asset?assetType=branding&amp;assetId=1810002</branding
Location>
         <deviceType>mobile.client.iphone</deviceType>
         <resource>http://quad.cisco.com/schema/1.0/client</resource>
      </device>
   </entry>
</ns2:response>

JSON Example

Request

GET http://webexsocialserver/api/quad/rest/client/device/mobile.client.iphone
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "statusCode":200,
   "startIndex":0,
   "itemsPerPage":1,
   "totalResults":1,
   "filtered":false,
   "sorted":false,
   "entry":[
     {
       "data":{
         "brandingLastUpdated":1349208180280,
         "brandingLocation":"c/mobile_asset?assetType=branding&assetId=1810002",
         "deviceType":"mobile.client.iphone",
         "resource":"http://quad.cisco.com/schema/1.0/client"
       }
     }
   ],
   "serverMessages":null
}

Get Information about Custom Applications that are Supported for a Mobile Client Device Type

Purpose

Retrieves information about custom applications that are supported for a designated mobile client device type.

Availability

Cisco WebEx Social 3.1 and later.

Request

HTTP Method
URI

GET

http://server[:port_number]/api/quad/rest/client/device/device_id/apps
[?query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port_number—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

device_id—Type of mobile client device for which to retrieve information about supported custom applications. Valid values are:

mobile.client.iphone—iPhone 3GS, iPod Touch third generation devices

mobile.client.iphone_retina—iPhone 4, iPhone 4S, iPod Touch fourth generation devices

mobile.client.ipad—iPad first and second generation devices

mobile.client.ipad_retina—iPad third generation device

query_parameters—Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:

The fields query parameter is supported for selecting fields from the ClientAppConfig resource to include in a response (Table 3-7 describes these fields)

The filterBy query parameter is not supported for filtering resources in a response

The sortOrder query parameter is not supported for sorting resources in a response

The startIndex query parameter is supported for paginating return results

The count query parameter is supported for designating the maximum number of items in the return results

The meta query parameter does not apply

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one or more ClientAppConfig resources (the "ClientAppConfig Resource" section describes this resource). XML and JSON formats are supported.

XML Example

Request

GET http://webexsocialserver/api/quad/rest/client/device/mobile.client.iphone/apps
Accept:application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:response xmlns:ns2="http://quad.cisco.com/ns/1.0/xml">
  <statusCode>200</statusCode>
  <startIndex>0</startIndex>
  <itemsPerPage>2</itemsPerPage>
  <totalResults>2</totalResults>
  <filtered>false</filtered>
  <sorted>false</sorted>
  <entry>
    <clientappconfig>
      <id>50c1287a57e6d27688cd82b0</id>
      <resource>http://quad.cisco.com/schema/1.0/clientappconfig</resource>
      <title>Sample App</title>
      <description>Sample app for testing purposes</description>
      <assets>
        <filtered>false</filtered>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610028</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.sampleappurl.com</appUrl>
          <assetType>SMALL_SELECTED_IMAGE</assetType>
          <assetUrl>/image?img_id=610028&amp;t=1354836090128</assetUrl>
          <lastModified>1354836090128</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610029</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.sampleappurl.com</appUrl>
          <assetType>SMALL_UNSELECTED_IMAGE</assetType>
          <assetUrl>/image?img_id=610029&amp;t=1354836090128</assetUrl>
          <lastModified>1354836090128</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610027</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.sampleappurl.com</appUrl>
          <assetType>MEDIUM_IMAGE</assetType>
          <assetUrl>/image?img_id=610027&amp;t=1354836090128</assetUrl>
          <lastModified>1354836090128</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610026</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.sampleappurl.com</appUrl>
          <assetType>LARGE_IMAGE</assetType>
          <assetUrl>/image?img_id=610026&amp;t=1354836090128</assetUrl>
          <lastModified>1354836090128</lastModified>
        </items>
        <itemsPerPage>4</itemsPerPage>
        <sorted>false</sorted>
        <startIndex>0</startIndex>
        <totalResults>4</totalResults>
      </assets>
      <type>web</type>
      <lastModified>1354836090128</lastModified>
    </clientappconfig>
  </entry>
  <entry>
    <clientappconfig>
      <id>50c128aa57e6d27688cd82b1</id>
      <resource>http://quad.cisco.com/schema/1.0/clientappconfig</resource>
      <title>TestApp</title>
      <description>New test app</description>
      <assets>
        <filtered>false</filtered>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610032</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.testappurl.com</appUrl>
          <assetType>SMALL_SELECTED_IMAGE</assetType>
          <assetUrl>/image?img_id=610032&amp;t=1354836137993</assetUrl>
          <lastModified>1354836137993</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610033</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.testappurl.com</appUrl>
          <assetType>SMALL_UNSELECTED_IMAGE</assetType>
          <assetUrl>/image?img_id=610033&amp;t=1354836137993</assetUrl>
          <lastModified>1354836137993</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610031</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.testappurl.com</appUrl>
          <assetType>MEDIUM_IMAGE</assetType>
          <assetUrl>/image?img_id=610031&amp;t=1354836137993</assetUrl>
          <lastModified>1354836137993</lastModified>
        </items>
        <items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="clientAppAssetModel">
          <resource>http://quad.cisco.com/schema/1.0/clientappasset</resource>
          <id>610030</id>
          <deviceId>mobile.client.iphone</deviceId>
          <appUrl>www.testappurl.com</appUrl>
          <assetType>LARGE_IMAGE</assetType>
          <assetUrl>/image?img_id=610030&amp;t=1354836137993</assetUrl>
          <lastModified>1354836137993</lastModified>
        </items>
        <itemsPerPage>4</itemsPerPage>
        <sorted>false</sorted>
        <startIndex>0</startIndex>
        <totalResults>4</totalResults>
      </assets>
      <type>web</type>
      <lastModified>1354836137993</lastModified>
    </clientappconfig>
  </entry>
</ns2:response>

JSON Example

Request

GET http://webexsocialserver/api/quad/rest/client/device/mobile.client.iphone/apps
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
    "statusCode": 200, 
    "startIndex": 0, 
    "itemsPerPage": 2, 
    "totalResults": 2, 
    "filtered": false, 
    "sorted": false, 
    "entry": [
        {
            "data": {
                "id": "50c1287a57e6d27688cd82b0", 
                "resource": "http://quad.cisco.com/schema/1.0/clientappconfig", 
                "title": "Sample App", 
                "description": "Sample app for testing purposes", 
                "assets": {
                    "startIndex": 0, 
                    "itemsPerPage": 4, 
                    "totalResults": 4, 
                    "sorted": false, 
                    "filtered": false, 
                    "items": [
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610028, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.sampleappurl.com", 
                            "assetType": "SMALL_SELECTED_IMAGE", 
                            "assetUrl": "/image?img_id=610028&t=1354836090128", 
                            "lastModified": 1354836090128
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610029, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.sampleappurl.com", 
                            "assetType": "SMALL_UNSELECTED_IMAGE", 
                            "assetUrl": "/image?img_id=610029&t=1354836090128", 
                            "lastModified": 1354836090128
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610027, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.sampleappurl.com", 
                            "assetType": "MEDIUM_IMAGE", 
                            "assetUrl": "/image?img_id=610027&t=1354836090128", 
                            "lastModified": 1354836090128
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610026, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.sampleappurl.com", 
                            "assetType": "LARGE_IMAGE", 
                            "assetUrl": "/image?img_id=610026&t=1354836090128", 
                            "lastModified": 1354836090128
                        }
                    ]
                }, 
                "type": "web", 
                "lastModified": 1354836090128
            }
        }, 
        {
            "data": {
                "id": "50c128aa57e6d27688cd82b1", 
                "resource": "http://quad.cisco.com/schema/1.0/clientappconfig", 
                "title": "TestApp", 
                "description": "New test app", 
                "assets": {
                    "startIndex": 0, 
                    "itemsPerPage": 4, 
                    "totalResults": 4, 
                    "sorted": false, 
                    "filtered": false, 
                    "items": [
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610032, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.testappurl.com", 
                            "assetType": "SMALL_SELECTED_IMAGE", 
                            "assetUrl": "/image?img_id=610032&t=1354836137993", 
                            "lastModified": 1354836137993
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610033, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.testappurl.com", 
                            "assetType": "SMALL_UNSELECTED_IMAGE", 
                            "assetUrl": "/image?img_id=610033&t=1354836137993", 
                            "lastModified": 1354836137993
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610031, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.testappurl.com", 
                            "assetType": "MEDIUM_IMAGE", 
                            "assetUrl": "/image?img_id=610031&t=1354836137993", 
                            "lastModified": 1354836137993
                        }, 
                        {
                            "resource": "http://quad.cisco.com/schema/1.0/clientappasset", 
                            "id": 610030, 
                            "deviceId": "mobile.client.iphone", 
                            "appUrl": "www.testappurl.com", 
                            "assetType": "LARGE_IMAGE", 
                            "assetUrl": "/image?img_id=610030&t=1354836137993", 
                            "lastModified": 1354836137993
                        }
                    ]
                }, 
                "type": "web", 
                "lastModified": 1354836137993
            }
        }
    ], 
    "serverMessages": null
}