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/customer_basic.yaml

64 lines
2.2 KiB
YAML

get:
operationId: customerBasic
tags:
- Customer management
summary: Basic info
parameters:
- name: agb
in: query
description: AGB of the practice which is known as Zorg op Orde customer (via a care group).
schema:
$ref: ../schemas/agb.yaml
- name: unid
in: query
description: Internal number used by Zorg op Orde
schema:
type: integer
responses:
'200':
description: Basic information of a practice.
content:
application/json:
schema:
type: object
properties:
practice:
type: object
properties:
name:
type: string
agb:
$ref: ../schemas/agb.yaml
gpis:
$ref: ../schemas/GPIS.yaml
address:
type: object
properties:
streetHouseNumber:
type: string
postcode:
$ref: ../schemas/postcode.yaml
city:
$ref: ../schemas/city.yaml
contact:
type: object
properties:
tel:
type: string
email:
type: string
dataProcessing:
type: object
properties:
controller:
type: string
description: Usually is the practice owner the data controller.
dataProcessingAgreement:
example: If set, the date of the data processing agreement between the controller (general practitioner) and processor (Zorg op Orde).
$ref: ../schemas/date.yaml
'400':
description: If the specified customer is not a practice but some other entity, e.g. a care group.
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'