Cisco WebEx Social API Reference Guide, Release 3.1
Configuration Operation
Downloads: This chapterpdf (PDF - 97.0KB) The complete bookPDF (PDF - 16.07MB) | Feedback

Configuration Operation

Table Of Contents

Configuration Operation

Get Information about Configurable Settings for Cisco WebEx Social Clients


Configuration Operation


This chapter describes the Cisco WebEx Social API Configuration operation. This operation lets you retrieve information about Cisco WebEx Social clients.

Table 11-1 provides a summary of the Configuration operation. This operation is described in detail in the section that is listed. The section 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 11-1 Configuration Operation Summary 

Operation and Reference
Purpose

Get Information about Configurable Settings for Cisco WebEx Social Clients

Retrieves information about configurable settings for Cisco WebEx Social clients


Get Information about Configurable Settings for Cisco WebEx Social Clients

Purpose

Retrieves information about configurable settings for Cisco WebEx Social clients.

Availability

Cisco WebEx Social 3.1 and later.

Request

HTTP Method
URI

GET

http://server[:port_number]/api/quad/rest/config/entitlement
[?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.

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 Settings resource to include in a response (Table 3-21 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 Entitlement resource (the "Entitlement Resource" section describes this resource). XML and JSON formats are supported.

XML Example

Request

GET http://webexsocialserver/api/quad/rest/config/entitlement
Accept:application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
<?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>1</itemsPerPage>
  <totalResults>1</totalResults>
  <filtered>false</filtered>
  <sorted>false</sorted>
  <entry>
    <entitlement>
      <documentService>true</documentService>
      <likeService>true</likeService>
      <mobileBranding>false</mobileBranding>
      <mobileExtensibility>false</mobileExtensibility>
      <qnaService>true</qnaService>
            <resource>http://quad.cisco.com/schema/1.0/entitlement</resource>
      <termsOfUseRequired>true</termsOfUseRequired>
      <twitterService>true</twitterService>
      <ucChatService>true</ucChatService>
      <ucWebConfService>true</ucWebConfService>
      <ucWebPhoneService>true</ucWebPhoneService>
      <videoService>false</videoService>
    </entitlement>
  </entry>
</ns2:response>

JSON Example

Request

GET http://webexsocialserver/api/quad/rest/config/entitlement
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":{
         "documentService":true,
         "likeService":true,
         "mobileBranding":false,
         "mobileExtensibility":false,
         "qnaService":true,
         "resource":"http://quad.cisco.com/schema/1.0/entitlement",
         "termsOfUseRequired":true,
         "twitterService":true,
         "ucChatService":true,
         "ucWebConfService":true,
         "ucWebPhoneService":true,
         "videoService":false
       }
     }
   ],
   "serverMessages":null
}