Welcome to the Panopto Community

Toggle "IsBroadcast" for a scheduled recording (2019-08-27)

Cait McCabeCait McCabe Administrator
edited February 2020 in API

Original Post: Jay Luker, August 27, 2019 at 10:54 AM

I would like to use the REST api to enable/disable the "IsBroadcast" setting for a set of scheduled recordings. (Am I correct this is also sometimes called "webcast"?)

It looks like a POST to /api/v1/remoteRecorderAPI/remoteRecorder/{remoteRecorderPublicId}/schedule is maybe what I need? But I'm not clear what information needs to be sent via the json payload.

The example payload shown at https://demo.hosted.panopto.com/Panopto/Api/Docs/index.html has both an "Id" and a "SessionId" value, while each scheduled recording has both a session id and something called a delivery id. Assuming I get the correct id I would hope to be able to use something like:

{

"SessionId": "[the id]",

"IsBroadcast": "true|false"

}

Is that the basic idea? Will this work? I'm simultaneously having some permission issues, so I'm unable to tell if I'm using the right payload.

Thanks!

Responses

Mark Brewsala, Moderator, September 3, 2019 at 3:25 PM

Hello Jay,

To answer your questions about the Id versus the SessionId: the Id is the Id of the scheduled recording, which is a distinct entity from the session that the schedule manages creating. When you create a new scheduled recording, that Id as well as the id of the session (sessionId) will be returned in the response.

At present, the REST API doesn't support updating the IsBroadcast flag on an existing scheduled recording. That value in the request payload is only respected on creating a new recording. The server distinguishes whether the request is about a new scheduled recording or an existing scheduled recording based on the absence or the presence, respectively, of the Id in the request payload. (In fact, the sessionId is totally ignored in requests since it is generated only by the server.)

The legacy SOAP API does support updating the broadcast status of a scheduled recording with the UpdateSessionIsBroadcast method: https://support.panopto.com/resource/APIDocumentation/Help/html/03739ef2-f699-d1e0-e489-824300ddc070.htm

As with all SOAP functionality, we plan to eventually support this functionality in REST but the timeline for feature parity remains open. Please coordinate with your customer success representative to help identify which functionality should be prioritized by development to unblock your desired workflows.

Thanks,

Mark

Tagged:
Sign In or Register to comment.