REST API:socialDocument Element

REST API:socialDocument Element

From LongJump Support Wiki

REST API:socialDocument Element
Jump to: navigation, search

Work with document feeds in Relay, using the REST API.

Learn more: REST API Conventions and Considerations.

Contents

Requirements

List a Document's Followers

Method
GET
URI
  • https://na.longjump.com/networking/rest/social/getFollowers?type=4&id={document_id}
  • https://na.longjump.com/networking/rest/social/getFollowers?type=4&filter={filter_expression}
Query Parameters
  • type - The Relay Feed Type for a document
  • document_id - ID of a specific document
  • filter_expression - An expression that specifies selection criteria.
    (If the "type" argument is left off, the filter expression can be used to search for any number of things.)
For more information, see: Specifying Query Parameters in REST APIs
Response
<platform>
    <social>
        <socialUser>
            <socialUserId uri=..." displayValue="...">...user ID...</socialUserId>
        </socialUser>
    </social>
    <social>
        <socialUser>
         ...
        </socialUser>
    </social>
     ...

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of followers -->
</platform>
See also: REST API:Error Codes

Follow a Document

Method
POST
URI
https://na.longjump.com/networking/rest/social/follow
Request
<platform>
    <social>
        <socialDocument>
           <socialDocumentId>...document id...</socialDocumentId>    
        </socialDocument>
    </social>
</platform>
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes
Personal tools