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/population_statistics_autho...

57 lines
2.3 KiB
YAML

post:
tags:
- Population statistics
operationId: setGroupByItemPractice
summary: Authorisation of practice
description: |-
Set the authorisation for statistic group-by items for the practice. This enables or disables the statistic for all the employees of the practice at once. Only when authorized as the practice the settings may be changed.
parameters:
- name: 'item'
in: path
schema:
$ref: '../schemas/StatisticsGroupBy-enum.yaml'
required: true
- name: agb
in: query
schema:
$ref: '../schemas/agb.yaml'
description: AGB of the practice for which the authorisation should be set. This should match the JWT-authorisation.
required: true
- name: enddate
in: query
schema:
$ref: ../schemas/date.yaml
description: End date of the authorisation (exclusive). If omitted no end date is applied, or the end date is removed of an existing authorisation. Setting an end date to today or in past, effectively removes the authorisation.
- name: employee
in: query
schema:
type: string
description: The employee that is adding the authorisation. Any string is accepted, but it is recommended to use a employee code derived from this API.
required: true
responses:
'200':
description: The response parrots the request, except for the `employee` and `timestamp` properties. If the authorisation is changed the `employee` and `timestamp` from the request are responded, but if the request didn't change the authorisation, then the `employee` and `timestamp` from the last change are in the payload.
content:
application/json:
schema:
type: object
properties:
employee:
type: string
timestamp:
$ref: ../schemas/dateTime.yaml
agb:
$ref: ../schemas/agb.yaml
authorizedFor:
$ref: '../schemas/StatisticsGroupBy-enum.yaml'
tag:
$ref: '../schemas/tag.yaml'
example: ""
description: Always the empty tag.
enddate:
$ref: '../schemas/date.yaml'
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'