Cisco WebEx Social API Reference Guide, Release 3.4
Suggestions Resource Operations
Downloads: This chapterpdf (PDF - 234.0KB) The complete bookPDF (PDF - 15.05MB) | Feedback

Suggestions Resource Operations

Table Of Contents

Suggestions Resource Operations

Get Suggestions for You for People, Communities, and Posts

Get Suggestions for People for You to Follow

Get Suggestions for Communities for You to Join

Obtain Suggestions for Posts for You to Read

Stop Suggestions from Being Provided to You


Suggestions Resource Operations


The Suggestions resource operations let you obtain from Cisco WebEx Social suggestions for following certain people, reading certain posts, or joining certain comminutes.

Table 10-1 provides a summary of the Suggestions resource 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

Example—Sample request and response for the operation

In these sections, "you" and "your" refer to the authenticated user who is executing an operation.

Table 10-1 Suggestions Resource Operations Summary 

Operation and Reference
Purpose

Get Suggestions for You for People, Communities, and Posts

Retrieves suggestions for you regarding people to follow, communities to join, and posts to read

Get Suggestions for People for You to Follow

Retrieves suggestions for you regarding people to follow

Get Suggestions for Communities for You to Join

Retrieves suggestions for you regarding communities to join

Obtain Suggestions for Posts for You to Read

Retrieves suggestions for you regarding posts to read

Stop Suggestions from Being Provided to You

Stops the system from providing the suggestions to you regarding people to follow, posts to read, or communities to join


Get Suggestions for You for People, Communities, and Posts

Purpose

Retrieves suggestions for you regarding people to follow, communities to join, and posts to read.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/users/[user_id|@me]/suggestions
?fields=id,target(@suggestion),suggestionReason
[?query_parameters]


where:

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

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Your Cisco WebEx Social user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

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

The fields query parameter is recommended as shown in the URI for selecting fields from the Suggestions resource to include in a response (Table 3-45 describes these fields).

The filterBy query parameter does not apply.

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.

The special suggestionsCount query parameter is supported for designating the maximum number of each type of item to include in the return results. For example, if specify suggestionsCount-2, the return results include up to 2 people, up to 2 communities, and up to 2 posts, for a total of up to 6 items. The default value is 2.

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 Suggestions resources (the "Suggestions Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/users/@me/suggestions 
?fields=id,target(@suggestion),suggestionReason
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   

The response can also include the Suggestions resource. For an example, see the "Suggestions Resource Response" section.

Get Suggestions for People for You to Follow

Purpose

Retrieves suggestions for you regarding people to follow.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/users/[user_id|@me]/suggestions/
@suggestedusers?fields=id,target(@suggestion),suggestionReason
[?query_parameters]


where:

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

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Your Cisco WebEx Social user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

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

The fields query parameter is recommended as shown in the URI for selecting fields from the Suggestions resource to include in a response (Table 3-45 describes these fields).

The filterBy query parameter does not apply

The sortOrder query parameter does not apply

The startIndex query parameter does not apply.

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 Suggestions resources (the "Suggestions Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/users/@me/ 
suggestions/@suggestedusers?fields=id,target(@suggestion),suggestionReason
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   

The response can also include the Suggestions resource. For an example, see the "Suggestions Resource Response" section.

Get Suggestions for Communities for You to Join

Purpose

Retrieves suggestions for you regarding communities to join.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/users/[user_id|@me]/suggestions/
@suggestedcommunities?fields=id,target(@suggestion),suggestionReason
[?query_parameters]


where:

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

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Your Cisco WebEx Social user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

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

The fields query parameter is recommended as shown in the URI for selecting fields from the Suggestions resource to include in a response (Table 3-45 describes these fields)

The filterBy query parameter does not apply

The sortOrder query parameter does not apply

The startIndex query parameter does not apply

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 Suggestions resources (the "Suggestions Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/users/@me/ 
suggestions/@suggestedcommunities?fields=id,target(@suggestion),suggestionReason
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   

The response can also include the Suggestions resource. For an example, see the "Suggestions Resource Response" section.

Obtain Suggestions for Posts for You to Read

Purpose

Retrieves suggestions for you regarding posts to read.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/users/[user_id|@me]/suggestions/
@suggestedposts?fields=id,target(@suggestion),suggestionReason
[?query_parameters]


where:

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

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Your Cisco WebEx Social user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

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

The fields query parameter is recommended as shown in the URI for selecting fields from the Suggestions resource to include in a response (Table 3-45 describes these fields)

The filterBy query parameter does not apply

The sortOrder query parameter does not apply

The startIndex query parameter does not apply

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 Suggestions resources (the "Suggestions Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/users/@me/ 
suggestions/@suggestedposts?fields=id,target(@suggestion),suggestionReason
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   

The response can also include the Suggestions resource. For an example, see the "Suggestions Resource Response" section.

Stop Suggestions from Being Provided to You

Purpose

Stops the system from providing the suggestions to you regarding people to follow, posts to read, or communities to join.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

DELETE

{http|https}://server[:port]/api/quad/rest/users/[user_id|@me]/suggestions/
[user|community|post]:id


where:

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

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Your Cisco WebEx Social user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

id—One of the following. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

If you include user in the request, Cisco WebEx Social identifier of a person for which to stop receiving suggestions to follow.

If you include post in the request, Cisco WebEx Social identifier of a post for which to stop receiving suggestions to read.

If you include community in the request, Cisco WebEx Social identifier of a community for which to stop receiving suggestions to join.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with an HTTP header only.

Example

Request

DELETE http://webexsocialserver/api/quad/rest/users/@me/suggestions/user:309458

Response

204 No Content