MRI Software Certifications API

openapi: 3.2.0
info:
  title: Mri Software Certifications API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Certifications 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: Certifications
  description: 'Certifications are used to record employee and contractor accreditations in OnLocation. Use the API to retrieve the certifications created for your organization, add or update, or delete a certification, and see the number of people who hold the certification.


    Learn more about certifications in the OnLocation Help Center.'
paths:
  /certification:
    get:
      tags:
      - Certifications
      summary: List all certifications
      description: 'Returns a list of all certifications.


        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: getCertificationList
      parameters:
      - name: q
        in: query
        description: Filter by any certification value.
        required: false
        schema:
          type: string
          format: string
        example: holders>5
      responses:
        '200':
          description: List of certifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CertificationResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CertificationResponse'
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    post:
      tags:
      - Certifications
      summary: Create a certification
      description: Creates a new certification that can be assigned to employees or contractors.
      operationId: createCertification
      requestBody:
        description: Information to use when creating a new certification record.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificationRequest'
      responses:
        '201':
          description: Certification created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationResponse'
        '403':
          description: Access denied to this resource
        '409':
          description: Already exists with that name
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
  /certification/{id}:
    get:
      tags:
      - Certifications
      summary: Retrieve a certification
      description: Retrieves a single certification, filtering with the provided ID.
      operationId: getCertification
      parameters:
      - name: id
        in: path
        description: ID of the certification to retrieve
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/CertificationResponse'
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    put:
      tags:
      - Certifications
      summary: Update a certification
      description: Updates the details of a certification.
      operationId: updateCertification
      parameters:
      - name: id
        in: path
        description: ID of the certification to update
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: Information used to create the certification record
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificationRequest'
      responses:
        '200':
          description: Updated resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/CertificationResponse'
        '403':
          description: Access denied to this resource
        '409':
          description: Certification already exists with that name
        '500':
          description: Internal server error
    delete:
      tags:
      - Certifications
      summary: Delete a certification
      description: Deletes a certification using the provided ID.
      operationId: deleteCertification
      parameters:
      - name: id
        in: path
        description: ID of the certification to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Certification 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:
    CertificationRequest:
      properties:
        name:
          type: string
          format: string
          example: Updated Request
        category:
          type: string
          format: string
          example: external
        certification_type_id:
          type: integer
          format: int32
          example: 81
        description:
          type: string
          format: string
          example: This describes the certification
      type: object
    BasicIdNamePair:
      properties:
        id:
          type: integer
          format: int32
          example: 556
        name:
          type: string
          format: string
          example: Example Name
      type: object
    CertificationResponse:
      properties:
        id:
          type: integer
          format: int32
          example: 1206
        created:
          type: string
          format: date-time
          example: '2021-11-26T14:35:28+13:00'
        modified:
          type: string
          format: date-time
          example: '2021-12-31T14:35:28+13:00'
        created_by:
          type: integer
          format: int32
          example: 35
        name:
          type: string
          format: string
          example: Certification Name
        category:
          type: string
          format: string
          example: internal
        certification_type_id:
          type: integer
          format: int32
          example: 81
        description:
          type: string
          format: string
          example: This describes the certification
        holders:
          type: integer
          format: int32
          example: 2
        status:
          type: string
          enum:
          - Active
          - Inactive
          example: Active
        staff_audience:
          type: string
          enum:
          - locations
          - departments
          - roles
          - all
          example: locations
        contractor_audience:
          type: string
          enum:
          - locations
          - groups
          - roles
          - all
          example: groups
        staff_departments:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
        staff_locations:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
        staff_roles:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
        sp_groups:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
        sp_locations:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
        sp_roles:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml