OVPAY-2103 - Added endpoints for TapConnectTicket.
This commit is contained in:
parent
b0360c22be
commit
6f95cee75e
@ -598,6 +598,222 @@ paths:
|
|||||||
{
|
{
|
||||||
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
|
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
|
||||||
}
|
}
|
||||||
|
/purchasedproducts/{purchasedProductId}/purchasedTapconnectTicket:
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: purchasedProductId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: 058a1af7-897f-45d5-b691-9cc9161e387f
|
||||||
|
required: true
|
||||||
|
description: The id of the purchased product to process.
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Purchased Tapconnect Ticket
|
||||||
|
summary: Add a purchased Tapconnect ticket.
|
||||||
|
description: Add a purchased Tapconnect ticket.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"issuedAt": "2024-10-04T12:34:56.000",
|
||||||
|
"activatedAt": "2024-10-04T12:34:56.000",
|
||||||
|
"cancelledAt": null,
|
||||||
|
"ticketReference": "KJj43nejhbTxhr897287",
|
||||||
|
"createdOn": "2024-10-04T12:34:56.000",
|
||||||
|
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||||
|
"createdBy": "user",
|
||||||
|
"lastUpdatedBy": "user",
|
||||||
|
}
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
description: Created
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
|
||||||
|
}
|
||||||
|
/purchasedtapconnecttickets:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Purchased Tapconnect Ticket
|
||||||
|
summary: Find purchased Tapconnect tickets.
|
||||||
|
description: Find purchased Tapconnect tickets.
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
name: purchasedTapconnectTicketId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90
|
||||||
|
description: The id of the purchased Tapconnect ticket.
|
||||||
|
- in: query
|
||||||
|
name: purchasedProductId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: 058a1af7-897f-45d5-b691-9cc9161e387f
|
||||||
|
description: The id of the purchased product.
|
||||||
|
- in: query
|
||||||
|
name: issuedBefore
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be issued before this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: issuedAfter
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be issued after this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: activatedBefore
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be activated before this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: activatedAfter
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be activated after this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: cancelledBefore
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be cancelled before this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: cancelledAfter
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The Tapconnect ticket should be cancelled after this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: ticketReference
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: KJj43nejhbTxhr897287
|
||||||
|
description: The reference of the Tapconnect ticket.
|
||||||
|
- in: query
|
||||||
|
name: createdBefore
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The purchased Tapconnect ticket should be created before this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: createdAfter
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The purchased Tapconnect ticket should be created after this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: lastUpdatedBefore
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The purchased Tapconnect ticket should be updated before this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: lastUpdatedAfter
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
example: 2024-10-04T12:34:56.000
|
||||||
|
description: The purchased Tapconnect ticket should be updated after this timestamp.
|
||||||
|
- in: query
|
||||||
|
name: createdBy
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: user
|
||||||
|
description: The user that created the purchased Tapconnect ticket.
|
||||||
|
- in: query
|
||||||
|
name: lastUpdatedBy
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: user
|
||||||
|
description: The user that last updated the purchased Tapconnect ticket.
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"purchasedTapconnectTickets":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
|
||||||
|
"purchasedProductId": "058a1af7-897f-45d5-b691-9cc9161e387f",
|
||||||
|
"issuedAt": "2024-10-04T12:34:56.000",
|
||||||
|
"activatedAt": "2024-10-04T12:34:56.000",
|
||||||
|
"cancelledAt": null,
|
||||||
|
"ticketReference": "KJj43nejhbTxhr897287",
|
||||||
|
"createdOn": "2024-10-04T12:34:56.000",
|
||||||
|
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||||
|
"createdBy": "user",
|
||||||
|
"lastUpdatedBy": "user",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
/purchasedtapconnecttickets/{purchasedTapconnectTicketId}:
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: purchasedTapconnectTicketId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90
|
||||||
|
required: true
|
||||||
|
description: The id of the purchased Tapconnect ticket to process.
|
||||||
|
patch:
|
||||||
|
tags:
|
||||||
|
- Purchased Tapconnect Ticket
|
||||||
|
summary: Update a purchased Tapconnect ticket.
|
||||||
|
description: Update a purchased Tapconnect ticket.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"activatedAt": "2024-10-05T12:34:56.000",
|
||||||
|
"cancelledAt": "2024-10-06T12:34:56.000",
|
||||||
|
"lastUpdatedOn": "2024-10-05T12:34:56.000",
|
||||||
|
"lastUpdatedBy": "user",
|
||||||
|
}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
|
||||||
|
}
|
||||||
/purchasedproducts/{purchasedProductId}/issuedvouchers:
|
/purchasedproducts/{purchasedProductId}/issuedvouchers:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user