[subscription] Reflect updates to subscription API for `customer/basic`.

live
Reinier Zwitserloot 1 year ago
parent e088891bac
commit 287794204c
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -5,8 +5,10 @@ get:
summary: Basic info summary: Basic info
parameters: parameters:
- name: agb - name: agb
in: path in: query
description: AGB of the practice which is known as Zorg op Orde customer (via a care group). description: |-
AGB of the practice for which basic info is requested.
If the requesting entity is a single GP practice, this parameter can be omitted.
schema: schema:
$ref: ../schemas/agb.yaml $ref: ../schemas/agb.yaml
responses: responses:
@ -30,13 +32,10 @@ get:
institutionAgb: institutionAgb:
description: The AGB of the institution, if the customer is a care group or other institute, otherwise omitted. One of practiceAgb or institutionAgb is always present. description: The AGB of the institution, if the customer is a care group or other institute, otherwise omitted. One of practiceAgb or institutionAgb is always present.
$ref: ../schemas/agb.yaml $ref: ../schemas/agb.yaml
setGpisType:
description: The intended GPIS type. This may differ from the actual import in the `gpis` property. Especially if the GPIS type is newly changed.
type: string
gpis: gpis:
$ref: ../schemas/GPIS.yaml $ref: ../schemas/GPIS.yaml
doctors: doctors:
description: AGB's of the doctors working in the practice. description: AGBs of the doctors working in the practice.
type: array type: array
items: items:
$ref: '../schemas/PatIdentity.yaml#/doctor' $ref: '../schemas/PatIdentity.yaml#/doctor'
@ -93,38 +92,37 @@ post:
description: Only certain properties of a practice can be updated. After updating the same response is outputted as when using GET. description: Only certain properties of a practice can be updated. After updating the same response is outputted as when using GET.
parameters: parameters:
- name: agb - name: agb
in: path in: query
description: AGB of the practice which is known as Zorg op Orde customer (via a care group). description: |-
AGB of the practice for which basic info is requested.
If the requesting entity is a single GP practice, this parameter can be omitted.
schema: schema:
$ref: ../schemas/agb.yaml $ref: ../schemas/agb.yaml
requestBody: requestBody:
description: |- description: |-
When authorized as a care group the GPIS type can be changed. As a practice the address and When authorized as a practice the address and contact data can be changed.
contact data can be changed. This request cannot be used to remove or set any of these properties empty. Currently, if authorized as a care group, no properties can be changed.
Properties can be omitted if you do not want to change them. `address1` and `postcode` cannot be set to empty.
content: content:
'application/x-www-form-urlencoded': 'application/x-www-form-urlencoded':
schema: schema:
oneOf: type: object
- type: object properties:
properties: address1:
gpisType: type: string
$ref: '../schemas/gpisType.yaml' description: The first line of the practice postal address (street name and house number, generally).
- type: object postcode:
properties: description: Any valid Dutch postcode, with or without whitespacing and in lower- or uppercase.
address1: $ref: ../schemas/postcode.yaml
type: string city:
description: The first line of the practice postal address (street name and house number, generally). $ref: ../schemas/city.yaml
postcode: tel:
description: Any valid Dutch postcode, with or without whitespacing and in lower- or uppercase. description: A Dutch phone number of 10 digits. Additional dashes and spacing are removed before validating.
$ref: ../schemas/postcode.yaml type: string
city: email:
$ref: ../schemas/city.yaml type: string
tel: format: email
description: A Dutch phone number of 10 digits. Additional dashes and spacing are removed before validating.
type: string
email:
type: string
format: email
responses: responses:
$ref: '#/get/responses' $ref: '#/get/responses'

@ -1,25 +0,0 @@
get:
operationId: customerGpisType
tags:
- Customer management
summary: GPIS types
description: Names used for identifying GPIS's (or EDP's) in this API.
responses:
'200':
description: Names of GPIS's (or EDP's) as recognized by Zorg op Orde.
content:
application/json:
schema:
type: array
items:
type: object
properties:
gpisType:
$ref: ../schemas/gpisType.yaml
"description":
type: string
example: "Een innovatief HIS and NIS."
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'

@ -89,10 +89,8 @@ paths:
$ref: 'paths/customer_careprogram.yaml' $ref: 'paths/customer_careprogram.yaml'
/customer/careprogram/periodEnd: /customer/careprogram/periodEnd:
$ref: 'paths/customer_careprogram_periodEnd.yaml' $ref: 'paths/customer_careprogram_periodEnd.yaml'
/customer/basic/{agb}: /customer/basic:
$ref: 'paths/customer_basic_{agb}.yaml' $ref: 'paths/customer_basic.yaml'
/customer/gpisType:
$ref: 'paths/customer_gpisType.yaml'
/exports/available: /exports/available:
$ref: 'paths/exports_available.yaml' $ref: 'paths/exports_available.yaml'
/exports/{agb}/{filename}: /exports/{agb}/{filename}:

Loading…
Cancel
Save