Zywave Tool Package API

openapi: 3.2.0
info:
  title: Client Engagement API v1.0 Tool Package API
  version: v1.0
servers:
- url: https://api.zywave.com
tags:
- name: ToolPackage
paths:
  /v3/clientEngagement/v1.0/org/{organizationId}/agency/{agencyId}/toolpackage/{id}:
    get:
      tags:
      - ToolPackage
      summary: Gets a tool package by ID
      operationId: ToolPackage_GetToolPackage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: agencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: enrichMembers
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 4
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolPackageResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - ToolPackage
      summary: Replaces a tool package
      operationId: ToolPackage_UpdateToolPackage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: agencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 3
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolPackageRequest'
        required: true
        x-position: 4
      responses:
        '204':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - ToolPackage
      summary: Deletes a tool package
      operationId: ToolPackage_DeleteToolPackage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: agencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 3
      responses:
        '204':
          description: ''
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v3/clientEngagement/v1.0/org/{organizationId}/agency/{agencyId}/toolpackage:
    get:
      tags:
      - ToolPackage
      summary: Gets tool packages using OData query options ($filter, $orderby, $top, $skip).
      operationId: ToolPackage_GetToolPackages
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: agencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: $filter
        x-originalName: filter
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: $orderby
        x-originalName: orderby
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: $top
        x-originalName: top
        in: query
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 5
      - name: $skip
        x-originalName: skip
        in: query
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 6
      - name: enrichMembers
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 7
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfToolPackageResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    post:
      tags:
      - ToolPackage
      summary: Creates a new tool package
      operationId: ToolPackage_CreateToolPackage
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: agencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 2
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolPackageRequest'
        required: true
        x-position: 3
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolPackageResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ToolPackageResponse:
      type: object
      description: 'Client-facing tool package response. Feature keys are translated from the underlying

        Guid collection to the strongly-typed ToolPackageFeature enum; internal audit

        fields are excluded.'
      additionalProperties: false
      required:
      - name
      properties:
        id:
          type: integer
          description: The unique identifier of the tool package.
          format: int32
        name:
          type: string
          description: The name of the tool package.
          maxLength: 250
          minLength: 0
        agencyId:
          type: integer
          description: The agency that owns the tool package.
          format: int32
        portalId:
          type:
          - integer
          - 'null'
          description: The portal this package is scoped to, if any.
          format: int32
        defaultMembership:
          type: boolean
          description: Whether new clients receive this package by default.
        allTools:
          type: boolean
          description: Whether the package grants access to all tools.
        allContent:
          type: boolean
          description: Whether the package grants access to all content.
        inactive:
          type: boolean
          description: Whether the package is inactive.
        features:
          type: array
          description: The features this tool package grants, resolved from the underlying feature keys.
          items:
            $ref: '#/components/schemas/ToolPackageFeature'
        members:
          type: array
          description: Member assignments for this tool package (populated when the request asked to enrich members).
          items:
            $ref: '#/components/schemas/BaseMember'
    BaseMember:
      type: object
      additionalProperties: false
      properties:
        toolPackageMemberId:
          type: integer
          format: int32
        entityId:
          type: integer
          format: int32
        entityType:
          $ref: '#/components/schemas/MemberEntityType'
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    PagedResultOfToolPackageResponse:
      type: object
      description: A page of results from a larger result set, along with paging metadata.
      additionalProperties: false
      required:
      - items
      properties:
        hasMoreResults:
          type: boolean
          description: A value indicating whether the larger result set has more results.
        skip:
          type: integer
          description: A value indicating how many of the previous values in the larger result set were omitted.
          format: int32
          maximum: 2147483647
          minimum: 0
        take:
          type: integer
          description: The number of records retrieved from the larger result set.
          format: int32
          maximum: 2147483647
          minimum: 0
        totalCount:
          type: integer
          description: The total number of records in the larger result set.
          format: int32
          maximum: 2147483647
          minimum: 0
        items:
          type: array
          description: The records retrieved from the larger result set.
          items:
            $ref: '#/components/schemas/ToolPackageResponse'
    ToolPackageRequest:
      type: object
      description: 'Payload for creating or updating a tool package. Wraps ToolPackageInfo and

        exposes the feature catalog as a strongly-typed ToolPackageFeature enum rather than

        raw feature-key Guids.'
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          description: The name of the tool package.
          maxLength: 250
          minLength: 1
        portalId:
          type:
          - integer
          - 'null'
          description: The portal this package is scoped to, if any.
          format: int32
          maximum: 2147483647
          minimum: 1
        defaultMembership:
          type: boolean
          description: Whether new clients receive this package by default.
        allTools:
          type: boolean
          description: Whether the package grants access to all tools (overrides Features for tool access).
        allContent:
          type: boolean
          description: Whether the package grants access to all content (overrides Features for content access).
        inactive:
          type: boolean
          description: Whether the package is inactive (retained but not granted to new members).
        features:
          type: array
          description: The features this tool package grants access to.
          items:
            $ref: '#/components/schemas/ToolPackageFeature'
    MemberEntityType:
      type: string
      description: ''
      x-enumNames:
      - Account
      - AccountContact
      - StaticList
      - DynamicList
      enum:
      - Account
      - AccountContact
      - StaticList
      - DynamicList
    ToolPackageFeature:
      type: string
      description: 'Zywave tool/content features that can be granted by a tool package. The enum value is the

        stable public identifier exposed by this API; the underlying feature key (Guid) used by the

        internal contracts is resolved via ToolPackageFeatureMap.'
      x-enumNames:
      - AcaReporting
      - BenefitDocumentBuilder
      - BreachResponse
      - CobraNoticesGenerator
      - ComplianceNoticeBuilder
      - CompliancePosterBuilder
      - CustomJobDescriptionBuilder
      - CyberAssessmentTool
      - CyberHotline
      - EmployeeCostCalculator
      - EmployeeHandbookBuilder
      - EnrollmentBookletBuilder
      - FederalPosterAdvisor
      - FmlaAdvisor
      - HealthPlanComplianceCalendar
      - HrHotline
      - HrSelfAssessmentTool
      - InPersonInterviewQuestionBuilder
      - ManagementLiabilityHotline
      - MultiStateLawsComparisonTool
      - OshaLog
      - PerformanceReviewBuilder
      - PhoneInterviewQuestionBuilder
      - RelationshipManagementService
      - SalaryBenchmarking
      - SampleJobDescriptions
      - TotalCompensationStatementBuilder
      - WebAccessibilityTool
      - ZywaveLearning
      - ClientContentDisciplineAndTermination
      - ClientContentEmployeeBenefits
      - ClientContentHealthCareReform
      - ClientContentHumanResources
      - ClientContentRecruitmentAndHiring
      - ClientContentReferenceCenter
      - ClientContentSafetyAndWellness
      - ClientContentStateLaws
      - ClientContentFormsAndPolicies
      - ClientContentHrVideos
      - ClientContentRiskManagement
      - ClientContentWhatAreYouDoingToday
      - ClientContentCyber
      - ClientContentManagementLiability
      - ClientContentSafety
      - ClientContentWellness
      - ClientContentMunicipalAndSchool
      - ClientContentWebinars
      - ClientContentNewsletters
      - ClientContentWhatAreYouDoingTodayBenefits
      - ClientContentWhatAreYouDoingTodayCyber
      - ClientContentWhatAreYouDoingTodayDisasterAndEmergency
      - ClientContentWhatAreYouDoingTodayHr
      - ContentEmployeeBenefitsEmployeeCommunications
      - ContentEmployeeBenefitsStateAndFederalCompliance
      - ContentEmployeeBenefitsWellness
      - ContentEmployeeBenefitsHumanResources
      - ContentEmployeeBenefitsEducation
      - ContentEmployeeBenefitsBrokerInsuranceInsights
      - ContentEmployeeBenefitsPremiumContent
      - ContentPcCommercialCoverageEducation
      - ContentPcEmployeeSafetyCommunications
      - ContentPcStateAndFederalCompliance
      - ContentPcPersonalLines
      - ContentPcRiskManagementAndLossControl
      - ContentPcHumanResources
      - ContentPcBrokerInsuranceInsights
      - ContentPcPremiumContent
      - CanadaCore
      - UkCore
      - BenefitsCore
      - PcCore
      - PersonalLinesCore
      x-enum-descriptions:
      - ACA Reporting
      - Benefit Document Builder
      - Breach Response
      - COBRA Notices Generator
      - Compliance Notice Builder
      - Compliance Poster Builder
      - Custom Job Description Builder
      - Cyber Assessment Tool
      - Cyber Hotline
      - Employee Cost Calculator
      - Employee Handbook Builder
      - Enrollment Booklet Builder
      - Federal Poster Advisor
      - FMLA Advisor
      - Health Plan Compliance Calendar
      - HR Hotline
      - HR Self-Assessment Tool
      - In-person Interview Question Builder
      - Management Liability Hotline
      - Multi-State Laws Comparison Tool
      - OSHA Log
      - Performance Review Builder
      - Phone Interview Question Builder
      - Relationship Management Service
      - Salary Benchmarking
      - Sample Job Descriptions
      - Total Compensation Statement Builder
      - Web Accessibility Tool
      - Zywave Learning
      - 'Client Content: Discipline & Termination'
      - 'Client Content: Employee Benefits'
      - 'Client Content: Health Care Reform'
      - 'Client Content: Human Resources'
      - 'Client Content: Recruitment & Hiring'
      - 'Client Content: Reference Center'
      - 'Client Content: Safety & Wellness'
      - 'Client Content: State Laws'
      - 'Client Content: Forms & Policies'
      - 'Client Content: HR Videos'
      - 'Client Content: Risk Management'
      - 'Client Content: What are you doing today?'
      - 'Client Content: Cyber'
      - 'Client Content: Management Liability'
      - 'Client Content: Safety'
      - 'Client Content: Wellness'
      - 'Client Content: Municipal & School'
      - 'Client Content: Webinars'
      - 'Client Content: Newsletters'
      - 'Client Content: What are you doing today? - Benefits'
      - 'Client Content: What are you doing today? - Cyber'
      - 'Client Content: What are you doing today? - Disaster and Emergency'
      - 'Client Content: What are you doing today? - HR'
      - 'Content: Employee Benefits Employee Communications'
      - 'Content: Employee Benefits State and Federal Compliance'
      - 'Content: Employee Benefits Wellness'
      - 'Content: Employee Benefits Human Resources'
      - 'Content: Employee Benefits Education'
      - 'Content: Employee Benefits Broker Insurance Insights'
      - 'Content: Employee Benefits Premium Content'
      - 'Content: P&C Commercial Coverage Education'
      - 'Content: P&C Employee Safety Communications'
      - 'Content: P&C State and Federal Compliance'
      - 'Content: P&C Personal Lines'
      - 'Content: P&C Risk Management and Loss Control'
      - 'Content: P&C Human Resources'
      - 'Content: P&C Broker Insurance Insights'
      - 'Content: P&C Premium Content'
      - Canada Core
      - UK Core
      - Benefits Core
      - P&C Core
      - Personal Lines Core
      enum:
      - AcaReporting
      - BenefitDocumentBuilder
      - BreachResponse
      - CobraNoticesGenerator
      - ComplianceNoticeBuilder
      - CompliancePosterBuilder
      - CustomJobDescriptionBuilder
      - CyberAssessmentTool
      - CyberHotline
      - EmployeeCostCalculator
      - EmployeeHandbookBuilder
      - EnrollmentBookletBuilder
      - FederalPosterAdvisor
      - FmlaAdvisor
      - HealthPlanComplianceCalendar
      - HrHotline
      - HrSelfAssessmentTool
      - InPersonInterviewQuestionBuilder
      - ManagementLiabilityHotline
      - MultiStateLawsComparisonTool
      - OshaLog
      - PerformanceReviewBuilder
      - PhoneInterviewQuestionBuilder
      - RelationshipManagementService
      - SalaryBenchmarking
      - SampleJobDescriptions
      - TotalCompensationStatementBuilder
      - WebAccessibilityTool
      - ZywaveLearning
      - ClientContentDisciplineAndTermination
      - ClientContentEmployeeBenefits
      - ClientContentHealthCareReform
      - ClientContentHumanResources
      - ClientContentRecruitmentAndHiring
      - ClientContentReferenceCenter
      - ClientContentSafetyAndWellness
      - ClientContentStateLaws
      - ClientContentFormsAndPolicies
      - ClientContentHrVideos
      - ClientContentRiskManagement
      - ClientContentWhatAreYouDoingToday
      - ClientContentCyber
      - ClientContentManagementLiability
      - ClientContentSafety
      - ClientContentWellness
      - ClientContentMunicipalAndSchool
      - ClientContentWebinars
      - ClientContentNewsletters
      - ClientContentWhatAreYouDoingTodayBenefits
      - ClientContentWhatAreYouDoingTodayCyber
      - ClientContentWhatAreYouDoingTodayDisasterAndEmergency
      - ClientContentWhatAreYouDoingTodayHr
      - ContentEmployeeBenefitsEmployeeCommunications
      - ContentEmployeeBenefitsStateAndFederalCompliance
      - ContentEmployeeBenefitsWellness
      - ContentEmployeeBenefitsHumanResources
      - ContentEmployeeBenefitsEducation
      - ContentEmployeeBenefitsBrokerInsuranceInsights
      - ContentEmployeeBenefitsPremiumContent
      - ContentPcCommercialCoverageEducation
      - ContentPcEmployeeSafetyCommunications
      - ContentPcStateAndFederalCompliance
      - ContentPcPersonalLines
      - ContentPcRiskManagementAndLossControl
      - ContentPcHumanResources
      - ContentPcBrokerInsuranceInsights
      - ContentPcPremiumContent
      - CanadaCore
      - UkCore
      - BenefitsCore
      - PcCore
      - PersonalLinesCore