MRI Software Custom questions API

openapi: 3.2.0
info:
  title: Mri Software Custom questions API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Custom questions across 2 of this provider''s published API definitions: mri-software-onlocation-openapi.json, mri-software-onlocation-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.whosonlocation.com/v1
tags:
- name: Custom questions
  description: 'A custom questionnaire is made up of a set of custom questions. Use the API to list all custom questions created for your organization. View details including the question type (eg multi-choice, waiver, date picker) and the settings (eg if it''s mandatory, if answer share is enabled, and who set it up).


    Learn more about custom questions in the OnLocation Help Center.'
paths:
  /custom-questionnaire/question:
    get:
      tags:
      - Custom questions
      summary: List all custom questions
      description: 'Returns a list of all custom questions. The endpoint is limited to a maximum of 5,000 records.


        A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.'
      operationId: getCustomQuestionnaireQuestionList
      parameters:
      - name: q
        in: query
        description: Filter by any custom questionnaire question value.
        required: false
        schema:
          type: string
          format: string
        example: '498'
      - name: order
        in: query
        description: Specifies an element to order by. To order in reverse order, prepend the element with '-'.
        required: false
        schema:
          type: string
          format: string
        example: id
      - name: limit
        in: query
        description: Limits the amount of records to return
        required: false
        schema:
          type: integer
          format: int32
        example: '10'
      - name: page
        in: query
        description: Specifies which page of results to return, most effective when used together with the 'limit' parameter
        required: false
        schema:
          type: integer
          format: int32
      - name: If-Modified-Since
        in: header
        description: A UTC timestamp (yyyy-mm-ddThh:mm:ss). Only entities created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
        required: false
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: List of custom questions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomQuestionnaireQuestionResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomQuestionnaireQuestionResponse'
        '403':
          description: Access denied to this resource
        '404':
          description: Resource not found
    servers:
    - url: https://api.whosonlocation.com/v1
  /custom-questionnaire/question/{id}:
    get:
      tags:
      - Custom questions
      summary: Retrieve a custom question
      description: Returns a custom question record filtered by the provided ID.
      operationId: getCustomQuestionnaireQuestion
      parameters:
      - name: id
        in: path
        description: ID of the question record to look for
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The custom question record matching the passed in ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomQuestionnaireQuestionResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomQuestionnaireQuestionResponse'
        '403':
          description: Access denied to this resource.
        '404':
          description: Resource not found.
    servers:
    - url: https://api.whosonlocation.com/v1
components:
  schemas:
    CustomQuestionnaireQuestionResponse:
      properties:
        id:
          type: integer
          format: int32
          example: 976
        created:
          type: string
          format: date-time
          example: '2021-11-25T12:51:26+13:00'
        modified:
          type: string
          format: date-time
          example: '2021-11-30T12:51:26+13:00'
        questionnaire_id:
          type: integer
          format: int32
          example: 498
        question:
          type: string
          format: string
          example: Example Waiver Question
        type:
          type: string
          format: string
          example: waiver
        compulsory:
          type: boolean
          format: bool
          example: true
        answershare:
          type: boolean
          format: bool
          example: true
        order:
          type: integer
          format: int32
          example: 9999
        parent_id:
          type: integer
          format: int32
          example: 974
        parent_key:
          type: integer
          format: int32
          example: 0
        version:
          type: integer
          format: int32
          example: 2
        setup_by:
          type: string
          format: int32
          example: 855
        settings_options:
          type: array
          items:
            format: string
            example:
            - I acknowledge
            - I do not acknowledge
        settings_options_unique:
          type: array
          format: array
          items:
            format: int32
            example:
            - 1
            - 2
        settings_waiver:
          type: string
          format: string
          example: Example waiver
        settings_video:
          type: string
          format: string
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
        settings_image:
          $ref: '#/components/schemas/SettingsImageResponse'
        settings_signature:
          type: boolean
          format: bool
          example: true
        settings_copy:
          type: boolean
          format: bool
          example: true
        settings_copy_host:
          type: boolean
          format: bool
          example: true
        settings_send_recipients:
          type: array
          items:
            format: int32
            example:
            - 554
            - 2754
        settings_email_non_staff:
          type: string
          example: example-email@whosonlocation.com
      type: object
    SettingsImageResponse:
      properties:
        title:
          type: string
          format: string
          example: Waiver Image
        thumb:
          type: string
          format: string
          example: https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png
        full:
          type: string
          format: string
          example: https://example.url/storage/cache/waverimage_qoiph7panWllx3_MTIwMCwxMjAw.png
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml