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

53 lines
2.1 KiB
YAML

get:
tags:
- Population statistics
operationId: getStatisticsAuthorisation
summary: Authorisation
description: Reports the authorisations for group-by items for the specified practice(s). Care groups are allowed to query the authorisations of the underlying practices. Practices are always allowed to access their own population statistics, therefore authorisation applies only to care groups wanting to access a practice statistics object (group-by item).
parameters:
- name: agbs
in: query
schema:
type: array
items:
$ref: ../schemas/agb.yaml
required: true
description: The agb of the practice(s) for which the authorisations should be reported.
responses:
200:
description: An array with for each practice an object describing the authorisation settings for the care group.
content:
application/json:
schema:
type: array
items:
type: object
properties:
practice:
$ref: '../schemas/agb.yaml'
caregroups:
type: array
items:
type: object
properties:
tag:
$ref: ../schemas/tag.yaml
agb:
$ref: '../schemas/agb.yaml'
groupBy:
type: array
items:
type: object
properties:
item:
$ref: ../schemas/StatisticsGroupBy-enum.yaml
description: All possible enum values are always in the output.
active:
type: boolean
description: True if authorised, otherwise false.
400:
$ref: '../zoo-api.yaml#/components/responses/ReqFailure'
401:
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
404:
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'