Panopto REST API Schemas

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Panopto REST API Schemas",
  "definitions": {
    "RemoteRecorderRegistrationResponse": {
      "allOf": [
        {
          "$ref": "#/definitions/APIError"
        },
        {
          "type": "object",
          "required": [
            "RemoteRecorderPublicId",
            "ClientKey"
          ],
          "properties": {
            "RemoteRecorderPublicId": {
              "type": "string",
              "format": "guid"
            },
            "ClientKey": {
              "type": "string",
              "format": "guid"
            },
            "ClientSecret": {
              "type": "string"
            }
          }
        }
      ]
    },
    "APIError": {
      "type": "object",
      "properties": {
        "Error": {
          "description": "Error result returned if an error occurs in Panopto, otherwise null or missing",
          "$ref": "#/definitions/APIErrorInternal"
        }
      }
    },
    "APIErrorInternal": {
      "type": "object",
      "required": [
        "Success"
      ],
      "properties": {
        "ErrorCode": {
          "type": "string",
          "description": "Internal error code"
        },
        "Message": {
          "type": "string"
        },
        "Success": {
          "type": "boolean",
          "description": "If true the call succeed and this is a partial failure (or warning). If false the call failed overall"
        },
        "ErrorSource": {
          "type": "string",
          "description": "Unique identifier of what caused this error"
        }
      }
    },
    "RemoteRecorderRegistrationRequest": {
      "type": "object",
      "properties": {
        "MachineUniqueIdentifier": {
          "type": "string",
          "description": "Static, non-changing value uniquely identifing this remote recorder"
        },
        "RecorderVersion": {
          "type": "string",
          "description": "Must be in the format of \"Vendor.Product.Major.Minor.Servicing\""
        },
        "RecorderBuild": {
          "type": "string",
          "description": "Vendor specfic build version. Format is up to the vendor but must be less than 255 characters"
        },
        "Capabilities": {
          "type": "array",
          "description": "Capabilities of this recorder. Options include: screencapture, slidecapture, highlightmousecursor, capturesystemaudio, 1080p, devicetemplates",
          "items": {
            "type": "string"
          }
        },
        "Description": {
          "type": "string",
          "description": "Description of this remote recorder - the name presented to users"
        }
      }
    },
    "RemoteRecorderHeartbeatResponse": {
      "allOf": [
        {
          "$ref": "#/definitions/APIError"
        },
        {
          "type": "object",
          "required": [
            "ScheduleVersion",
            "SettingsVersion",
            "PingInterval"
          ],
          "properties": {
            "ScheduleVersion": {
              "type": "string",
              "format": "guid"
            },
            "SettingsVersion": {
              "type": "string",
              "format": "guid"
            },
            "PingInterval": {
              "type": "integer",
              "format": "int32"
            },
            "Configuration": {
              "$ref": "#/definitions/RemoteRecorderConfiguration"
            },
            "RecordingSessionIsPaused": {
              "type": "boolean",
              "description": "Indicates whether the current recording (as per CurrentRecordingSessionId) is in a paused state. This parameter will not be emitted if no CurrentRecordingSessionId is provided."
            },
            "LiveMonitoring": {
              "description": "This is an object that tells the Remote Recorder how to perform live monitoring.  If null then the Remote Recorder\r\nshould NOT perform live monitoring.  This object has 2 fields:\r\n  \r\n'Mode': The type of live monitoring to perform.\r\n\r\n'Id': This is a string id.  If this string changes, then the Remote Recorder needs to shut down\r\n    its existing WebRTC session (if there is one) and negotiate a new one.",
              "$ref": "#/definitions/LiveMonitoringHeartbeatResponseData"
            },
            "DefaultFolder": {
              "type": "string",
              "format": "guid"
            },
            "DefaultPrimaryQualitySettings": {
              "$ref": "#/definitions/QualitySettings"
            },
            "DefaultSecondaryQualitySettings": {
              "$ref": "#/definitions/QualitySettings"
            },
            "ExtendedConfiguration": {
              "description": "Extended configuration for the client. The configuration is only returned if the client specified 'extendedConfigurations' in the request's included options.",
              "$ref": "#/definitions/RemoteRecorderExtendedConfiguration"
            }
          }
        }
      ]
    },
    "RemoteRecorderConfiguration": {
      "type": "object",
      "required": [
        "CaptureScreen",
        "CaptureSlides",
        "CaptureSystemAudio",
        "HighlightMouseCursor"
      ],
      "properties": {
        "PrimaryVideoDevice": {
          "type": "string"
        },
        "PrimaryAudioDevice": {
          "type": "string"
        },
        "DevicesToIgnore": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "DevicesToCapture": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "CaptureScreen": {
          "type": "boolean"
        },
        "CaptureSlides": {
          "type": "boolean"
        },
        "CaptureSystemAudio": {
          "type": "boolean"
        },
        "HighlightMouseCursor": {
          "type": "boolean"
        }
      }
    },
    "LiveMonitoringHeartbeatResponseData": {
      "type": "object",
      "required": [
        "Mode"
      ],
      "properties": {
        "Mode": {
          "$ref": "#/definitions/LiveMonitoringMode"
        },
        "Id": {
          "type": "string"
        }
      }
    },
    "LiveMonitoringMode": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Disabled",
        "WebRtcPrimaryAudio"
      ],
      "enum": [
        "Disabled",
        "WebRtcPrimaryAudio"
      ]
    },
    "QualitySettings": {
      "type": "object",
      "required": [
        "AudioBitrate",
        "Framerate",
        "MultipleBitrateCount",
        "PixelCount",
        "VideoBitrate"
      ],
      "properties": {
        "AudioBitrate": {
          "type": "integer",
          "format": "int32"
        },
        "Framerate": {
          "type": "integer",
          "format": "int32"
        },
        "MultipleBitrateCount": {
          "type": "integer",
          "format": "int32"
        },
        "PixelCount": {
          "type": "integer",
          "format": "int32"
        },
        "VideoBitrate": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "RemoteRecorderExtendedConfiguration": {
      "type": "object",
      "required": [
        "AudioHistogramModeType"
      ],
      "properties": {
        "SecondsToUseNextRecordingTemplate": {
          "type": "number",
          "description": "The number of seconds prior to the start of the next scheduled recording to apply the recording's template configurations.",
          "format": "double"
        },
        "SecondsToDeleteRecordingAfterUpload": {
          "type": "number",
          "description": "The number of seconds to retain the recording on the client after successful upload of the recording",
          "format": "double"
        },
        "ServerTime": {
          "type": "number",
          "description": "The server time in UTC file seconds",
          "format": "double"
        },
        "AudioHistogramModeType": {
          "description": "Preferred audio histogram type",
          "$ref": "#/definitions/RemoteRecorderAudioHistogramType"
        }
      }
    },
    "RemoteRecorderAudioHistogramType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Automatic",
        "AlwaysStereoHistograms",
        "AlwaysMonoHistograms"
      ],
      "enum": [
        "Automatic",
        "AlwaysStereoHistograms",
        "AlwaysMonoHistograms"
      ]
    },
    "RemoteRecorderHeartbeatData": {
      "type": "object",
      "required": [
        "State",
        "DiskSpaceFreeMegabytes",
        "LiveMonitoringBlocked"
      ],
      "properties": {
        "State": {
          "$ref": "#/definitions/RemoteRecorderState"
        },
        "DiskSpaceFreeMegabytes": {
          "type": "integer",
          "format": "int32"
        },
        "CurrentRecordingSessionId": {
          "type": "string",
          "format": "guid"
        },
        "ConnectedDevicesWithPreviews": {
          "type": "array",
          "description": "List of connected devices and available previews. If excluded or null, the list of connected devices will not be updated.",
          "items": {
            "$ref": "#/definitions/DeviceDescriptionWithPreview"
          }
        },
        "LiveMonitoringBlocked": {
          "type": "boolean",
          "description": "If supported, whether or not live audio monitoring is currently blocked."
        }
      }
    },
    "RemoteRecorderState": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Stopped",
        "Previewing",
        "Recording",
        "Paused",
        "Faulted",
        "Disconnected",
        "RecorderRunning"
      ],
      "enum": [
        "Stopped",
        "Previewing",
        "Recording",
        "Paused",
        "Faulted",
        "Disconnected",
        "RecorderRunning"
      ]
    },
    "DeviceDescriptionWithPreview": {
      "type": "object",
      "properties": {
        "Device": {
          "$ref": "#/definitions/Device"
        },
        "Preview": {
          "$ref": "#/definitions/RemoteRecorderDevicePreview"
        }
      }
    },
    "Device": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "DeviceId": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Type": {
          "$ref": "#/definitions/DeviceType"
        }
      }
    },
    "DeviceType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Unknown",
        "Audio",
        "Video",
        "AudioVideo"
      ],
      "enum": [
        "Unknown",
        "Audio",
        "Video",
        "AudioVideo"
      ]
    },
    "RemoteRecorderDevicePreview": {
      "type": "object",
      "required": [
        "AudioFormat",
        "VideoFormat"
      ],
      "properties": {
        "AudioFormat": {
          "$ref": "#/definitions/DeviceThumbnailFormat"
        },
        "AudioPreviewData": {
          "type": "string"
        },
        "VideoFormat": {
          "$ref": "#/definitions/DeviceThumbnailFormat"
        },
        "VideoPreviewData": {
          "type": "string"
        },
        "StreamID": {
          "type": "string",
          "format": "guid"
        }
      }
    },
    "DeviceThumbnailFormat": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "None",
        "AudioHist",
        "VideoJpeg",
        "AudioHist2Channel"
      ],
      "enum": [
        "None",
        "AudioHist",
        "VideoJpeg",
        "AudioHist2Channel"
      ]
    },
    "RemoteRecorderSchedule": {
      "allOf": [
        {
          "$ref": "#/definitions/APIError"
        },
        {
          "type": "object",
          "required": [
            "ScheduleId",
            "ServerTime"
          ],
          "properties": {
            "ScheduleId": {
              "type": "string",
              "format": "guid"
            },
            "ServerTime": {
              "type": "number",
              "format": "double"
            },
            "Recordings": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/RemoteRecorderScheduledRecording"
              }
            }
          }
        }
      ]
    },
    "RemoteRecorderScheduledRecording": {
      "type": "object",
      "required": [
        "SessionId",
        "FolderId",
        "StartTime",
        "EndTime",
        "IsBroadcast",
        "SuppressPrimaryDevices",
        "SuppressSecondaryDevices"
      ],
      "properties": {
        "Id": {
          "type": "string",
          "format": "guid"
        },
        "SessionId": {
          "type": "string",
          "format": "guid"
        },
        "SessionName": {
          "type": "string"
        },
        "FolderId": {
          "type": "string",
          "format": "guid"
        },
        "FolderName": {
          "type": "string"
        },
        "UserId": {
          "type": "string",
          "format": "guid"
        },
        "StartTime": {
          "type": "number",
          "format": "double"
        },
        "EndTime": {
          "type": "number",
          "format": "double"
        },
        "IsBroadcast": {
          "type": "boolean"
        },
        "SuppressPrimaryDevices": {
          "type": "boolean"
        },
        "SuppressSecondaryDevices": {
          "type": "boolean"
        },
        "PrimaryQualitySettings": {
          "$ref": "#/definitions/QualitySettings"
        },
        "SecondaryQualitySettings": {
          "$ref": "#/definitions/QualitySettings"
        },
        "Configuration": {
          "$ref": "#/definitions/RemoteRecorderConfiguration"
        }
      }
    },
    "RemoteRecorderError": {
      "type": "object",
      "required": [
        "Severity",
        "ErrorType",
        "ErrorCode"
      ],
      "properties": {
        "Severity": {
          "description": "Error severity, must be a value other than Invalid",
          "$ref": "#/definitions/RemoteRecorderErrorSeverity"
        },
        "ErrorType": {
          "description": "Error category, must be a value other than Invalid",
          "$ref": "#/definitions/RemoteRecorderErrorType"
        },
        "ErrorCode": {
          "type": "integer",
          "description": "Vendor-specific error code",
          "format": "int32"
        },
        "Message": {
          "type": "string",
          "description": "Error message with a maximum length of 250 characters"
        },
        "AssociatedSessionId": {
          "type": "string",
          "description": "If this error is associated with a session, which session",
          "format": "guid"
        }
      }
    },
    "RemoteRecorderErrorSeverity": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Invalid",
        "Critical",
        "Error",
        "Warning"
      ],
      "enum": [
        "Invalid",
        "Critical",
        "Error",
        "Warning"
      ]
    },
    "RemoteRecorderErrorType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Invalid",
        "General",
        "Device",
        "Network",
        "Storage"
      ],
      "enum": [
        "Invalid",
        "General",
        "Device",
        "Network",
        "Storage"
      ]
    },
    "RemoteRecorderPauseRecordingRequest": {
      "type": "object",
      "required": [
        "PauseRecordingTime"
      ],
      "properties": {
        "PauseRecordingTime": {
          "type": "number",
          "description": "Pause recording time in UTC file time seconds",
          "format": "double"
        }
      }
    },
    "RemoteRecorderResumeRecordingRequest": {
      "type": "object",
      "required": [
        "ResumeRecordingTime"
      ],
      "properties": {
        "ResumeRecordingTime": {
          "type": "number",
          "description": "Resume recording time in UTC file time seconds",
          "format": "double"
        }
      }
    },
    "RemoteRecorderURLsUpdateRequest": {
      "type": "object",
      "properties": {
        "URLs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RemoteRecorderURL"
          }
        }
      }
    },
    "RemoteRecorderURL": {
      "type": "object",
      "required": [
        "URLType"
      ],
      "properties": {
        "URLType": {
          "$ref": "#/definitions/RemoteRecorderURLType"
        },
        "URL": {
          "type": "string",
          "description": "Must be a well formed URL"
        }
      }
    },
    "RemoteRecorderURLType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Management",
        "PrimaryPreview",
        "SecondaryPreview",
        "Support",
        "SecondaryPreview2",
        "SecondaryPreview3",
        "SecondaryPreview4"
      ],
      "enum": [
        "Management",
        "PrimaryPreview",
        "SecondaryPreview",
        "Support",
        "SecondaryPreview2",
        "SecondaryPreview3",
        "SecondaryPreview4"
      ]
    },
    "WebRtcConnectPostData": {
      "type": "object",
      "required": [
        "OperationType"
      ],
      "properties": {
        "OperationType": {
          "$ref": "#/definitions/WebRtcConnectOperationType"
        }
      }
    },
    "WebRtcConnectOperationType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Unknown",
        "Initialize"
      ],
      "enum": [
        "Unknown",
        "Initialize"
      ]
    },
    "WebRtcDisconnectPostData": {
      "type": "object",
      "required": [
        "OperationType"
      ],
      "properties": {
        "OperationType": {
          "description": "The type of operation.",
          "$ref": "#/definitions/WebRtcDisconnectOperationType"
        }
      }
    },
    "WebRtcDisconnectOperationType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Unknown",
        "Destroy"
      ],
      "enum": [
        "Unknown",
        "Destroy"
      ]
    },
    "WebRtcEventsResponse": {
      "allOf": [
        {
          "$ref": "#/definitions/APIError"
        },
        {
          "type": "object",
          "required": [
            "PingFastInterval",
            "PingSlowInterval"
          ],
          "properties": {
            "Events": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/WebRtcEvent"
              }
            },
            "PingFastInterval": {
              "type": "integer",
              "format": "int32"
            },
            "PingSlowInterval": {
              "type": "integer",
              "format": "int32"
            }
          }
        }
      ]
    },
    "WebRtcEvent": {
      "type": "object",
      "required": [
        "EventType"
      ],
      "properties": {
        "EventType": {
          "$ref": "#/definitions/WebRtcEventType"
        },
        "Payload": {
          "type": "string"
        }
      }
    },
    "WebRtcEventType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Unknown",
        "IceCandidate",
        "SdpAnswer",
        "TemporaryFailure",
        "PermanentFailure"
      ],
      "enum": [
        "Unknown",
        "IceCandidate",
        "SdpAnswer",
        "TemporaryFailure",
        "PermanentFailure"
      ]
    },
    "WebRtcIceCandidates": {
      "type": "object",
      "properties": {
        "Candidates": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WebRtcIceCandidate"
          }
        }
      }
    },
    "WebRtcIceCandidate": {
      "type": "object",
      "required": [
        "Index"
      ],
      "properties": {
        "Candidate": {
          "type": "string"
        },
        "Index": {
          "type": "integer"
        }
      }
    },
    "WebRtcSdpOfferPostData": {
      "type": "object",
      "properties": {
        "SessionDescription": {
          "type": "string",
          "description": "The session description document, as defined by the Session Description Protocol (SDP) standard."
        }
      }
    },
    "AccessibilityBulkPreviewResponse": {
      "type": "object",
      "required": [
        "Type",
        "SiteOverwriteBehavior"
      ],
      "properties": {
        "Type": {
          "description": "The normalized accessibility type: AudioDescription, Transcription, or Translation.",
          "$ref": "#/definitions/AccessibilityRequestType"
        },
        "SiteOverwriteBehavior": {
          "description": "The site-level overwrite behavior. For AudioDescription: DoNotOverwrite or Overwrite. For Transcription/Translation: DoNotOverwrite, OverwriteASR, or OverwriteAny.",
          "$ref": "#/definitions/AccessibilityOverwriteBehavior"
        },
        "AvailableCaptionCredits": {
          "type": "number",
          "description": "Remaining caption credits for the active transcription contract. Null when no finite credit pool applies (no active contract, or unlimited credits). Zero means the contract's finite pool has been fully consumed.",
          "format": "double"
        },
        "Providers": {
          "type": "array",
          "description": "Available providers for the requested type, with display names and pricing metadata.",
          "items": {
            "$ref": "#/definitions/AccessibilityProviderPreview"
          }
        },
        "SessionEvaluations": {
          "type": "array",
          "description": "Per-session eligibility evaluation results.",
          "items": {
            "$ref": "#/definitions/AccessibilitySessionPreview"
          }
        },
        "Summary": {
          "description": "Aggregate counts of eligible, conditionally eligible, and excluded sessions with total duration.",
          "$ref": "#/definitions/AccessibilityPreviewSummary"
        }
      }
    },
    "AccessibilityRequestType": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "AudioDescription",
        "Transcription",
        "Translation"
      ],
      "enum": [
        "AudioDescription",
        "Transcription",
        "Translation"
      ]
    },
    "AccessibilityOverwriteBehavior": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "DoNotOverwrite",
        "OverwriteAD",
        "OverwriteASR",
        "OverwriteAnyCaptions"
      ],
      "enum": [
        "DoNotOverwrite",
        "OverwriteAD",
        "OverwriteASR",
        "OverwriteAnyCaptions"
      ]
    },
    "AccessibilityProviderPreview": {
      "type": "object",
      "required": [
        "ProviderInstanceId",
        "PriceKnown"
      ],
      "properties": {
        "ProviderInstanceId": {
          "type": "integer",
          "description": "Provider instance identifier, used when scheduling an accessibility request.",
          "format": "int32"
        },
        "DisplayName": {
          "type": "string",
          "description": "Display name of the provider (e.g. \"Captions Service\")."
        },
        "PricePerMinute": {
          "type": "number",
          "description": "Price per minute in caption credits. Null when pricing is not applicable.",
          "format": "double"
        },
        "PriceKnown": {
          "type": "boolean",
          "description": "Whether the price is known."
        }
      }
    },
    "AccessibilitySessionPreview": {
      "type": "object",
      "required": [
        "SessionId",
        "DurationSeconds",
        "EligibilityState",
        "ReasonCode"
      ],
      "properties": {
        "SessionId": {
          "type": "string",
          "description": "The public ID of the evaluated session.",
          "format": "guid"
        },
        "SessionName": {
          "type": "string",
          "description": "The display name of the session. Null if the session was not found."
        },
        "DurationSeconds": {
          "type": "number",
          "description": "Total duration in seconds of the session's streams. Zero if the session was not found or has no primary streams.",
          "format": "double"
        },
        "EligibilityState": {
          "description": "The eligibility classification: Eligible, ConditionallyEligible, or Excluded.",
          "$ref": "#/definitions/EligibilityState"
        },
        "ReasonCode": {
          "description": "The reason the session is not fully eligible. None when EligibilityState is Eligible.",
          "$ref": "#/definitions/ExclusionReason"
        },
        "Details": {
          "description": "Translation-specific details (source languages, existing captions, pending translations). Null for AudioDescription and Transcription types.",
          "$ref": "#/definitions/TranslationDetails"
        }
      }
    },
    "EligibilityState": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Eligible",
        "ConditionallyEligible",
        "Excluded"
      ],
      "enum": [
        "Eligible",
        "ConditionallyEligible",
        "Excluded"
      ]
    },
    "ExclusionReason": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "None",
        "NotFound",
        "InsufficientPermissions",
        "InvalidTranscriptionRequestType",
        "NoActiveDelivery",
        "NoPrimaryStream",
        "PendingEdits",
        "PendingRequest",
        "UnsupportedLanguage",
        "AlreadyHasAudioDescription",
        "AlreadyHasCaptions",
        "AlreadyHasAsrCaptions",
        "NoSourceCaptions",
        "SchedulingFailed"
      ],
      "enum": [
        "None",
        "NotFound",
        "InsufficientPermissions",
        "InvalidTranscriptionRequestType",
        "NoActiveDelivery",
        "NoPrimaryStream",
        "PendingEdits",
        "PendingRequest",
        "UnsupportedLanguage",
        "AlreadyHasAudioDescription",
        "AlreadyHasCaptions",
        "AlreadyHasAsrCaptions",
        "NoSourceCaptions",
        "SchedulingFailed"
      ]
    },
    "TranslationDetails": {
      "type": "object",
      "properties": {
        "AvailableSourceLanguages": {
          "type": "array",
          "description": "Caption languages available as a translation source. Only non-translated captions are included.",
          "items": {
            "$ref": "#/definitions/ContentLanguage"
          }
        },
        "ExistingCaptionLanguages": {
          "type": "array",
          "description": "All caption languages that already exist on the delivery, useful for identifying redundant translation targets.",
          "items": {
            "$ref": "#/definitions/ContentLanguage"
          }
        },
        "PendingTranslationTargets": {
          "type": "array",
          "description": "Target languages with in-flight translation requests, useful for preventing duplicate requests.",
          "items": {
            "$ref": "#/definitions/ContentLanguage"
          }
        }
      }
    },
    "ContentLanguage": {
      "type": "string",
      "description": "Language of content such as sessions, streams, or captions.",
      "x-enumNames": [
        "English_USA",
        "English_GBR",
        "Spanish_MEX",
        "Spanish_ESP",
        "German",
        "French",
        "Dutch",
        "Thai",
        "Chinese_Simplified",
        "Chinese_Traditional",
        "Korean",
        "Japanese",
        "Russian",
        "Portuguese",
        "Polish",
        "English_AUS",
        "Danish",
        "Finnish",
        "Hungarian",
        "Norwegian",
        "Swedish",
        "Italian",
        "Welsh",
        "Catalan",
        "Galician",
        "Basque",
        "Arabic",
        "Hindi",
        "French_CAN",
        "Hebrew",
        "Vietnamese"
      ],
      "enum": [
        "English_USA",
        "English_GBR",
        "Spanish_MEX",
        "Spanish_ESP",
        "German",
        "French",
        "Dutch",
        "Thai",
        "Chinese_Simplified",
        "Chinese_Traditional",
        "Korean",
        "Japanese",
        "Russian",
        "Portuguese",
        "Polish",
        "English_AUS",
        "Danish",
        "Finnish",
        "Hungarian",
        "Norwegian",
        "Swedish",
        "Italian",
        "Welsh",
        "Catalan",
        "Galician",
        "Basque",
        "Arabic",
        "Hindi",
        "French_CAN",
        "Hebrew",
        "Vietnamese"
      ]
    },
    "AccessibilityPreviewSummary": {
      "type": "object",
      "required": [
        "TotalSessions",
        "EligibleCount",
        "ConditionallyEligibleCount",
        "ExcludedCount",
        "TotalDurationSeconds"
      ],
      "properties": {
        "TotalSessions": {
          "type": "integer",
          "description": "Total number of sessions evaluated (after de-duplication).",
          "format": "int32"
        },
        "EligibleCount": {
          "type": "integer",
          "description": "Number of sessions that are fully eligible and included by default.",
          "format": "int32"
        },
        "ConditionallyEligibleCount": {
          "type": "integer",
          "description": "Number of sessions excluded by default but eligible if the user opts in (e.g. overwrite existing content).",
          "format": "int32"
        },
        "ExcludedCount": {
          "type": "integer",
          "description": "Number of sessions that cannot be included in the request.",
          "format": "int32"
        },
        "TotalDurationSeconds": {
          "type": "number",
          "description": "Total duration of all evaluated sessions in seconds.",
          "format": "double"
        }
      }
    },
    "AccessibilityBulkPreviewRequest": {
      "type": "object",
      "required": [
        "Type"
      ],
      "properties": {
        "Type": {
          "description": "The accessibility request type: AudioDescription, Transcription, or Translation.",
          "$ref": "#/definitions/AccessibilityRequestType"
        },
        "SessionIds": {
          "type": "array",
          "description": "List of session or delivery public IDs (GUIDs) to evaluate. Duplicates are de-duplicated. Maximum 100 IDs.",
          "items": {
            "type": "string",
            "format": "guid"
          }
        }
      }
    },
    "AccessibilityBulkScheduleResponse": {
      "type": "object",
      "required": [
        "Type",
        "ScheduledCount",
        "SkippedCount"
      ],
      "properties": {
        "Type": {
          "description": "The accessibility request type that was scheduled.",
          "$ref": "#/definitions/AccessibilityRequestType"
        },
        "Results": {
          "type": "array",
          "description": "Per-session scheduling outcomes.",
          "items": {
            "$ref": "#/definitions/AccessibilityScheduleResult"
          }
        },
        "ScheduledCount": {
          "type": "integer",
          "description": "Number of sessions that were successfully scheduled.",
          "format": "int32"
        },
        "SkippedCount": {
          "type": "integer",
          "description": "Number of sessions that were skipped.",
          "format": "int32"
        }
      }
    },
    "AccessibilityScheduleResult": {
      "type": "object",
      "required": [
        "SessionId",
        "Scheduled",
        "ReasonCode",
        "RequestCount"
      ],
      "properties": {
        "SessionId": {
          "type": "string",
          "description": "The public ID of the session.",
          "format": "guid"
        },
        "SessionName": {
          "type": "string",
          "description": "The display name of the session. Null if the session was not found."
        },
        "Scheduled": {
          "type": "boolean",
          "description": "Whether accessibility requests were created for this session."
        },
        "ReasonCode": {
          "description": "The reason the session was skipped. None when Scheduled is true.",
          "$ref": "#/definitions/ExclusionReason"
        },
        "RequestCount": {
          "type": "integer",
          "description": "Number of transcription requests created for this session.",
          "format": "int32"
        }
      }
    },
    "AccessibilityBulkScheduleRequest": {
      "type": "object",
      "required": [
        "Type",
        "ProviderInstanceId"
      ],
      "properties": {
        "Type": {
          "description": "The accessibility reque

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/panopto/refs/heads/main/json-schema/panopto-rest-api.json