OpenAPI Specification
swagger: '2.0'
info:
title: Panopto Public Accessibility Groups API
description: The public API for Panopto. OpenID & OAuth information can be found at Panopto/oauth2/.well-known/openid-configuration
version: '1'
host: <PanoptoServerURL>(i.e. example.hosted.panopto.com)
basePath: /Panopto
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Groups
description: Group API
paths:
/api/v1/groups/search:
get:
tags:
- Groups
summary: Search for groups based on a keyword
operationId: Groups_Search
parameters:
- type: string
name: searchQuery
in: query
required: true
x-nullable: true
responses:
'200':
x-nullable: false
description: ''
schema:
$ref: '#/definitions/ListResponseOfGroup'
'400':
x-nullable: false
description: ''
schema:
$ref: '#/definitions/APIError'
'403':
description: User does not have permission to access this function
'401':
description: The user is not authorized to perform the requested action
definitions:
Group:
allOf:
- $ref: '#/definitions/ModelBaseOfGuid'
- type: object
ModelBaseOfGuid:
type: object
properties:
Id:
type: string
format: guid
Name:
type: string
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
APIError:
type: object
properties:
Error:
description: Error result returned if an error occurs in Panopto, otherwise null or missing
$ref: '#/definitions/APIErrorInternal'
ListResponseOfGroup:
type: object
properties:
Results:
type: array
description: The list of results from the API call
items:
$ref: '#/definitions/Group'
x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))