Welcome to the Panopto Community

Please note: All new registrants to the Panopto Community Forum must be approved by a forum moderator or admin. As such, if you navigate to a feature that is members-only, you may receive an error page if your registration has not yet been approved. We apologize for any inconvenience and are approving new members as quickly as possible.
Options

the Soap API for linking publication periods

sakae uchiborisakae uchibori Tyro
in API

Hello.
I have three questions about the Soap API for linking public periods.
Please elaborate.

Q1. the Soap API for linking publication periods
I understand that the “sessionIds” that need to be specified in “UpdateSessionsAvailabilityStartSettings” and ‘UpdateSessionsAvailabilityEndSettings’ is the “delivery ID” displayed in the video settings > administration screen. Is this correct?

Q2: Can the "delivery ID" in Q1 above be obtained from the "deep linking response"?

Q3: If Q2 above cannot be obtained, please tell us how to obtain a unique “delivery ID”.

Regarding the last Q3, we have confirmed that it is possible to retrieve it by specifying the video name in “GetSessionsList,” which is different from the API in Q1, but it is not uniquely identifiable.
Even if using “GetSessionsList” is the best way, we would appreciate it if you could tell us how to obtain a unique “delivery ID”.

Thank you.

Q3 Questions.png

Best Answer

  • Adis HrnjicaAdis Hrnjica Whiz Kid
    Answer ✓

    Hi Sakae,

    I think in your case the best we can do is filtering. I cannot think of anything else we could use at the moment, since you have folders with a lot of sessions with the same name. If you cannot get unique with the filtering, I think there is no other way at the moment.

    Thanks,

    Adis

Answers

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Sakae,

    A1: Yes, we use deliveryID.
    A2: Yes, deep linking responses should include delivery IDs.
    A3: The A2 should solve this.

    But if you still need this and you have sessions with the same name, maybe you can do it based on the folder.
    If it is the same folder, then we can try to use time based identification if possible, using start/end time.

    I hope this helps.

    Thanks,

    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,

    I have an additional question.
    I need some urgent information.

    I would like to know how to get the delivery ID from deep linking response.
    Please share if you have any public information or documentation anywhere.

    Thank you.

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Sakae,

    Can you let me know your exact process. Which API calls you use, and how that flow goes?
    Then we can determine the best path to take to suit your needs.

    Thanks,

    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,

    I want to control the publication period of videos with API. We are wondering if the following could be done.
    If the API is wrong, please let me know the correct one.

    1. Get “sessionIds” of the videos to be linked to the publication period.
      "GetSessionsList"
    2. Set "sessionIds" and link the public period to the Panopto video.
      "UpdateSessionsAvailabilityStartSettings"
      "UpdateSessionsAvailabilityEndSettings"

    Thank you.

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    HI Sakae,

    Your workflow should work perfectly.

    Notes:

    1. The user calling these APIs must have creator or system admin permissions
    2. The sessionIds parameter actually expects delivery IDs, not session IDs
    3. Setting availability affects when viewers can access the content
    4. You can apply settings to multiple videos at once by including multiple GUIDs in the sessionIds array

    I hope this helps.

    Thanks,

    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,

    The Soap API (GetSessionsList) returns a “delivery ID” that matches the video name set as a parameter, but if there are multiple identical video names (including partial matches), multiple “delivery IDs” are also returned.
    I cannot get a unique “delivery ID” and cannot identify the target of the collaboration for the period of publication, is there any way?
    The contents are shown in the diagram at the top.

    Thank you.

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Sakae,

    Can you use additional filter such as Folder ID + Video Name or Creation Date Range?

    Thanks,

    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,


    Thanks for everything.

    Am I correct in assuming that I can get a unique “delivery ID” by using the folder ID + additional filters such as video name or creation date range?
    Also, I would like to know how to get the delivery ID from the deep link response, is there a specific way to get it, a sample, or a public document?

    Thank you.

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Sakae,

    I think yes, if you use combination it should give you unique delivery ID.
    Can you give me more information so I know which deep link response you are using?

    Thanks,
    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,

    You asked us to include the delivery ID in the deep linking response, but can you tell us which claim to include the delivery ID in the deep linking response?

    Can you tell me how to get the “folder ID” and “creation date” through the LTI linkage?
    However, even if we could add these filters, I believe there could be cases where the creation date, folder ID, and video name are the same (not unique).

    The following values are acquired in the deep linking response when selecting videos.
    title: The name of the video is acquired.
    Context_delivery: The following values are acquired for use during video playback.

    Let me rearrange what I want to do. I want to use the API to control the video release period. I would like to know how to execute this successfully.
    I would like to have these specific samples.
    If you are Adis, please let me know what API to use and how to do it.

    Thank you.

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Sakae,

    I thought you were referring to something else re: deep linking response.
    You cannot directly obtain the Panopto "delivery ID" from the context_delivery claim in the LTI deep linking response. The context_delivery is an LTI-specific identifier, not the internal Panopto session ID/delivery ID.

    Unfortunately with the current API capabilities we can only do this filtering to get the unique delivery ID.

    I think you can still try this approach and see how it goes.

    Let me know if there is anything else.

    Thanks,

    Adis

  • sakae uchiborisakae uchibori Tyro

    Hi Adis,

    I received the answer to the top question on June 9, is the answer below correct?

    Answer to Q1: “sessionIds” is correct for the “delivery ID” of the video.
    Answer to Q2: Cannot be obtained from “deep linking response”.
    Answer to Q3: With the current API functionality, it is not possible to obtain a unique delivery ID even with this filtering.
    Does this mean that if there are multiple identical video names, there is no way to identify the unique video?

    Is there an API to identify unique videos?

    Thank you.

Sign In or Register to comment.