Hello,

I'm trying to figure out where all relevant details are described regarding the SOAP API.

Fortunately I received some example code regarding the endpoint GetSessionDetailedUsage, see https://community.panopto.com/discussion/2016/using-getsessiondetailedusage-and-getsessionextendeddetailedusage-with-python-3

But now I need different endpoints, such as session duration of all sessions in a folder. This page shows some details regarding a single session: https://support.panopto.com/resource/APIDocumentation/Help/html/29a5f264-d2e4-2572-1270-6678d1ef3ba8.htm#!

But I can't find related details such as:

• the required attributes and elements of the body
• the relevant request url in the envelope
• the correct xmlns:pan url in the envelope
• what "tem:" is needed to identify e.g. Session.Duration?
• the correct url for SoapAction in the header

So here are some questions I have:

• Where can I find the details mentioned above, also for other endpoints (e.g. for extracting details on how sessions are organized in folders)?
• What method (SOAP, REST) and which version has the long term commitment by Panopto? It would be great to need to use just one method (I prefer REST, but GetSessionDetailedUsage is only available with SOAP it seems)
• Is there a python 3 version available of this? https://github.com/Panopto/python-soap

Any help for me to make sense of this would be great!

Thanks,

Jaap.

Hi Jaap,

You are right, those endpoint are SOAP API endpoints and you will need to use SOAP format in order to get your needed responses.

I will add here examples how you can try to get responses using Python requests and http.client libs:

GetSessionDetailedUsage

Python requests:

import requests

url = "https://***.panopto.com/Panopto/PublicAPI/4.0/UsageReporting.svc"
payload = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n    <s:Body>\r\n        <GetSessionDetailedUsage xmlns=\"http://tempuri.org/\">\r\n            <auth xmlns:a=\"http://schemas.datacontract.org/2004/07/Panopto.Server.Services.PublicAPI.V40\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">                \r\n                <a:Password>{PANOPTO USER PASSWORD}</a:Password>\r\n                <a:UserKey>{PANOPTO USERNAME}</a:UserKey>\r\n            </auth>\r\n            <sessionId>{SESSION PUBLIC ID e.g 79172b62-3027-4c57-be26-ae9b00c665c8}</sessionId>          \r\n            <beginRange>2018-01-01</beginRange>\r\n            <endRange>2023-12-31</endRange>\r\n        </GetSessionDetailedUsage>\r\n    </s:Body>\r\n</s:Envelope>"
headers = {
  'Content-Type': 'text/xml; charset=utf-8',
  'SoapAction': 'http://tempuri.org/IUsageReporting/GetSessionDetailedUsage'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

Python http.client

import http.client

conn = http.client.HTTPSConnection("***.panopto.com")
payload = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n    <s:Body>\r\n        <GetSessionDetailedUsage xmlns=\"http://tempuri.org/\">\r\n            <auth xmlns:a=\"http://schemas.datacontract.org/2004/07/Panopto.Server.Services.PublicAPI.V40\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">                \r\n                <a:Password>{PANOPTO USER PASSWORD}</a:Password>\r\n                <a:UserKey>{PANOPTO USERNAME}</a:UserKey>\r\n            </auth>\r\n            <sessionId>{SESSION PUBLIC ID e.g 79172b62-3027-4c57-be26-ae9b00c665c8}</sessionId>          \r\n            <beginRange>2018-01-01</beginRange>\r\n            <endRange>2023-12-31</endRange>\r\n        </GetSessionDetailedUsage>\r\n    </s:Body>\r\n</s:Envelope>"
headers = {
  'Content-Type': 'text/xml; charset=utf-8',
  'SoapAction': 'http://tempuri.org/IUsageReporting/GetSessionDetailedUsage'
}
conn.request("POST", "/Panopto/PublicAPI/4.0/UsageReporting.svc", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

GetSessionExtendedDetailedUsage

Python requests:

import requests

url = "https://***.panopto.com/Panopto/PublicAPI/4.0/UsageReporting.svc"
payload = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n    <s:Body>\r\n        <GetSessionExtendedDetailedUsage xmlns=\"http://tempuri.org/\">\r\n            <auth xmlns:a=\"http://schemas.datacontract.org/2004/07/Panopto.Server.Services.PublicAPI.V40\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">                \r\n                <a:Password>{PANOPTO PASSWORD}</a:Password>\r\n                <a:UserKey>{PANOPTO USERNAME}</a:UserKey>\r\n            </auth>\r\n            <sessionId>{SESSION PUBLIC ID e.g 79172b62-3027-4c57-be26-ae9b00c665c8}</sessionId>         \r\n            <beginRange>2018-01-01</beginRange>\r\n            <endRange>2023-12-31</endRange>\r\n        </GetSessionExtendedDetailedUsage>\r\n    </s:Body>\r\n</s:Envelope>"
headers = {
  'Content-Type': 'text/xml; charset=utf-8',
  'SoapAction': 'http://tempuri.org/IUsageReporting/GetSessionExtendedDetailedUsage'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

Python http.client

import http.client

conn = http.client.HTTPSConnection("***.panopto.com")
payload = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n    <s:Body>\r\n        <GetSessionExtendedDetailedUsage xmlns=\"http://tempuri.org/\">\r\n            <auth xmlns:a=\"http://schemas.datacontract.org/2004/07/Panopto.Server.Services.PublicAPI.V40\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">                \r\n                <a:Password>{PANOPTO USER PASSWORD}</a:Password>\r\n                <a:UserKey>{PANOPTO USERNAME}</a:UserKey>\r\n            </auth>\r\n            <sessionId>{SESSION PUBLIC ID e.g 79172b62-3027-4c57-be26-ae9b00c665c8}</sessionId>         \r\n            <beginRange>2018-01-01</beginRange>\r\n            <endRange>2023-12-31</endRange>\r\n        </GetSessionExtendedDetailedUsage>\r\n    </s:Body>\r\n</s:Envelope>"
headers = {
  'Content-Type': 'text/xml; charset=utf-8',
  'SoapAction': 'http://tempuri.org/IUsageReporting/GetSessionExtendedDetailedUsage'
}
conn.request("POST", "/Panopto/PublicAPI/4.0/UsageReporting.svc", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

I hope examples will help you! Please let us know if you have additional questions.

Kind regards,

Panopto team.