Customer basic info GET improved and POST added.

paths/customer_basic_{agb}.yaml

@@ -1,11 +1,11 @@
 get:
-  operationId: customerBasic
+  operationId: customerBasicGet
   tags:
     - Customer management
   summary: Basic info
   parameters:
     - name: agb
-      in: query
+      in: path
       description: AGB of the practice which is known as Zorg op Orde customer (via a care group).
       schema:
         $ref: ../schemas/agb.yaml
@@ -30,6 +30,9 @@ get:
                   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.
                     $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:
                     $ref: ../schemas/GPIS.yaml
                   doctors:
@@ -81,4 +84,47 @@ get:
     '401':
       $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
     '403':
-      $ref: '../zoo-api.yaml/#/components/responses/NoAccess'
+      $ref: '../zoo-api.yaml/#/components/responses/NoAccess'
+post:
+  operationId: customerBasicPost
+  tags:
+    - Customer management
+  summary: Basic info
+  description: Only certain properties of a practice can be updated. After updating the same response is outputted as when using GET.
+  parameters:
+    - name: agb
+      in: path
+      description: AGB of the practice which is known as Zorg op Orde customer (via a care group).
+      schema:
+        $ref: ../schemas/agb.yaml
+  requestBody:
+    description: |-
+      When authorized as a care group the GPIS type can be changed. As a practice the address and 
+      contact data can be changed. This request cannot be used to remove or set any of these properties empty.
+    content:
+      'application/x-www-form-urlencoded':
+        schema:
+          oneOf:
+          - type: object
+            properties:
+              gpisType:
+                $ref: '../schemas/gpisType.yaml'
+          - type: object
+            properties:
+              address1:
+                type: string
+                description: The first line of the practice postal address (street name and house number, generally).
+              postcode:
+                description: Any valid Dutch postcode, with or without whitespacing and in lower- or uppercase.
+                $ref: ../schemas/postcode.yaml
+              city:
+                $ref: ../schemas/city.yaml
+              tel:
+                description: A Dutch phone number of 10 digits. Additional dashes and spacing are removed before validating.
+                type: string
+              email:
+                type: string
+                format: email
+  responses: 
+    $ref: '#/get/responses'
+    

paths/customer_gpisType.yaml

@@ -0,0 +1,25 @@
+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'

schemas/GPIS.yaml

@@ -3,9 +3,7 @@ description: |-
 type: object
 properties:
   gpisType:
-    description: The type of GP Information System
-    type: string
-    example: Tetrapod
+    $ref: gpisType.yaml
   timestamp:
     description: |-
       The report is based on dossier data as it was on this timestamp; due to inaccuracies by GP information systems that source the data,

schemas/gpisType.yaml

@@ -0,0 +1,13 @@
+type: string
+description: |-
+  Type brand (or type) of the general practitioner information system (EDP). Query the `/customer/gpisType` end point for a list of all brands.
+enum:
+  - healthconnected
+  - medicom
+  - scipio
+  - microhis
+  - promedico
+  - tetra
+  - sanday
+  - microhis
+  - medikit

zoo-api.yaml

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