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.
56 lines
2.4 KiB
YAML
56 lines
2.4 KiB
YAML
post:
|
|
tags:
|
|
- Customer management
|
|
operationId: setCustomerCareProgramPeriodEnd
|
|
summary: Update the period end of a practice in a care program.
|
|
description: |-
|
|
Updates only the period end date of the participation of a practice in a care program. This is equivalent to submitting a new participation to this API, but, the `periodStart` parameter is not needed.
|
|
Requires that this practice already participates in the provided care program (and that participation will get its end date updated).
|
|
requestBody:
|
|
content:
|
|
'application/x-www-form-urlencoded':
|
|
schema:
|
|
type: object
|
|
properties:
|
|
careprogram:
|
|
description: The kind of care program that the practice participates in.
|
|
$ref: '../schemas/CareProgram-enum.yaml'
|
|
agb:
|
|
description: The AGB of the practice (not the doctor).
|
|
$ref: '../schemas/agb.yaml'
|
|
employee:
|
|
type: string
|
|
description: The employee that is adding the practice. Any string is accepted, but it is recommended to use a employee code derived from this API.
|
|
periodEnd:
|
|
description: The end of the period of the participation. Allowed to be not set or empty, when no end date is known. If set, `periodEnd` must be at least a day after the `periodStart` which is stored for the combination of `careprogram` and `agb`.
|
|
$ref: ../schemas/date.yaml
|
|
required:
|
|
- careprogram
|
|
- agb
|
|
- employee
|
|
responses:
|
|
'200':
|
|
description: |-
|
|
If the request was successfully processed, a Json-object with the following properties is send back to the caller, otherwise a non 200 HTTP response.
|
|
content:
|
|
'application/json':
|
|
schema:
|
|
type: object
|
|
properties:
|
|
employee:
|
|
type: string
|
|
timestamp:
|
|
$ref: ../schemas/dateTime.yaml
|
|
careprogram:
|
|
$ref: '../schemas/CareProgram-enum.yaml'
|
|
agb:
|
|
$ref: '../schemas/agb.yaml'
|
|
periodStart:
|
|
$ref: ../schemas/date.yaml
|
|
periodEnd:
|
|
$ref: ../schemas/date.yaml
|
|
'401':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
'403':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'
|
|
|