src/openapi/customers/SE-customers.yaml

@@ -13,6 +13,127 @@ tags:
       Service Engine APIs for HTM Customers. These are NOT the CRUD APIs to access raw data in the database.
       To be used by touchpoints to get information about HTM customers.
 paths:
+   /customers:
+    get:
+      tags:
+        - ServiceEngine Customers
+      summary: Get a customer profile based on search parameters, only returns a unique profile    
+      parameters:
+        - name: customerProfileId
+          in: query  
+          schema:
+            type: integer
+            example: 1
+        - name: customerNumber
+          in: query
+          schema:
+            type: integer
+            example: 1
+        - name: debtorNumber
+          in: query
+          schema:
+            type: integer
+            example: 1
+        - name: birthname
+          in: query
+          schema:
+            type: string
+            example: Jon
+        - name: surname
+          in: query
+          schema:
+            type: string
+            example: Doe
+        - name: emailAdress
+          in: query
+          schema:
+            type: string
+            format: email
+            example: jon.doe@mymailprovider.com
+        - name: dateOfBirth
+          in: query
+          schema:
+            type: string
+            format: date
+            example: "2000-01-01"
+        - name: addressStreet
+          in: query
+          schema:
+            type: string
+            example: Sesamestreet      
+        - name: addressHouseNumber
+          in: query
+          schema:
+            type: integer
+            example: 1      
+        - name: addressHouseNumberSuffix
+          in: query
+          schema:
+            type: string
+            example: A      
+        - name: addressPostalCode
+          in: query
+          schema:
+            type: string
+            example: 1234 AB      
+        - name: addressCity
+          in: query
+          schema:
+            type: string
+            example: The Hague              
+        - name: addressCountry
+          in: query
+          schema:
+            type: string
+            example: The Netherlands              
+        - name: phoneNumber
+          in: query
+          schema:
+            type: string
+            example: The Netherlands              
+        - name: ovChipcardNumber
+          in: query
+          schema:
+            type: integer
+            example: 0123456789              
+        - name: OvChipcardAlias
+          in: query
+          schema:
+            type: string
+            example: My ovchipcard              
+        - name: ovPayTokenNumber
+          in: query
+          schema:
+            type: integer
+            example: 0123456789              
+        - name: ovPayTokenAlias
+          in: query
+          schema:
+            type: string
+            example: My Ov Pay Token              
+        - name: ovPayTokenXTat
+          in: query
+          schema:
+            type: string
+            example: 180d04e0-a721-447e-a1d9-b416937b43bc             
+        - name: ovPayTokenXBot
+          in: query
+          schema:
+            type: string
+            example: e1307c73-676a-4d07-967b-6141276f7c7c
+      responses:
+          '200':
+            description: Ok
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/CustomersResponse' 
+          '404':
+            description: Customer not found
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/CustomersResponse'
   /customers/tokens/{tokenId}/product-instances:
     get:
       tags:
@@ -52,3 +173,5 @@ components:
       properties:
         Entries:
           type: array
+    CustomersResponse:
+      type: object