CareAcademy Compliance Report API

openapi: 3.2.0
info:
  version: 1.0.10
  title: CareAcademy Compliance Report API
  description: The CareAcademy API allows integration partners to create seamless flows between their products and CareAcademy systems.
servers:
- url: https://staging.careacademy.com/api/v1
security:
- BasicAuth: []
tags:
- name: Compliance Report
paths:
  /compliance_report/{organizationIntegrationId}:
    get:
      summary: Returns a copy of the compliance report
      parameters:
      - in: path
        name: organizationIntegrationId
        required: true
        description: The integration ID for the organization. This is the same value passed as the organizationIntegrationId parameter to the Organizations POST API endpoint.
        schema:
          type: string
      - in: query
        name: filter[startDate]
        required: true
        description: The starting date of the report you wish to pull. If a date is passed and is unrecognized as a valid date it will return an 'invalid date' error. Date should be in ISO 8601 format.
        schema:
          type: string
      - in: query
        name: filter[locationId]
        required: true
        description: The location ID of the location to retreive data for.
        schema:
          type: string
      - in: query
        name: filter[endDate]
        required: false
        description: The ending date of the report you wish to pull. If a date is passed and is unrecognized as a valid date it will return an 'invalid date' error. Date should be in ISO 8601 format. If no value is passed then the report end date defaults to the current time.
        schema:
          type: string
      - in: query
        name: filter[completeIncomplete]
        required: false
        description: Specifies whether you wish to see a report of all completed courses, or courses that are not yet completed. The default for this parameter is “complete”. If a value of “incomplete” is passed, it will return the courses that are incomplete.
        schema:
          type: string
      - in: query
        name: page[after]
        required: false
        description: 'Specifies the zero based index of the page of data that you would like to retrieve. For example, if you would like the second page of data then you would provide page[after]=1, or you would provide page[after]=2 in order to retrieve the third page of data. The response will include the first page of data when no page[after] value is provided. Note: the json response includes a "links" key which will contain a relative url that you can use to retrieve the next page of data. The "links" key is only included in the response when there are multiple pages of data'
        schema:
          type: string
      - in: header
        name: Accept
        required: false
        description: Specifies how you would like the data returned. Allowed values are "text/csv" and "application/json".
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
                example: Agency Name,First Name,Last Name,Integration ID,Title,Hire Date,Has State Registration,HCA Registration Date,HCA Registration ID,Birth Date,License Number,Employee ID,Total Duration (hours),Course Name,Course Completion Date,Course Description,Outline,State Approvals,Course Organization,Course Instructor,Course Location,Course Duration (hours),Is Initial,Is Annual,Exam Result,Course Duration (minutes)
            application/json:
              schema:
                type: object
                example:
                  data:
                  - agencyName: agency 1
                    birthday: 2/15/57
                    completedDate: '2022-10-31T00:00:00Z'
                    courseName: Clients' Rights, HIPAA & Elder Abuse Prevention
                    description: In this CareAcademy class, we discuss clients' confidentiality, privacy, and related rights. We also discuss elder abuse and neglect, including how to prevent it and how to report it if it does occur.
                    durationInMinutes: 60
                    examResultPercentage: 95
                    firstName: Harry
                    hcaRegDate: '2021-10-31T00:00:00Z'
                    hcaRegId: abcdef
                    hireDate: '2020-10-31T00:00:00Z'
                    instructor: Samantha Jones
                    integrationId: abc-def
                    isAnnual: false
                    isInitial: true
                    lastName: Jones
                    title: Home Care Aide
                    licenseNumber: '123456'
                    location: www.careacademy.com
                    organization: CareAcademy.com | 1.866.227.3895 | hello@careacademy.com
                    outline: Course outline information
                  links:
                    next:
                      href: /api/v1/compliance_report/organizationID?page[after]=1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          description: An organization could not be found for the given organizationIntegrationId.
      tags:
      - Compliance Report
      operationId: getComplianceReportByOrganizationIntegrationId
      x-operation-id-source: derived
components:
  responses:
    BadRequest:
      description: Bad Request. One or more required parameters are missing or invalid.
      content:
        '*/*':
          schema:
            type: object
            properties:
              additionalInformation:
                description: Information and warnings regarding any problems with the request. For general warnings, the parameterName value will be "_".
                type: array
                items:
                  type: object
                  properties:
                    parameterName:
                      type: string
                    description:
                      type: string
              errors:
                description: An array of field errors. For general errors, the parameterName value will be "_".
                type: array
                items:
                  type: object
                  properties:
                    parameterName:
                      type: string
                    errorDescription:
                      type: string
    UnauthorizedError:
      description: Authentication information is missing or invalid
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic