Forsta Panel API

openapi: 3.2.0
info:
  title: Forsta Panel API
  version: ''
  description: 'Operations tagged Panel across 2 of this provider''s published API definitions: forsta-panel-management-community-openapi.yml, forsta-panel-management-integration-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{server}
  description: Replace server with your instance domain.
  variables:
    server:
      default: staging.panel.dev.focusvision.com/
      description: Server domain
tags:
- name: Panel
paths:
  /api.pro#method=portal.panel.validateSource:
    post:
      operationId: portal.panel.validateSource
      summary: Validate sourceid for panelid
      description: Validate that the given sourceid is valid for the given panelid.
      tags:
      - Panel
      security: []
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.panel.validateSource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                panelid:
                  type: integer
                  description: The panelid in which the sourceid should be found.
                sourceid:
                  type: integer
                  description: The sourceid to be validated.
              required:
              - panelid
              - sourceid
            example:
              panelid: 1
              sourceid: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: The validation was successful.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                error-0:
                  description: Panel with supplied panel ID is not found.
                  summary: Panel not found
                  value:
                    success: false
                    error: Panel ID does not exist, or is currently inaccessible.
                    errno: '10000'
                error-1:
                  description: The supplied panel ID is not numeric.
                  summary: Panel ID invalid
                  value:
                    success: false
                    error: Panel ID is invalid
                    errno: '20101'
    servers:
    - url: https://{server}
      description: Replace server with your instance domain.
      variables:
        server:
          default: staging.panel.dev.focusvision.com/
          description: Server domain
  /api.pro#method=portal.panel.validateEmail:
    post:
      operationId: portal.panel.validateEmail
      summary: Validate the email into panelid
      description: Validate that the given email is valid for the given panelid.
      tags:
      - Panel
      security: []
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - portal.panel.validateEmail
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                panelid:
                  type: integer
                  description: The panelid in which the email address should be registered.
                email:
                  type: string
                  description: The email address to be validated.
              required:
              - panelid
              - email
            example:
              panelid: 1
              email: demo@example.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      type: boolean
                      description: The validation was successful.
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                error-0:
                  description: Panel with supplied panel ID is not found.
                  summary: Panel not found
                  value:
                    success: false
                    error: Panel ID does not exist, or is currently inaccessible.
                    errno: '10000'
                error-1:
                  description: The supplied email address is used by another panelist on the panel.
                  summary: Email duplicate
                  value:
                    success: false
                    error: The supplied email address is already in use
                    errno: '20002'
                error-2:
                  description: The supplied panel ID is not numeric.
                  summary: Panel ID invalid
                  value:
                    success: false
                    error: Panel ID is invalid
                    errno: '20101'
                error-3:
                  description: The supplied email is not a valid email address.
                  summary: Email invalid
                  value:
                    success: false
                    error: The supplied email address is invalid
                    errno: '20102'
    servers:
    - url: https://{server}
      description: Replace server with your instance domain.
      variables:
        server:
          default: staging.panel.dev.focusvision.com/
          description: Server domain
  /api.pro#method=integration.panel.select:
    post:
      operationId: panelSelect
      summary: Select current panel
      tags:
      - Panel
      security:
      - ApiKey: []
      parameters:
      - $ref: '#/components/parameters/method'
        schema:
          enum:
          - integration.panel.select
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - sesKey
              - panelid
              properties:
                sesKey:
                  description: A valid login hash.
                  type: string
                  example: 5a15852c564933807bbd36da58071063
                panelid:
                  description: The id of the panel to select..
                  type: integer
                  example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/error'
                - type: object
                  properties:
                    success:
                      example: true
                      type: boolean
              examples:
                success:
                  summary: Success
                  value:
                    success: true
                error-0:
                  description: The supplied panel ID is not numeric.
                  summary: Panel ID invalid
                  value:
                    success: false
                    error: Invalid panel id (panel ID)
                    errno: '20102'
                error-1:
                  description: Panel with supplied panel ID is not found.
                  summary: Panel not found
                  value:
                    success: false
                    error: Panel (panel ID) not found
                    errno: '20302'
                error-2:
                  description: Session has expired.
                  summary: Session expired
                  value:
                    success: false
                    error: Session has expired. You must start a new session.
                    errno: '30100'
                error-3:
                  description: Session is not found for supplied session key.
                  summary: Session not found
                  value:
                    success: false
                    error: sessionkey not found
                    errno: '30200'
                error-4:
                  description: User ID not found for supplied session key.
                  summary: Session not found
                  value:
                    success: false
                    error: userid for sessionkey not found
                    errno: '30200'
                error-5:
                  description: Session key is not in correct format.
                  summary: Session invalid
                  value:
                    success: false
                    error: sessionkey is invalid
                    errno: '30300'
    servers:
    - url: https://{server}
      description: Replace server with your instance domain.
      variables:
        server:
          default: staging.panel.dev.focusvision.com/
          description: Server domain
