You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zoo-api/paths/qoc_careprogram_{careprogra...

52 lines
1.5 KiB
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
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: string
description: |-
The value `T`/`F`/`X`, respectively: "favourited", "unfavourited", "no favourite status"
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'