develop #38
@ -4,15 +4,15 @@ info:
|
||||
version: "1.0"
|
||||
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
|
||||
servers:
|
||||
- url: https://api.integratielaag.nl/v2
|
||||
- url: https://api.integratielaag.nl
|
||||
paths:
|
||||
/customers/list:
|
||||
/customers:
|
||||
get:
|
||||
tags:
|
||||
- ABTCustomers
|
||||
summary: Search customer profiles
|
||||
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:
|
||||
- name: customerProfileId
|
||||
in: query
|
||||
@ -32,13 +32,15 @@ paths:
|
||||
- name: debtorNumber
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
example: 100001
|
||||
type: string
|
||||
example: DB100001
|
||||
- name: debtorStatusId
|
||||
in: query
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
example: 1
|
||||
description: Filter on possible debtor status. 1 = active, 2 = inactive
|
||||
- name: birthname
|
||||
in: query
|
||||
schema:
|
||||
@ -90,7 +92,7 @@ paths:
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: The Netherlands
|
||||
example: NL
|
||||
- name: phoneNumber
|
||||
in: query
|
||||
schema:
|
||||
@ -111,10 +113,10 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
example: My ovchipcard
|
||||
- name: ovPayTokenNumber
|
||||
- name: ovPasNumber
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
type: string
|
||||
example: 0123456789
|
||||
- name: ovPayTokenAlias
|
||||
in: query
|
||||
@ -144,13 +146,17 @@ paths:
|
||||
customers:
|
||||
- customerProfileId: 1
|
||||
customerNumber: 1000001
|
||||
debtorNumber: TEST001
|
||||
debtorNumber: DB100001
|
||||
debtorStatus:
|
||||
debtorStatusId: 1
|
||||
name: Inactive
|
||||
vascustomerNumber: CST005
|
||||
customerPreference:
|
||||
language:
|
||||
languageId: 1
|
||||
name: Dutch
|
||||
ietfCode: nl-NL
|
||||
iso639Code: nl
|
||||
customerStatusInstances:
|
||||
- customerStatus:
|
||||
name: Active
|
||||
@ -165,11 +171,11 @@ paths:
|
||||
person:
|
||||
birthname: Pieter
|
||||
surname: De valen
|
||||
prefix: dhr
|
||||
suffix: De
|
||||
prefix: De
|
||||
suffix: dhr
|
||||
dateOfBirth: "2002-10-29"
|
||||
emailAddress: TEST@HTM.NL
|
||||
address:
|
||||
emailAddresses: TEST@HTM.NL
|
||||
addresses:
|
||||
- addressId: 1
|
||||
street: mystreet
|
||||
houseNumber: 1
|
||||
@ -192,22 +198,22 @@ paths:
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
phone:
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
countryCode: NL
|
||||
countryCode: "+31"
|
||||
phoneType:
|
||||
phoneTypeId: 1
|
||||
name: Home
|
||||
isPreferred: true
|
||||
- phoneId: 2
|
||||
number: "333225588"
|
||||
countryCode: ES
|
||||
countryCode: "+31"
|
||||
phoneType:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
ovChipCard:
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: 1234123412341234
|
||||
validUntil: "2023-01-01"
|
||||
@ -216,7 +222,7 @@ paths:
|
||||
chipCardNumber: 1234123412341235
|
||||
validUntil: "2025-01-01"
|
||||
alias: alias
|
||||
ovPayToken:
|
||||
ovPayTokens:
|
||||
- ovPayTokenId: 126
|
||||
tokenType:
|
||||
tokenTypeId: 1
|
||||
@ -260,7 +266,11 @@ paths:
|
||||
name: Inactive
|
||||
vascustomerNumber: CST005
|
||||
customerPreference:
|
||||
language:
|
||||
languageId: 1
|
||||
name: Dutch
|
||||
ietfCode: nl-NL
|
||||
iso639Code: nl
|
||||
customerStatusInstances:
|
||||
- customerStatus:
|
||||
name: Active
|
||||
@ -275,10 +285,10 @@ paths:
|
||||
person:
|
||||
birthname: Pieter
|
||||
surname: De valen
|
||||
prefix: dhr
|
||||
suffix: De
|
||||
prefix: De
|
||||
suffix: Dhr
|
||||
dateOfBirth: "2002-10-29"
|
||||
emailAddress: TEST@HTM.NL
|
||||
emailAddresses: TEST@HTM.NL
|
||||
address:
|
||||
- addressId: 1
|
||||
street: mystreet
|
||||
@ -302,22 +312,22 @@ paths:
|
||||
addressType:
|
||||
addressTypeId: 2
|
||||
name: Office
|
||||
phone:
|
||||
phones:
|
||||
- phoneId: 1
|
||||
number: "3112345678"
|
||||
countryCode: NL
|
||||
countryCode: "+31"
|
||||
phoneType:
|
||||
phoneTypeId: 1
|
||||
name: Home
|
||||
isPreferred: true
|
||||
- phoneId: 2
|
||||
number: "333225588"
|
||||
countryCode: ES
|
||||
countryCode: "+31"
|
||||
phoneType:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
ovChipCard:
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: 1234123412341234
|
||||
validUntil: "2023-01-01"
|
||||
@ -326,7 +336,7 @@ paths:
|
||||
chipCardNumber: 1234123412341235
|
||||
validUntil: "2025-01-01"
|
||||
alias: alias
|
||||
ovPayToken:
|
||||
ovPayTokens:
|
||||
- ovPayTokenId: 126
|
||||
tokenType:
|
||||
tokenTypeId: 2
|
||||
@ -391,278 +401,6 @@ paths:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
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:
|
||||
tags:
|
||||
- ABTCustomers
|
||||
@ -721,11 +459,11 @@ paths:
|
||||
addressTypeId: 2
|
||||
phones:
|
||||
- number: "6123456789"
|
||||
countryCode: "0031"
|
||||
countryCode: "+31"
|
||||
phoneTypeId: 1
|
||||
isPreferred: true
|
||||
- number: "7012345678"
|
||||
countryCode: "0031"
|
||||
countryCode: "+31"
|
||||
phoneTypeId: 2
|
||||
isPreferred: false
|
||||
required: true
|
||||
@ -1092,7 +830,7 @@ components:
|
||||
format: datetime
|
||||
correlationId:
|
||||
type: string
|
||||
ovPayToken:
|
||||
getOvPayTokens:
|
||||
type: object
|
||||
properties:
|
||||
ovPayTokenId:
|
||||
@ -1115,7 +853,7 @@ components:
|
||||
type: string
|
||||
replacedByTokenId:
|
||||
type: integer
|
||||
getOvChipCard:
|
||||
getOvChipcards:
|
||||
type: object
|
||||
properties:
|
||||
ovChipCardId:
|
||||
@ -1166,18 +904,18 @@ components:
|
||||
dateOfBirth:
|
||||
type: string
|
||||
format: date
|
||||
emailAddress:
|
||||
emailAddresses:
|
||||
type: string
|
||||
format: email
|
||||
address:
|
||||
addresses:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/getAddress"
|
||||
phone:
|
||||
$ref: "#/components/schemas/getAddresses"
|
||||
phones:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/getPhone"
|
||||
getAddress:
|
||||
$ref: "#/components/schemas/getPhones"
|
||||
getAddresses:
|
||||
type: object
|
||||
properties:
|
||||
addressId:
|
||||
@ -1205,7 +943,7 @@ components:
|
||||
type: integer
|
||||
name:
|
||||
type: string
|
||||
getPhone:
|
||||
getPhones:
|
||||
type: object
|
||||
properties:
|
||||
phoneId:
|
||||
@ -1226,11 +964,22 @@ components:
|
||||
name:
|
||||
type: string
|
||||
getCustomerPreference:
|
||||
type: object
|
||||
properties:
|
||||
language:
|
||||
$ref: "#/components/schemas/getCustomerLanguage"
|
||||
getCustomerLanguage:
|
||||
type: object
|
||||
properties:
|
||||
languageId:
|
||||
type: integer
|
||||
getCustomerProfileList:
|
||||
name:
|
||||
type: string
|
||||
ietfCode:
|
||||
type: string
|
||||
iso639Code:
|
||||
type: string
|
||||
getCustomerProfiles:
|
||||
type: object
|
||||
properties:
|
||||
customers:
|
||||
@ -1256,14 +1005,14 @@ components:
|
||||
$ref: "#/components/schemas/getCustomerStatusInstance"
|
||||
person:
|
||||
$ref: "#/components/schemas/getPerson"
|
||||
ovChipCard:
|
||||
ovChipcards:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/getOvChipCard"
|
||||
ovPayToken:
|
||||
$ref: "#/components/schemas/getOvChipcards"
|
||||
ovPayTokens:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/ovPayToken"
|
||||
$ref: "#/components/schemas/getOvPayTokens"
|
||||
audit:
|
||||
type: array
|
||||
items:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user