components:
  parameters:
    method:
      name: method
      in: query
      required: true
      description: Method
      schema:
        type: string
  schemas:
    error:
      type: object
      properties:
        success:
          type: boolean
        error:
          description: The error message.
          type: string
        errno:
          description: The error code.
          type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      in: query
      name: seskey
    BearerAuth:
      type: http
      scheme: bearer
x-refined-from:
- forsta-panel-management-community-openapi.yml
- forsta-panel-management-integration-openapi.yml
x-tagGroups:
- name: Autoclose
  tags:
  - Autoclose
- name: Data Input and Output
  tags:
  - Data
  - Data Feed
  - Response Summary
  - Modifying Data
  - Datasources
  - Datasources Data
  - Umerge
- name: Survey Metadata
  tags:
  - Simulated Data
  - Survey State
  - Survey Evaluate
  - Survey Quotas
  - Survey Files
  - Survey Warnings
  - Survey Terms
  - Survey Subscribers
  - Survey Users
  - Survey Tasks
- name: Panels
  tags:
  - Panel Data
  - Panel Datapoints
  - Survey Panels
- name: Research Hub
  tags:
  - Users
  - Companies
  - Categories
  - Surveys
  - Panels
  - Crosstabs
  - Archives
  - Archival Reports
  - API Keys
  - Usage
  - Warnings Summary
- name: Crosstabs
  tags:
  - Crosstabs Configuration
  - Crosstabs Execution
  - Crosstabs Nets
  - Saved Crosstabs
  - Crosstabs Table Settings
  - Crosstabs Validation
  - Crosstabs Rim Weighting
- name: Dashboards
  tags:
  - Dashboards
- name: DQ APIs
  tags:
  - DQ-Specific API Calls
  - MaxDiff API Calls
  - Discrete Choice Model API Calls
  - Media Testimonial API Calls
- name: Response Summary
  tags:
  - Share Link
- name: Sample Management
  tags:
  - Bounced Emails
  - Participant Sources
- name: Distribution
  tags:
  - Email Distribution
  - SFTP Distribution
  - Slack Distribution
- name: Campaign Manager
  tags:
  - Campaigns
  - Campaign Email Invites
  - Campaign Exports
  - Campaign Lists
  - Shared Campaign Lists
  - Campaign Sends
  - Campaign Status Lists
  - Supression Lists
- name: Question Library
  tags:
  - Company Element
  - Company Elements
  - Survey Elements
  - Survey Element Report Settings
- name: Language Manager
  tags:
  - LM Application Data
  - LM Application Translations
  - Translation Resources
  - Translations
  - Translation Deltas
  - Translation Reservations
  - Primary Survey Language
  - Other Survey Languages
  - Unused Survey Languages
- name: Project Parameters
  tags:
  - Available Project Parameters
  - Saved Project Parameters
  - Project Parameters Configuration
- name: Multi-User Editing
  tags:
  - Available Sections
  - Check Out Section
  - Check In Section
  - Sync Section
  - Section Editor
  - Abandon Section
  - Validate Section
- name: Video Management
  tags:
  - Videos
  - Watermarked Videos
- name: Miscellaneous
  tags:
  - System Information
  - Logic Nodes
  - Logic Events
  - CATI
  - Global Search
  - Miscellaneous