HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

first fixes

Browse Source
This commit is contained in:
Mirjam Herald 2025-01-06 12:41:45 +01:00
parent 27351f1101
commit 42dce39642
1 changed files with 69 additions and 320 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

379
src/openapi/customers/customers-crud-v2.yaml
View File

@ -4,15 +4,15 @@ info:
version: "1.0" version: "1.0"
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine. description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
servers: servers:
- url: https://api.integratielaag.nl/v2 - url: https://api.integratielaag.nl
paths: paths:
/customers/list: /customers:
get: get:
tags: tags:
- ABTCustomers - ABTCustomers
summary: Search customer profiles summary: Search customer profiles
description: >- description: >-
Search for all customer profile list in the ABT database matching certain query parameters Search for all customer profile list in the ABT database matching given query parameters
parameters: parameters:
- name: customerProfileId - name: customerProfileId
in: query in: query
@ -32,13 +32,15 @@ paths:
- name: debtorNumber - name: debtorNumber
in: query in: query
schema: schema:
type: integer type: string
example: 100001 example: DB100001
- name: debtorStatusId - name: debtorStatusId
in: query in: query
schema: schema:
type: array
items:
type: integer type: integer
example: 1 description: Filter on possible debtor status. 1 = active, 2 = inactive
- name: birthname - name: birthname
in: query in: query
schema: schema:
@ -90,7 +92,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: The Netherlands example: NL
- name: phoneNumber - name: phoneNumber
in: query in: query
schema: schema:
@ -111,10 +113,10 @@ paths:
schema: schema:
type: string type: string
example: My ovchipcard example: My ovchipcard
- name: ovPayTokenNumber - name: ovPasNumber
in: query in: query
schema: schema:
type: integer type: string
example: 0123456789 example: 0123456789
- name: ovPayTokenAlias - name: ovPayTokenAlias
in: query in: query
@ -144,13 +146,17 @@ paths:
customers: customers:
- customerProfileId: 1 - customerProfileId: 1
customerNumber: 1000001 customerNumber: 1000001
debtorNumber: TEST001 debtorNumber: DB100001
debtorStatus: debtorStatus:
debtorStatusId: 1 debtorStatusId: 1
name: Inactive name: Inactive
vascustomerNumber: CST005 vascustomerNumber: CST005
customerPreference: customerPreference:
language:
languageId: 1 languageId: 1
name: Dutch
ietfCode: nl-NL
iso639Code: nl
customerStatusInstances: customerStatusInstances:
- customerStatus: - customerStatus:
name: Active name: Active
@ -165,11 +171,11 @@ paths:
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: De valen
prefix: dhr prefix: De
suffix: De suffix: dhr
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddress: TEST@HTM.NL emailAddresses: TEST@HTM.NL
address: addresses:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
houseNumber: 1 houseNumber: 1
@ -192,22 +198,22 @@ paths:
addressType: addressType:
addressTypeId: 2 addressTypeId: 2
name: Office name: Office
phone: phones:
- phoneId: 1 - phoneId: 1
number: "3112345678" number: "3112345678"
countryCode: NL countryCode: "+31"
phoneType: phoneType:
phoneTypeId: 1 phoneTypeId: 1
name: Home name: Home
isPreferred: true isPreferred: true
- phoneId: 2 - phoneId: 2
number: "333225588" number: "333225588"
countryCode: ES countryCode: "+31"
phoneType: phoneType:
phoneTypeId: 2 phoneTypeId: 2
name: Work name: Work
isPreferred: false isPreferred: false
ovChipCard: ovChipcards:
- ovChipCardId: 1 - ovChipCardId: 1
chipCardNumber: 1234123412341234 chipCardNumber: 1234123412341234
validUntil: "2023-01-01" validUntil: "2023-01-01"
@ -216,7 +222,7 @@ paths:
chipCardNumber: 1234123412341235 chipCardNumber: 1234123412341235
validUntil: "2025-01-01" validUntil: "2025-01-01"
alias: alias alias: alias
ovPayToken: ovPayTokens:
- ovPayTokenId: 126 - ovPayTokenId: 126
tokenType: tokenType:
tokenTypeId: 1 tokenTypeId: 1
@ -260,7 +266,11 @@ paths:
name: Inactive name: Inactive
vascustomerNumber: CST005 vascustomerNumber: CST005
customerPreference: customerPreference:
language:
languageId: 1 languageId: 1
name: Dutch
ietfCode: nl-NL
iso639Code: nl
customerStatusInstances: customerStatusInstances:
- customerStatus: - customerStatus:
name: Active name: Active
@ -275,10 +285,10 @@ paths:
person: person:
birthname: Pieter birthname: Pieter
surname: De valen surname: De valen
prefix: dhr prefix: De
suffix: De suffix: Dhr
dateOfBirth: "2002-10-29" dateOfBirth: "2002-10-29"
emailAddress: TEST@HTM.NL emailAddresses: TEST@HTM.NL
address: address:
- addressId: 1 - addressId: 1
street: mystreet street: mystreet
@ -302,22 +312,22 @@ paths:
addressType: addressType:
addressTypeId: 2 addressTypeId: 2
name: Office name: Office
phone: phones:
- phoneId: 1 - phoneId: 1
number: "3112345678" number: "3112345678"
countryCode: NL countryCode: "+31"
phoneType: phoneType:
phoneTypeId: 1 phoneTypeId: 1
name: Home name: Home
isPreferred: true isPreferred: true
- phoneId: 2 - phoneId: 2
number: "333225588" number: "333225588"
countryCode: ES countryCode: "+31"
phoneType: phoneType:
phoneTypeId: 2 phoneTypeId: 2
name: Work name: Work
isPreferred: false isPreferred: false
ovChipCard: ovChipcards:
- ovChipCardId: 1 - ovChipCardId: 1
chipCardNumber: 1234123412341234 chipCardNumber: 1234123412341234
validUntil: "2023-01-01" validUntil: "2023-01-01"
@ -326,7 +336,7 @@ paths:
chipCardNumber: 1234123412341235 chipCardNumber: 1234123412341235
validUntil: "2025-01-01" validUntil: "2025-01-01"
alias: alias alias: alias
ovPayToken: ovPayTokens:
- ovPayTokenId: 126 - ovPayTokenId: 126
tokenType: tokenType:
tokenTypeId: 2 tokenTypeId: 2
@ -391,278 +401,6 @@ paths:
- default: [] - default: []
x-auth-type: Application & Application User x-auth-type: Application & Application User
x-throttling-tier: Unlimited x-throttling-tier: Unlimited
/customers:
get:
tags:
- ABTCustomers
summary: Search for customer profile
description: "Search for a unique customer profile in the ABT database with query parameters "
parameters:
- name: customerProfileId
in: query
schema:
type: integer
example: 1
- name: customerNumber
in: query
schema:
type: integer
example: 1000001
- name: customerStatusId
in: query
schema:
type: integer
example: 1
- name: debtorNumber
in: query
schema:
type: integer
example: 100001
- name: debtorStatusId
in: query
schema:
type: integer
example: 1
- name: birthname
in: query
schema:
type: string
example: John
- name: surname
in: query
schema:
type: string
example: Doe
- name: emailAddress
in: query
schema:
type: string
format: email
example: john.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: "0123456789"
- name: phoneCountryCode
in: query
schema:
type: string
example: "+31"
- 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: Successfully retrieved a customer profile
content:
application/json:
schema:
$ref: "#/components/schemas/getCustomerProfile"
examples:
fullCustomerProfile:
value:
customerProfileId: 1
customerNumber: 1000001
debtorNumber: TEST001
debtorStatus:
debtorStatusId: 1
name: Inactive
vascustomerNumber: CST005
customerPreference:
languageId: 1
customerStatusInstances:
- customerStatus:
name: Active
customerStatusId: 2
fromInclusive: "2022-08-04 15:01:00.000"
toInclusive: "2022-08-05 15:01:00.000"
- customerStatus:
name: Blocked
customerStatusId: 3
fromInclusive: "2022-08-05 15:01:00.000"
toInclusive: null
person:
birthname: Pieter
surname: De valen
prefix: dhr
suffix: De
dateOfBirth: "2002-10-29"
emailAddress: TEST@HTM.NL
address:
- addressId: 1
street: mystreet
houseNumber: 1
houseNumberSuffix: null
postalCode: 0000AA
city: Den Haag
country: NL
isPreferred: false
addressType:
addressTypeId: 2
name: Office
- addressId: 2
street: mystreet 33
houseNumber: 1
houseNumberSuffix: null
postalCode: 4455CA
city: Den BOSCH
country: NL
isPreferred: true
addressType:
addressTypeId: 2
name: Office
phone:
- phoneId: 1
number: "3112345678"
countryCode: NL
phoneType:
phoneTypeId: 1
name: Home
isPreferred: true
- phoneId: 2
number: "333225588"
countryCode: ES
phoneType:
phoneTypeId: 2
name: Work
isPreferred: false
ovChipCard:
- ovChipCardId: 1
chipCardNumber: 1234123412341234
validUntil: "2023-01-01"
alias: alias
- ovChipCardId: 2
chipCardNumber: 1234123412341235
validUntil: "2025-01-01"
alias: alias
ovPayToken:
- ovPayTokenId: 126
tokenType:
tokenTypeId: 1
name: EMV
xTat: twioq73033
xBot: hjihwqui27
alias: alias
lastDigits: "5678"
ovpasNumber: null
tokenStatus:
tokenStatusId: 2
name: Active
expirationDate: "2025-04-20T17:05:52.000+02:00"
replacedByTokenId: 1
- ovPayTokenId: 127
tokenType:
tokenTypeId: 2
name: OV-pas physical
xTat: hhe2830283
xBot: jdhd828033
alias: alias
lastDigits: "5674"
ovpasNumber: OV34568
tokenStatus:
tokenStatusId: 2
name: Active
expirationDate: "2024-04-20T17:05:52.000+02:00"
replacedByTokenId: 2
audit:
- auditTrailId: 1
customerProfileId: 1
action: insert
user: user
timestamp: "2023-10-20T17:05:52.000+02:00"
correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95
400:
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/400Response"
401:
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/401Response"
404:
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/404Response"
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: "#/components/schemas/500Response"
security:
- default: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
post: post:
tags: tags:
- ABTCustomers - ABTCustomers
@ -721,11 +459,11 @@ paths:
addressTypeId: 2 addressTypeId: 2
phones: phones:
- number: "6123456789" - number: "6123456789"
countryCode: "0031" countryCode: "+31"
phoneTypeId: 1 phoneTypeId: 1
isPreferred: true isPreferred: true
- number: "7012345678" - number: "7012345678"
countryCode: "0031" countryCode: "+31"
phoneTypeId: 2 phoneTypeId: 2
isPreferred: false isPreferred: false
required: true required: true
@ -1092,7 +830,7 @@ components:
format: datetime format: datetime
correlationId: correlationId:
type: string type: string
ovPayToken: getOvPayTokens:
type: object type: object
properties: properties:
ovPayTokenId: ovPayTokenId:
@ -1115,7 +853,7 @@ components:
type: string type: string
replacedByTokenId: replacedByTokenId:
type: integer type: integer
getOvChipCard: getOvChipcards:
type: object type: object
properties: properties:
ovChipCardId: ovChipCardId:
@ -1166,18 +904,18 @@ components:
dateOfBirth: dateOfBirth:
type: string type: string
format: date format: date
emailAddress: emailAddresses:
type: string type: string
format: email format: email
address: addresses:
type: array type: array
items: items:
$ref: "#/components/schemas/getAddress" $ref: "#/components/schemas/getAddresses"
phone: phones:
type: array type: array
items: items:
$ref: "#/components/schemas/getPhone" $ref: "#/components/schemas/getPhones"
getAddress: getAddresses:
type: object type: object
properties: properties:
addressId: addressId:
@ -1205,7 +943,7 @@ components:
type: integer type: integer
name: name:
type: string type: string
getPhone: getPhones:
type: object type: object
properties: properties:
phoneId: phoneId:
@ -1226,11 +964,22 @@ components:
name: name:
type: string type: string
getCustomerPreference: getCustomerPreference:
type: object
properties:
language:
$ref: "#/components/schemas/getCustomerLanguage"
getCustomerLanguage:
type: object type: object
properties: properties:
languageId: languageId:
type: integer type: integer
getCustomerProfileList: name:
type: string
ietfCode:
type: string
iso639Code:
type: string
getCustomerProfiles:
type: object type: object
properties: properties:
customers: customers:
@ -1256,14 +1005,14 @@ components:
$ref: "#/components/schemas/getCustomerStatusInstance" $ref: "#/components/schemas/getCustomerStatusInstance"
person: person:
$ref: "#/components/schemas/getPerson" $ref: "#/components/schemas/getPerson"
ovChipCard: ovChipcards:
type: array type: array
items: items:
$ref: "#/components/schemas/getOvChipCard" $ref: "#/components/schemas/getOvChipcards"
ovPayToken: ovPayTokens:
type: array type: array
items: items:
$ref: "#/components/schemas/ovPayToken" $ref: "#/components/schemas/getOvPayTokens"
audit: audit:
type: array type: array
items: items: