MRI Software Custom questionnaire submissions API

openapi: 3.2.0
info:
  title: Mri Software Custom questionnaire submissions API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Custom questionnaire submissions 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 questionnaire submissions
  description: Returns a list of all custom questionnaire submissions (excluding the answers). Includes location, kiosk, who submitted the answer, where the movement took place, date and time.
paths:
  /custom-questionnaire/submission:
    get:
      tags:
      - Custom questionnaire submissions
      summary: List all custom questionnaire submissions
      description: 'Returns a list of custom questionnaire submission records. The endpoint is limited to a maximum of 10,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: getCustomQuestionnaireSubmissionList
      parameters:
      - name: q
        in: query
        description: Filter by any custom questionnaire submission.
        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: -questionnaire_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 questionnaire submission records
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomQuestionnaireSubmissionResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomQuestionnaireSubmissionResponse'
        '403':
          description: Access denied to this resource.
        '404':
          description: No records are found matching the passed in filters
    servers:
    - url: https://api.whosonlocation.com/v1
  /custom-questionnaire/submission/{id}:
    get:
      tags:
      - Custom questionnaire submissions
      summary: Retrieve a custom questionnaire submission
      description: Returns a custom questionnaire submission record filtered by the passed in ID.
      operationId: getCustomQuestionnaireSubmission
      parameters:
      - name: id
        in: path
        description: ID of the custom questionnaire submission to look for
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The custom questionnaire submission element matching the passed in ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomQuestionnaireSubmissionResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/CustomQuestionnaireSubmissionResponse'
        '403':
          description: Access denied to this resource.
        '404':
          description: Resource not found.
    servers:
    - url: https://api.whosonlocation.com/v1
components:
  schemas:
    CustomQuestionnaireSubmissionResponse:
      properties:
        id:
          type: integer
          format: int32
          example: 1740
        created:
          type: string
          format: date-time
          example: '2021-11-25T14:47:34+13:00'
        modified:
          type: string
          format: date-time
          example: '2021-12-11T14:47:34+13:00'
        questionnaire_id:
          type: integer
          format: int32
          example: 498
        sp_member_id:
          type: integer
          format: int32
          example: 55
        visitor_id:
          type: integer
          format: int32
          example: 138
        staff_id:
          type: string
          format: int32
          example: 7
        movement_id:
          type: integer
          format: int32
          example: 18
        source:
          type: string
          format: string
          example: kiosk
        onsite_status:
          type: string
          format: string
          example: onsite
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml