REST API:social vote Resource

REST API:social vote Resource

From LongJump Support Wiki

REST API:social vote Resource
Jump to: navigation, search

Manage votes on posted messages using the REST API.

Learn more: REST API Conventions and Considerations.

Contents

Requirements

Vote on a Posted Message

Method
POST
URI
https://na.longjump.com/networking/rest/feed/{id}/vote/like
Add the current user to the list of people who voted "like" for a specified message.

where

  • {id} - record ID of the posted message
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Get a List of Users Who Voted on a Posted Message

("Get" if complete records are returned. "List" if partial data is returned, requiring a second read to get a complete set of data. This comes before the GET, because typically it's called first to get the ID used in a specific-record GET.)

Method
GET
URI
https://na.longjump.com/networking/rest/social/feed/{id}/vote/like
Returns a list of users who voted "like" for a specified message.

where

  • {id} - record ID of the posted message
Response
<platform>
    <social>
        <socialUser>
            <socialUserId uri="..."
               displayValue="...user's display name name..."
               thumbnailId="..."
           >...user id...</socialUserId>
        </socialUser>
    </social>
    <social>
        <socialUser>
            <socialUserId uri="..."
               displayValue="...user's display name name..."
               thumbnailId="..."
           >...user id...</socialUserId>
        </socialUser>
    </social>
    ...
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>2</recordCount>      <!-- Number of votes returned -->
</platform>
See also: REST API:Error Codes

Fields

Note: Unless otherwise indicated, the attribute for a field is "Editable on Add or Update".
NameTypeAttributeDescriptionAdditional Information
socialUserId LookupRead Only User's ID
  String uri REST user Resource pointer Use this URL with an HTTP GET to access detailed information for the user.
String displayValue The name of the user, as displayed in the GUI
String thumbnailId The record ID for the user's thumbnail image. Access the image using the REST document Resource.
Personal tools