Remove _templates, add self under _links, add some new links and attributes
This commit is contained in:
Max Martens
parent
53adc797a1
commit
ee8cdfc660
@ -30,11 +30,21 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
example: 1000001
|
example: 1000001
|
||||||
|
- name: customerStatusId
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
- name: debtorNumber
|
- name: debtorNumber
|
||||||
in: query
|
in: query
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
example: 100001
|
example: 100001
|
||||||
|
- name: debtorStatusId
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
- name: birthname
|
- name: birthname
|
||||||
in: query
|
in: query
|
||||||
schema:
|
schema:
|
||||||
@ -221,6 +231,10 @@ paths:
|
|||||||
"orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E",
|
"orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E",
|
||||||
"contractId": "56B17EF-C436-9043-B76C-481797WEB464F",
|
"contractId": "56B17EF-C436-9043-B76C-481797WEB464F",
|
||||||
"_links": {
|
"_links": {
|
||||||
|
"self": {
|
||||||
|
"href": "https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/productinstances/1",
|
||||||
|
"method": "GET"
|
||||||
|
},
|
||||||
"get_order": {
|
"get_order": {
|
||||||
"href": "https://api.integratielaag.nl/abt/serviceengine/x.x/orders/501B17EF-36C4-4039-B92C-6517969B464E",
|
"href": "https://api.integratielaag.nl/abt/serviceengine/x.x/orders/501B17EF-36C4-4039-B92C-6517969B464E",
|
||||||
"method": "GET"
|
"method": "GET"
|
||||||
@ -244,9 +258,6 @@ components:
|
|||||||
customerNumber:
|
customerNumber:
|
||||||
type: integer
|
type: integer
|
||||||
example: 1000001
|
example: 1000001
|
||||||
debtorNumber:
|
|
||||||
type: string
|
|
||||||
example: DB100001
|
|
||||||
customerStatus:
|
customerStatus:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -256,6 +267,18 @@ components:
|
|||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
example: Active
|
example: Active
|
||||||
|
debtorNumber:
|
||||||
|
type: string
|
||||||
|
example: DB100001
|
||||||
|
debtorStatus:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
debtorStatusId:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
example: Active
|
||||||
person:
|
person:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -320,7 +343,16 @@ components:
|
|||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
delete:
|
self:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/addresses/1
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
delete_address:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -358,7 +390,16 @@ components:
|
|||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
delete:
|
self:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/phones/1
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
delete_phone:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -370,6 +411,25 @@ components:
|
|||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
self:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
create_customer_status:
|
||||||
|
type: object
|
||||||
|
description: ONLY ALLOWED FOR SMP - Create a new customer status
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/statuses
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: POST
|
||||||
partial_edit:
|
partial_edit:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -379,9 +439,6 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: PATCH
|
example: PATCH
|
||||||
templated:
|
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
get_tokens:
|
get_tokens:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -391,9 +448,6 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
templated:
|
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
create_token:
|
create_token:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -402,66 +456,7 @@ components:
|
|||||||
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: POST
|
example: POST
|
||||||
templated:
|
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
_templates:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
partial_edit:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
example: PATCH
|
|
||||||
properties:
|
|
||||||
example:
|
|
||||||
[
|
|
||||||
{ name: person, required: true, properties: [
|
|
||||||
{ name: prefix, required: false, type: string },
|
|
||||||
{ name: birthname, required: false, type: string },
|
|
||||||
{ name: surname, required: false, type: string },
|
|
||||||
{ name: suffix, required: false, type: string },
|
|
||||||
{ name: dateOfBirth, required: false, type: string },
|
|
||||||
{ name: emailAddress, required: false, type: string },
|
|
||||||
{ name: addresses, required: false, multi: true, properties: [
|
|
||||||
{ name: addressId, required: false, type: integer },
|
|
||||||
{ name: isPreferred, required: false, type: boolean },
|
|
||||||
{ name: addressTypeId, required: false, type: integer },
|
|
||||||
{ name: street, required: false, type: string },
|
|
||||||
{ name: houseNumber, required: false, type: integer },
|
|
||||||
{ name: houseNumberSuffix, required: false, type: string },
|
|
||||||
{ name: postalCode, required: false, type: string },
|
|
||||||
{ name: city, required: false, type: string },
|
|
||||||
{ name: country, required: false, type: string }
|
|
||||||
]},
|
|
||||||
{ name: phones, required: false, multi: true, properties: [
|
|
||||||
{ name: phoneId, required: false, type: integer },
|
|
||||||
{ name: isPreferred, required: false, type: boolean },
|
|
||||||
{ name: phoneTypeId, required: false, type: integer },
|
|
||||||
{ name: number, required: false, type: string },
|
|
||||||
{ name: countryCode, required: false, type: string }
|
|
||||||
]}
|
|
||||||
] }
|
|
||||||
]
|
|
||||||
create_token:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
example: POST
|
|
||||||
properties:
|
|
||||||
example:
|
|
||||||
[
|
|
||||||
{ name: ovPayToken, required: true, properties: [
|
|
||||||
{ name: tokenTypeId, required: true, type: integer },
|
|
||||||
{ name: alias, required: true, type: string },
|
|
||||||
{ name: serviceReferenceId, required: false, type: string },
|
|
||||||
{ name: amount, required: false, type: integer },
|
|
||||||
]}
|
|
||||||
]
|
|
||||||
|
|
||||||
OvPayTokensResponse:
|
OvPayTokensResponse:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
@ -506,8 +501,18 @@ components:
|
|||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
partial_edit:
|
self:
|
||||||
type: object
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
partial_edit:
|
||||||
|
type: object
|
||||||
|
description: External touchpoints are only allowed to change alias - SMP can also change tokenStatus
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
@ -515,10 +520,7 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: PATCH
|
example: PATCH
|
||||||
templated:
|
replace_token:
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
replace:
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -527,10 +529,7 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: POST
|
example: POST
|
||||||
templated:
|
delete_token:
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
delete:
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -539,7 +538,7 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: DELETE
|
example: DELETE
|
||||||
productInstances:
|
get_productinstances:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -548,7 +547,7 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
trips:
|
get_trips:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
@ -557,41 +556,6 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
_templates:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
partial_edit:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
example: PATCH
|
|
||||||
properties:
|
|
||||||
example:
|
|
||||||
[
|
|
||||||
{ name: ovPayToken, required: true, properties: [
|
|
||||||
{ name: alias, required: false, type: string }
|
|
||||||
]}
|
|
||||||
]
|
|
||||||
replace:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
example: POST
|
|
||||||
properties:
|
|
||||||
example:
|
|
||||||
[
|
|
||||||
{ name: ovPayToken, required: true, properties: [
|
|
||||||
{ name: newTokenId, required: false, type: integer },
|
|
||||||
{ name: tokenTypeId, required: false, type: integer },
|
|
||||||
{ name: alias, required: false, type: string },
|
|
||||||
{ name: serviceReferenceId, required: false, type: string },
|
|
||||||
{ name: amount, required: false, type: integer },
|
|
||||||
]}
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
OvPayTokenProductInstancesResponse:
|
OvPayTokenProductInstancesResponse:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -649,6 +613,15 @@ components:
|
|||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
self:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/productinstances
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
get_order:
|
get_order:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user