MRI Software Location departments API

openapi: 3.2.0
info:
  title: Mri Software Location departments API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Location departments 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: Location departments
  description: 'Departments are used to assign employees to different operational areas of a location. Use the API to retrieve a list of all departments, create new departments and the locations they apply to, update the department names, or remove them from your account.


    Learn more about departments in the OnLocation Help Center.'
paths:
  /department:
    get:
      tags:
      - Location departments
      summary: List all departments
      description: Returns a list of departments for the organization. Each department indicates which locations it has been added to.
      operationId: getDepartmentList
      responses:
        '200':
          description: List of departments
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DepartmentResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DepartmentResponse'
        '403':
          description: Access denied to this resource
        '404':
          description: Resource not found
    post:
      tags:
      - Location departments
      summary: Create a department
      description: Add a new department, details include the name and locations.
      operationId: createDepartment
      requestBody:
        description: 'Department to save to the database:'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentRequest'
      responses:
        '201':
          description: Department created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepartmentResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/DepartmentResponse'
        '403':
          description: Access denied to this resource
        '409':
          description: Department already exists
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
  /department/{id}:
    get:
      tags:
      - Location departments
      summary: Retrieve a department
      description: Retrieves a single department, filtering with the provided ID.
      operationId: getDepartment
      parameters:
      - name: id
        in: path
        description: ID of the department to retrieve
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Department returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepartmentResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/DepartmentResponse'
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
    put:
      tags:
      - Location departments
      summary: Update a department
      description: Updates a department with the submitted data, using the provided ID.
      operationId: updateDepartment
      parameters:
      - name: id
        in: path
        description: ID of the department to update
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: Department to save to the database
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentRequest'
      responses:
        '204':
          description: Department updated
        '403':
          description: Access denied to this resource
        '500':
          description: Internal server error
    delete:
      tags:
      - Location departments
      summary: Delete a department
      description: Removes a department using the provided ID.
      operationId: deleteDepartment
      parameters:
      - name: id
        in: path
        description: ID of the department to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Department deleted
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
    servers:
    - url: https://api.whosonlocation.com/v1
components:
  schemas:
    BasicIdNamePair:
      properties:
        id:
          type: integer
          format: int32
          example: 556
        name:
          type: string
          format: string
          example: Example Name
      type: object
    DepartmentResponse:
      description: Describes the format/shape of department response objects
      required:
      - name
      properties:
        id:
          type: integer
          format: int32
          example: 1658
        created:
          type: string
          format: date-time
          example: '2021-08-12T10:54:13+12:00'
        modified:
          type: string
          format: date-time
          example: '2021-08-13T10:54:13+12:00'
        name:
          type: string
          format: string
          example: Administration
        locations:
          type: array
          items:
            $ref: '#/components/schemas/BasicIdNamePair'
      type: object
    DepartmentRequest:
      properties:
        name:
          type: string
          format: string
          example: Department of Examples
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml