MRI Software Visitor groups API

openapi: 3.2.0
info:
  title: Mri Software Visitor groups API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Visitor groups 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: Visitor groups
  description: 'Each visitor group is created by an employee and includes a set of their visitors who are pre-registered to attend the same events. Use the visitor group API to retrieve your visitor group list, add a new visitor group, or update or delete a visitor group.


    Learn more about visitor groups in the OnLocation Help Center.'
paths:
  /visitor/group:
    get:
      tags:
      - Visitor groups
      summary: List all visitor groups
      description: 'Returns a list of all visitor groups added by employees.


        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: getVisitorGroupList
      parameters:
      - name: q
        in: query
        description: Filter by visitor group value.
        required: false
        schema:
          type: string
          format: string
        example: staff_id:100
      responses:
        '200':
          description: List of registered visitor groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VisitorGroupResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VisitorGroupResponse'
        '403':
          description: Access denied to this resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    post:
      tags:
      - Visitor groups
      summary: Create a visitor group
      description: Create a new visitor group and assign it the the relevant employee and location.
      operationId: createVisitorPerson
      requestBody:
        description: 'Data used to create a new visitor group:'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VisitorGroupRequest'
      responses:
        '201':
          description: Group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisitorGroupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/VisitorGroupResponse'
        '403':
          description: Access denied to this resource
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
  /visitor/group/{id}:
    get:
      tags:
      - Visitor groups
      summary: Retrieve a visitor group
      description: Retrieves a single visitor group, filtering with the provided ID.
      operationId: getVisitorGroup
      parameters:
      - name: id
        in: path
        description: ID of the registered visitor group to retrieve
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Group returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VisitorGroupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/VisitorGroupResponse'
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    put:
      tags:
      - Visitor groups
      summary: Update a visitor group
      description: Updates the specified visitor group based on the provided ID.
      operationId: updateVisitorGroup
      parameters:
      - name: id
        in: path
        description: ID of the registered visitor group to update
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: 'Information used to update the visitor group record:'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VisitorGroupRequest'
      responses:
        '204':
          description: Updated group
        '403':
          description: Access denied to this resource
        '500':
          description: Internal server error
    delete:
      tags:
      - Visitor groups
      summary: Delete a visitor group
      description: Deletes the specified visitor group.
      operationId: deleteVisitorGroup
      parameters:
      - name: id
        in: path
        description: ID of the registered visitor group to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Visitor group deleted
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
components:
  schemas:
    VisitorGroupRequest:
      required:
      - name
      - location_id
      - staff_id
      properties:
        name:
          type: integer
          format: int32
          example: Updated visitor group name
        description:
          type: string
          format: string
          example: Group description
        location_id:
          type: integer
          format: int32
          example: 301
        staff_id:
          type: integer
          format: int32
          example: 556
      type: object
    VisitorGroupResponse:
      properties:
        id:
          type: integer
          format: int32
          example: 197
        created:
          type: string
          format: date-time
          example: '2021-11-29T10:58:12+13:00'
        modified:
          type: string
          format: date-time
          example: '2021-11-29T13:58:12+13:00'
        location_id:
          type: integer
          format: int32
          example: 301
        created_staff_id:
          type: integer
          format: int32
          example: 823
        staff_id:
          type: integer
          format: int32
          example: 823
        name:
          type: string
          format: string
          example: Visitor Group 1
        description:
          type: string
          format: string
          example: Group 1 description
        members:
          type: integer
          format: int32
          example: 2
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml