RP_APIGetDocumentProperties: RP_APIGetDocumentProperties

View source: R/EndPoints_Document.R

RP_APIGetDocumentPropertiesR Documentation

RP_APIGetDocumentProperties

Description

This function retrieves a URL for accessing the content of a story. In the case of a story from MoreOver provider, the original_url will be returned. In the case of premium providers, a URL to the RavenPack secure platform will be returned.

Usage

RP_APIGetDocumentProperties(APIHandler, rpStoryId)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler

rpStoryId

A RavenPack identifier for a story (i.e. rp_story_id)

Value

It returns a json containing the URL to access the content of a story.

Author(s)

Maria Gomez


RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.