OVPAY-2018 - Added endpoints and examples for Customer Devices.
This commit is contained in:
parent
840b62f493
commit
f5bf3d62de
@ -278,6 +278,13 @@ paths:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
devices:
|
||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
||||
alias: "iPhone zakelijk"
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: "1234123412341234"
|
||||
@ -404,6 +411,13 @@ paths:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
devices:
|
||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
||||
alias: "iPhone zakelijk"
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: "1234123412341234"
|
||||
@ -543,6 +557,13 @@ paths:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
devices:
|
||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
||||
alias: "iPhone zakelijk"
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: "1234123412341234"
|
||||
@ -677,6 +698,13 @@ paths:
|
||||
phoneTypeId: 2
|
||||
name: Work
|
||||
isPreferred: false
|
||||
devices:
|
||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
||||
alias: "iPhone zakelijk"
|
||||
ovChipcards:
|
||||
- ovChipCardId: 1
|
||||
chipCardNumber: "1234123412341234"
|
||||
@ -823,6 +851,11 @@ paths:
|
||||
countryCode: "+31"
|
||||
phoneTypeId: 2
|
||||
isPreferred: false
|
||||
devices:
|
||||
- externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
- externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
||||
alias: "iPhone zakelijk"
|
||||
required: true
|
||||
responses:
|
||||
201:
|
||||
@ -1027,7 +1060,7 @@ paths:
|
||||
/customers/{customerProfileId}/addresses:
|
||||
post:
|
||||
tags:
|
||||
- Customer address
|
||||
- Addresses
|
||||
summary: Add a customer address
|
||||
description: >-
|
||||
|
||||
@ -1069,7 +1102,7 @@ paths:
|
||||
/addresses/{addressId}:
|
||||
patch:
|
||||
tags:
|
||||
- Customer address
|
||||
- Addresses
|
||||
summary: Edit a customer address
|
||||
description: >-
|
||||
|
||||
@ -1109,7 +1142,7 @@ paths:
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- Customer address
|
||||
- Addresses
|
||||
summary: Delete a customer address
|
||||
description: >-
|
||||
|
||||
@ -1132,8 +1165,8 @@ paths:
|
||||
/customers/{customerProfileId}/phones:
|
||||
post:
|
||||
tags:
|
||||
- Customer phoneNumber
|
||||
summary: Add a customer phonenumber
|
||||
- Phones
|
||||
summary: Add a customer phone
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1171,8 +1204,8 @@ paths:
|
||||
/phones/{phoneId}:
|
||||
patch:
|
||||
tags:
|
||||
- Customer phoneNumber
|
||||
summary: Edit a customer phonenumber
|
||||
- Phones
|
||||
summary: Edit a customer phone
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1213,7 +1246,7 @@ paths:
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- Customer phoneNumber
|
||||
- Phones
|
||||
summary: Delete a customer phone
|
||||
description: >-
|
||||
|
||||
@ -1233,12 +1266,202 @@ paths:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/devices:
|
||||
get:
|
||||
tags:
|
||||
- Devices
|
||||
summary: Find devices.
|
||||
description: Find devices.
|
||||
parameters:
|
||||
- in: query
|
||||
name: deviceId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
||||
required: false
|
||||
description: The id of the device.
|
||||
- in: query
|
||||
name: externalDeviceId
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: c5545584-04af-4c60-a955-d6a70baab848
|
||||
required: false
|
||||
description: The external id of the device.
|
||||
- in: query
|
||||
name: alias
|
||||
schema:
|
||||
type: string
|
||||
example: iPhone prive
|
||||
required: false
|
||||
description: The alias of the device.
|
||||
- in: query
|
||||
name: customerProfileId
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
required: false
|
||||
description: The id of the customer profile.
|
||||
- name: sort
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
- name: offset
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
example: 20
|
||||
responses:
|
||||
200:
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"devices":
|
||||
[
|
||||
{
|
||||
"deviceId": "5bedce29-af0c-4f3c-b182-2caa8a1f9377",
|
||||
"externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
|
||||
"alias": "iPhone prive",
|
||||
"customerProfileId": 1
|
||||
},
|
||||
{
|
||||
"deviceId": "d7683e89-b2ad-4e79-85b3-dbb42aad0325",
|
||||
"externalDeviceId": "7122a988-a00a-417d-a5b4-da2d91354976",
|
||||
"alias": "iPhone zakelijk",
|
||||
"customerProfileId": 1
|
||||
}
|
||||
],
|
||||
"_links":
|
||||
{
|
||||
"self":
|
||||
{
|
||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices?offset=20",
|
||||
"method": "GET",
|
||||
},
|
||||
"prev":
|
||||
{
|
||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices",
|
||||
"method": "GET",
|
||||
},
|
||||
"next":
|
||||
{
|
||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices?offset=40",
|
||||
"method": "GET",
|
||||
},
|
||||
},
|
||||
}
|
||||
/customers/{customerProfileId}/devices:
|
||||
post:
|
||||
tags:
|
||||
- Devices
|
||||
summary: Add a customer device
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
- name: customerProfileId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
customerDevice:
|
||||
value:
|
||||
device:
|
||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
||||
alias: "iPhone prive"
|
||||
required: true
|
||||
responses:
|
||||
201:
|
||||
description: Successfully created a customer device
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/devices/{deviceId}:
|
||||
patch:
|
||||
tags:
|
||||
- Devices
|
||||
summary: Edit a customer device
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
- name: deviceId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
updateDevice:
|
||||
value:
|
||||
device:
|
||||
alias: "iPhone zakelijk"
|
||||
required: true
|
||||
responses:
|
||||
200:
|
||||
description: Successfully modified a customer device
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- Devices
|
||||
summary: Delete a customer device
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
- name: deviceId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
||||
responses:
|
||||
200:
|
||||
description: Successfully deleted a customer device
|
||||
content:
|
||||
application/json: {}
|
||||
security:
|
||||
- default: []
|
||||
x-auth-type: Application & Application User
|
||||
x-throttling-tier: Unlimited
|
||||
/ovpaytokens:
|
||||
get:
|
||||
tags:
|
||||
- Ovpay Token
|
||||
summary: Find ovpay tokens.
|
||||
description: Find ovpay tokens.
|
||||
- OVpay Tokens
|
||||
summary: Find OVpay tokens.
|
||||
description: Find OVpay tokens.
|
||||
parameters:
|
||||
- in: query
|
||||
name: ovPayTokenId
|
||||
@ -1389,8 +1612,8 @@ paths:
|
||||
/customers/{customerProfileId}/ovpaytokens:
|
||||
post:
|
||||
tags:
|
||||
- Ovpay Token
|
||||
summary: Create a new ovpay token
|
||||
- OVpay Tokens
|
||||
summary: Create a new OVpay token
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1440,8 +1663,8 @@ paths:
|
||||
/ovpaytokens/{ovpaytokenId}:
|
||||
patch:
|
||||
tags:
|
||||
- Ovpay Token
|
||||
summary: Update an ovpay token
|
||||
- OVpay Tokens
|
||||
summary: Update an OVpay token
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1491,8 +1714,8 @@ paths:
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- Ovpay Token
|
||||
summary: Delete an ovpay token
|
||||
- OVpay Tokens
|
||||
summary: Delete an OVpay token
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1514,8 +1737,8 @@ paths:
|
||||
/customers/{customerProfileId}/ovchipcards:
|
||||
post:
|
||||
tags:
|
||||
- Ovchipcard
|
||||
summary: Create a new ovchipcard
|
||||
- OV Chipcards
|
||||
summary: Create a new OV chipcard
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1552,8 +1775,8 @@ paths:
|
||||
/ovchipcards/{ovchipcardId}:
|
||||
patch:
|
||||
tags:
|
||||
- Ovchipcard
|
||||
summary: Update an ovchipcard
|
||||
- OV Chipcards
|
||||
summary: Update an OV chipcard
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
@ -1587,8 +1810,8 @@ paths:
|
||||
x-throttling-tier: Unlimited
|
||||
delete:
|
||||
tags:
|
||||
- Ovchipcard
|
||||
summary: Delete an ovchipcard
|
||||
- OV Chipcards
|
||||
summary: Delete an OV chipcard
|
||||
description: >-
|
||||
|
||||
parameters:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user