APIs & services / Reporting datasets (rtld)

Load help video links.

Endpointtoday's app

Call: GET /rtld/api/dataset/v1/execute?name=UrviYouTube
Service: Reporting datasets (rtld)
Features: Home and bottom bar
When: Every Home open
Auth: X-SESSIONID set by CoreAPI (dooNowOrThrow)
In the App Service: GET /config

Use case

HomeViewModel.fetchYoutubeVideos runs each time Home opens and caches the list in SharedPreferences (KEY_YOUTUBE_VIDEO_LINKS). Module screens call AppUtils.getIfVideoButtonEnabled(module) to show a help-video button when visibility is "SHOW", and getYoutubeVideoLinkForModule(module) to embed the link in an iframe. Failures are logged and the old cache is used.

Headers

Header	Value	Notes
`X-SESSIONID`	<session token>	Added by Bridge CoreAPI from the AccountManager session when the Operation is executed with dooNowOrThrow. The app code does not set it.

Parameters

Param	In	Required	Example	Notes
`name`	query	Yes	`UrviYouTube`	Dataset name. The rtld executor (/rtld/api/dataset/v1/execute) picks the dataset by this query param.
`version`	query	Yes	`1`	Dataset version. Always 1.
`format`	query	Yes	`json`	Response format. Always json, so the body is a JSON array of row objects.

Request

No body.

Response

Example response body (synthetic data)

[
  {
    "module": "LAND_ASSET",
    "visibility": "SHOW",
    "youtube_link": "https://www.youtube.com/embed/EXAMPLE0001"
  },
  {
    "module": "CROP_PLAN",
    "visibility": "HIDE",
    "youtube_link": "https://www.youtube.com/embed/EXAMPLE0002"
  }
]

Field	Type	Notes
`module`	string	Screen key the video belongs to.
`visibility`	string	"SHOW" turns the help-video button on.
`youtube_link`	string	Embed URL placed in the iframe (AppUtils.getYoutubeEmbedLink).

Errors

Status	When	What the app does
`non-2xx`	Server rejects the call or the dataset query fails (CoreAPI handles session refresh internally)	Exception caught and logged; buttons follow the previous cache.
`network error`	No connectivity or timeout	Exception caught and logged; buttons follow the previous cache.

Source

app/src/main/java/org/platformcommons/urvi/view/home/HomeViewModel.kt
app/src/main/java/org/platformcommons/urvi/utility/AppUtils.kt
app/src/main/java/org/platformcommons/urvi/datasource/network/responsedto/YoutubeVideoLinksDTO.kt