Zywave Recommended Content API

openapi: 3.2.0
info:
  title: Recommended Content API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.content
  - api.content:read
tags:
- name: RecommendedContent
paths:
  /content/v2.0/recommendedcontent:
    get:
      tags:
      - RecommendedContent
      summary: Searches recommended content
      operationId: RecommendedContent_GetRecommendedContent
      parameters:
      - name: naicsCode
        in: query
        description: Filter recommended content by six-digit NAICS Code
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 1
      - name: clientSize
        in: query
        description: Filter recommended content by client/employer size
        schema:
          oneOf:
          - $ref: '#/components/schemas/ClientSize'
        x-position: 2
      - name: lineOfBusiness
        in: query
        description: Filter recommended content by line of business
        schema:
          oneOf:
          - oneOf:
            - $ref: '#/components/schemas/LineOfBusiness'
        x-position: 3
      - name: usLocation
        in: query
        description: Fiter smart content by a location in the United States
        schema:
          oneOf:
          - oneOf:
            - $ref: '#/components/schemas/USLocation'
        x-position: 4
      - name: includeZywaveRecommended
        in: query
        description: Include recommended content from Zywave experts.
        schema:
          type: boolean
          default: false
        x-position: 5
      responses:
        '200':
          description: Returns a list of aggregated content.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContentAggregation'
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: string
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    post:
      tags:
      - RecommendedContent
      summary: Post recommended content record
      operationId: RecommendedContent_PostRecommendedContent
      requestBody:
        x-name: recommendedContentInfo
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecommendedContentInfo'
        required: true
        x-position: 1
      responses:
        '201':
          description: Returns the ID of the recommended content record posted
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /content/v2.0/recommendedcontent/{id}:
    put:
      tags:
      - RecommendedContent
      summary: Update recommended content record
      operationId: RecommendedContent_PutRecommendedContent
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: recommendedContentInfo
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecommendedContentInfo'
        required: true
        x-position: 2
      responses:
        '204':
          description: ''
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - RecommendedContent
      summary: Deletes a recommended content record
      operationId: RecommendedContent_DeleteRecommendedContent
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '204':
          description: ''
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    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'
    Content:
      allOf:
      - $ref: '#/components/schemas/ContentInfo'
      - type: object
        description: A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.
        additionalProperties: false
        properties:
          id:
            type: integer
            description: The unique Zywave identifier for the content.
            format: int32
          fileId:
            type: integer
            description: The unique identifier for the lastest ContentFile for the content.
            format: int32
          fileName:
            type:
            - string
            - 'null'
            description: The name of the lastest ContentFile for the content.
          thumbnailUrl:
            type:
            - string
            - 'null'
            description: Thumbnail image source for the content.
          tagNames:
            type:
            - array
            - 'null'
            description: A list of tags that describes what the content is.
            items:
              type: string
    RecommendedContentInfo:
      type: object
      additionalProperties: false
      properties:
        contentId:
          type: integer
          format: int32
        bundleId:
          type: integer
          format: int32
        startDateTime:
          type: string
          format: date-time
        endDateTime:
          type:
          - string
          - 'null'
          format: date-time
        naicsCodes:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        clientSizeIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        states:
          type:
          - array
          - 'null'
          items:
            type: string
    ClientSize:
      type: integer
      description: "0: Invalid,\n1: From0To25,\n2: From26To50,\n3: From51To99,\n4: From100To499,\n5: From500To999,\n6: From1000To2499,\n7: From2500To4999,\n9: MoreThan4999\n "
      x-enumNames:
      - Invalid
      - From0To25
      - From26To50
      - From51To99
      - From100To499
      - From500To999
      - From1000To2499
      - From2500To4999
      - MoreThan4999
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
    ContentInfo:
      type: object
      description: ContentInfo represents the editable properties of a piece of content.
      additionalProperties: false
      properties:
        title:
          type:
          - string
          - 'null'
          description: The title of the piece of content.
        description:
          type:
          - string
          - 'null'
          description: The description of the piece of content.
        clientDescription:
          type:
          - string
          - 'null'
          description: The description clients see for the piece of content.
        isActive:
          type: boolean
          description: Whether the content is active
        file:
          type:
          - string
          - 'null'
          description: The file that will be associated to the content.
          format: binary
        createdDateTime:
          type:
          - string
          - 'null'
          description: The date the content was created
          format: date-time
        updatedDateTime:
          type:
          - string
          - 'null'
          description: The date the file was last edited
          format: date-time
        metadata:
          type:
          - array
          - 'null'
          description: Additional dynamic information about the content.
          items:
            $ref: '#/components/schemas/KeyValuePairOfStringAndString'
    ContentAggregation:
      type: object
      description: A group of content with various metadatas
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the aggregation
        category:
          type:
          - string
          - 'null'
          description: Category of the aggregation
        value:
          type:
          - string
          - 'null'
          description: Aggregation value, refers to how the content was aggregated
        sortOrder:
          type: integer
          description: Where the aggregation is sorted, 0 = first
          format: int32
        contentLookup:
          type:
          - array
          - 'null'
          description: A lookup of content ids and the smart content algorithm scores tied to those
          items:
            type: integer
            format: int32
        content:
          type:
          - array
          - 'null'
          description: The list of content tied to this aggregation
          items:
            $ref: '#/components/schemas/Content'
    KeyValuePairOfStringAndString:
      type: object
      additionalProperties: false
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
    USLocation:
      type: integer
      description: 'None = 0


        Alabama = 1


        Alaska = 2


        AmericanSomoa = 3


        Arizona = 4


        Arkansas = 5


        California = 6


        Colorado = 7


        Connecticut = 8


        Delaware = 9


        DistrictOfColumbia = 10


        Florida = 11


        Georgia = 12


        Guam = 13


        Hawaii = 14


        Idaho = 15


        Illinois = 16


        Indiana = 17


        Iowa = 18


        Kansas = 19


        Kentucky = 20


        Louisiana = 21


        Maine = 22


        Maryland = 23


        Massachusetts = 24


        Michigan = 25


        Minnesota = 26


        Mississippi = 27


        Missouri = 28


        Montana = 29


        Nebraska = 30


        Nevada = 31


        NewHampshire = 32


        NewJersey = 33


        NewMexico = 34


        NewYork = 35


        NorthCarolina = 36


        NorthDakota = 37


        NorthernMarianaIslands = 38


        Ohio = 39


        Oklahoma = 40


        Oregon = 41


        Pennsylvania = 42


        PuertoRico = 43


        RhodeIsland = 44


        SouthCarolina = 45


        SouthDakota = 46


        Tennessee = 47


        Texas = 48


        Utah = 49


        Vermont = 50


        VirginIslands = 51


        Virginia = 52


        Washington = 53


        WestVirginia = 54


        Wisconsin = 55


        Wyoming = 56'
      x-enumNames:
      - None
      - Alabama
      - Alaska
      - AmericanSomoa
      - Arizona
      - Arkansas
      - California
      - Colorado
      - Connecticut
      - Delaware
      - DistrictOfColumbia
      - Florida
      - Georgia
      - Guam
      - Hawaii
      - Idaho
      - Illinois
      - Indiana
      - Iowa
      - Kansas
      - Kentucky
      - Louisiana
      - Maine
      - Maryland
      - Massachusetts
      - Michigan
      - Minnesota
      - Mississippi
      - Missouri
      - Montana
      - Nebraska
      - Nevada
      - NewHampshire
      - NewJersey
      - NewMexico
      - NewYork
      - NorthCarolina
      - NorthDakota
      - NorthernMarianaIslands
      - Ohio
      - Oklahoma
      - Oregon
      - Pennsylvania
      - PuertoRico
      - RhodeIsland
      - SouthCarolina
      - SouthDakota
      - Tennessee
      - Texas
      - Utah
      - Vermont
      - VirginIslands
      - Virginia
      - Washington
      - WestVirginia
      - Wisconsin
      - Wyoming
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 17
      - 18
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 26
      - 27
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34
      - 35
      - 36
      - 37
      - 38
      - 39
      - 40
      - 41
      - 42
      - 43
      - 44
      - 45
      - 46
      - 47
      - 48
      - 49
      - 50
      - 51
      - 52
      - 53
      - 54
      - 55
      - 56
    LineOfBusiness:
      type: integer
      description: '1: Benefits


        2: PropertyAndCasualty


        3: PersonalLines


        4: Canada


        5: UK'
      x-enumNames:
      - Benefits
      - PropertyAndCasualty
      - PersonalLines
      - Canada
      - UK
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
  securitySchemes:
    oidc:
      type: oauth2
      openIdConnectUrl: https://auth.zywave.com/.well-known/openid-configuration
      flows:
        authorizationCode:
          authorizationUrl: https://auth.zywave.com/connect/authorize
          tokenUrl: https://auth.zywave.com/connect/token
          scopes:
            api.content: Full access to all agency operations
            api.content:read: Read-only access to agencies
x-generator: NSwag v14.0.8.0 (NJsonSchema v11.0.1.0 (Newtonsoft.Json v13.0.0.0))