zoo-api/paths/qoc_careprogram_{careprogramKey}_fave.yaml

put:
  tags:
    - Quality of Care
  summary: Favourite, unfavourite, or clear fav status for a given CareProgram
  parameters:
    - name: careprogramKey
      in: path
      description: key of care program for which the fav status needs to be changed
      required: true
      schema:
        type: string
    - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
  requestBody:
    content:
      application/x-www-form-urlencoded:
        schema:
          type: string
          description: |-
            One of:
            * `T` – favourited (show it)
            * `F` - unfavourited (do not show it)
            * `X` - No favourite status (show it if this entity has this program in its default set, otherwise don't).            
          example: T
          enum:
            - T
            - F
            - X
  responses:
    '200':
      description: Fav status is updated
      content:
        application/json:
          schema:
            type: object
            properties:
              key:
                description: |-
                                    The care program key as provided in `/qoc/careprogram`'s `key` property of a careprogram.
                type: string
                example: ZEL-dm2
              value:
                description: The current fav status of this careprogram
                type: string
                example: T
                enum:
                  - T
                  - F
                  - X
              defaultShow:
                description: Whether this care program should be default-shown or not.
                type: boolean
    '401':
      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
    '403':
      $ref: '../zoo-api.yaml/#/components/responses/NoAccess'