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

47 lines
1.6 KiB
YAML

get:
tags:
- population
operationId: "populationStatisticsDeprivedNeighborhood"
summary: "Get a deprived neighborhood versus regular count."
description: |-
Patients who are no longer registrered are excluded, so only patients with an active registration are included. Passer-by and NONI-patients are excluded. Patients without birthdate are excluded (rare).
parameters:
- name: referenceDate
in: query
required: true
schema:
type: "string"
pattern: "\\d\\d\\d\\d-\\d\\d-\\d\\d"
format: "date"
description: ISO formatted date
example: 2015-12-15
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses:
200:
description: "The response body is a JSON-array with exactly two objects."
content:
application/json:
schema:
type: array
items:
oneOf:
- type: object
properties:
deprivedNeighborhood:
type: number
example: 42
- type: object
properties:
regularNeighborhood:
type: number
example: 256
400:
description: "Common HTTP semantics, see the response body."
401:
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
403:
description: "Indicated practice is known but has not authorized ZOO to share this information with signer."
404:
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'