55 lines
1.9 KiB
YAML
55 lines
1.9 KiB
YAML
openapi: 3.0.1
|
|
info:
|
|
title: Service Engine APIs for Customers
|
|
description: >-
|
|
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.
|
|
version: '1.0'
|
|
servers:
|
|
- url: https://api.integratielaag.nl/abt/serviceengine/customers/1.0
|
|
tags:
|
|
- name: ServiceEngine Customers
|
|
description: >-
|
|
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/tokens/{tokenId}/product-instances:
|
|
get:
|
|
tags:
|
|
- ServiceEngine Customers
|
|
summary: Get a list of all HTM products instantiated on the given OvPayToken
|
|
description: |-
|
|
Get a list of all HTM products instantiated on the given OvPayToken.
|
|
Only HTM products are returned; GBO does not allow HTM to get information on non-HTM product-instances.
|
|
Where relevant, operations to be performed are returned as HATEOAS links per product-instance.
|
|
parameters:
|
|
- name: tokenId
|
|
in: path
|
|
required: true
|
|
style: simple
|
|
description: Id of the OvPayToken to get product-instances for.
|
|
schema:
|
|
type: integer
|
|
example: 1
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TokenProductInstancesResponse'
|
|
examples:
|
|
getEmptyProductInstances:
|
|
summary: No product-instances found on token
|
|
value:
|
|
Entries: []
|
|
components:
|
|
schemas:
|
|
TokenProductInstancesResponse:
|
|
type: object
|
|
required:
|
|
- Entries
|
|
properties:
|
|
Entries:
|
|
type: array
|