Gigya Job Openings

comments.getRelatedUsers REST

Skip to end of metadata
Go to start of metadata

 

Description

This API retrieves information about the current comment being written and a prefix of the user name to search, and returns a list of suggested users for auto-complete.

 

Request URL


Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.

 

Parameters

RequiredNameTypeDescription
categoryIDstringThe identifier of the current comments category.
streamIDstringThe identifier of the current comments stream.
parentCommentIDstringThe identifier of the parent of the comment that is being written. If the current comment is not a reply, the value is null.
limitintegerThe maximum number of users to retrieve. The default value is 10. The maximum possible value to set is 25.
usernamePrefixstringA prefix of the user name to search.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

 

Sample Requests

 

Response Data

FieldTypeDescription
 
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

relatedUsersArray of objectsAn array containing the suggested users for auto-complete. Each object includes the following fields:
  • uid: The unique identifier of the user (will not be returned for guest users)
  • name: The name of the user
  • photoURL: The URL of the user's profile photo
  • provider: The provider to which the user belongs.

A field that does not contain data will not appear in the response.

 

Response Example

{
    "relatedUsers":
    [
        {
            "uid": "_gid_cXV3aIZmTdy/xE9+Bw3cNyzKKRfG+8HXoyBvWnzZwqA=",
            "name": "Ziv Anabel",
            "photoURL": "http://graph.facebook.com/100005948952717/picture?type=square",
            "provider": "facebook"
        },
        {
            "uid": "_gid_BHEMbvWXLCTGzb/R3StCXVgB+oYS/XTsuKVGYekv6t4=",
            "name": "Erin Ziv",
            "photoURL": "http://graph.facebook.com/100005395561062/picture?type=square",
            "provider": "facebook"
        }
    ],
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "27d130fdb749496ab0e9d1544a4ba23b",
    "time": "2015-03-22T11:42:25.943Z"
}