Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
22cb3ddd92 | ||
|
|
1f3e2289dc | ||
|
|
3ff55e5888 | ||
|
|
987f64a081 | ||
|
|
00448486f3 | ||
|
|
ed61633579 | ||
|
|
d34ba20d19 | ||
|
|
3e1f23afe3 | ||
|
|
6260cc5d63 | ||
|
|
3ae52206fc | ||
|
|
a52dfcab93 | ||
|
|
80b0de274e | ||
|
|
3ffc525d48 | ||
|
|
105a18c0ac | ||
|
|
e4b3ab4ccf | ||
|
|
01aa8a9f1a | ||
|
|
bb917c3635 |
No files matched your search
@@ -28,10 +28,33 @@ public final class Helpers {
|
|||||||
return new JSONObject(string).get("alertId").toString();
|
return new JSONObject(string).get("alertId").toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static String getTripId(String string) throws IOException {
|
||||||
|
return new JSONObject(string).get("tripId").toString();
|
||||||
|
}
|
||||||
|
|
||||||
public static String getXbot(String string) throws IOException {
|
public static String getXbot(String string) throws IOException {
|
||||||
return new JSONObject(string).get("xbot").toString();
|
return new JSONObject(string).get("xbot").toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static void getTripDetails(String tripId, String xbot, String gboBearerToken) throws Exception {
|
||||||
|
SSLContext sc = SSLContext.getInstance("SSL");
|
||||||
|
sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
|
||||||
|
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
|
||||||
|
|
||||||
|
URL url = new URL("https://api.sbx.idbt.translink.nl/api/v3/id-media/tokens/xbot/" + xbot + "/trips/details/" + tripId);
|
||||||
|
URLConnection con = url.openConnection();
|
||||||
|
HttpURLConnection http = (HttpURLConnection)con;
|
||||||
|
http.setRequestMethod("GET");
|
||||||
|
http.setDoOutput(true);
|
||||||
|
http.setRequestProperty("Authorization", "Bearer " + gboBearerToken);
|
||||||
|
http.connect();
|
||||||
|
|
||||||
|
try(InputStream is = http.getInputStream()) {
|
||||||
|
String response = new String(is.readAllBytes(), StandardCharsets.UTF_8);
|
||||||
|
LOGGER.info("GBO API 8659 trip details response for xBOT " + xbot + " and tripId " + tripId + ": \n" + new JSONObject(response).toString(2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public static void getAlertDetails(String alertId, String xBot, String gboBearerToken) throws Exception {
|
public static void getAlertDetails(String alertId, String xBot, String gboBearerToken) throws Exception {
|
||||||
SSLContext sc = SSLContext.getInstance("SSL");
|
SSLContext sc = SSLContext.getInstance("SSL");
|
||||||
sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
|
sc.init(null, DummyX509TrustManager.getDummyArray(), new java.security.SecureRandom());
|
||||||
@@ -48,7 +71,7 @@ public final class Helpers {
|
|||||||
|
|
||||||
try(InputStream is = http.getInputStream()) {
|
try(InputStream is = http.getInputStream()) {
|
||||||
String response = new String(is.readAllBytes(), StandardCharsets.UTF_8);
|
String response = new String(is.readAllBytes(), StandardCharsets.UTF_8);
|
||||||
LOGGER.info("GBO API 8851 alert details response for xBOT " + xBot + ": \n" + new JSONObject(response).toString(2));
|
LOGGER.info("GBO API 8851 alert details response for xBOT " + xBot + " and alertId " + alertId + ": \n" + new JSONObject(response).toString(2));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,14 +16,28 @@ public class RabbitConnector {
|
|||||||
|
|
||||||
private static final Logger LOGGER = LoggerFactory.getLogger(RabbitConnector.class);
|
private static final Logger LOGGER = LoggerFactory.getLogger(RabbitConnector.class);
|
||||||
|
|
||||||
|
// TRIPS
|
||||||
|
// SubscriptionId = 3e246de5-d3ad-468f-834b-1aaebf52244c
|
||||||
|
// Use API 9853 to manually add xBOT to queue
|
||||||
|
private static final String QUEUE_NAME = "BEID_3.TRIPS";
|
||||||
|
private static final String USER_NAME = "BEID_3_TRIPS_HlTT";
|
||||||
|
private static final String PASSWORD = "xJR4C8hIqhHQw0sn";
|
||||||
|
|
||||||
|
// ALERTS
|
||||||
|
// SubscriptionId = 17c8100b-88a2-4cef-b40d-8dca4f93d311
|
||||||
|
// Use API 9853 to manually add xBOT to queue
|
||||||
|
// private static final String QUEUE_NAME = "BEID_3.ALERTS";
|
||||||
|
// private static final String USER_NAME = "BEID_3_ALERTS_nZs3";
|
||||||
|
// private static final String PASSWORD = "VyubhPnczKgTB2zJ";
|
||||||
|
|
||||||
public static void main(String[] args) throws Exception {
|
public static void main(String[] args) throws Exception {
|
||||||
ConnectionFactory factory = new ConnectionFactory();
|
ConnectionFactory factory = new ConnectionFactory();
|
||||||
factory.setVirtualHost("/");
|
factory.setVirtualHost("/");
|
||||||
factory.setAutomaticRecoveryEnabled(true);
|
factory.setAutomaticRecoveryEnabled(true);
|
||||||
factory.setPort(443);
|
factory.setPort(443);
|
||||||
factory.setHost("not.sbx.idbt.translink.nl");
|
factory.setHost("not.sbx.idbt.translink.nl");
|
||||||
factory.setUsername("BEID_3_ALERTS_nZs3");
|
factory.setUsername(USER_NAME);
|
||||||
factory.setPassword("VyubhPnczKgTB2zJ");
|
factory.setPassword(PASSWORD);
|
||||||
factory.useSslProtocol("TLSv1.2");
|
factory.useSslProtocol("TLSv1.2");
|
||||||
factory.setExceptionHandler(new ForgivingExceptionHandler());
|
factory.setExceptionHandler(new ForgivingExceptionHandler());
|
||||||
Map<String, Object> configs = factory.getClientProperties();
|
Map<String, Object> configs = factory.getClientProperties();
|
||||||
@@ -33,7 +47,7 @@ public class RabbitConnector {
|
|||||||
Channel channel = connection.createChannel();
|
Channel channel = connection.createChannel();
|
||||||
DeliverCallback deliverCallback = initDeliverCallback(channel);
|
DeliverCallback deliverCallback = initDeliverCallback(channel);
|
||||||
|
|
||||||
AMQP.Queue.DeclareOk queue = channel.queueDeclarePassive("BEID_3.ALERTS");
|
AMQP.Queue.DeclareOk queue = channel.queueDeclarePassive(QUEUE_NAME);
|
||||||
LOGGER.info(
|
LOGGER.info(
|
||||||
"Declared queue: " + queue.getQueue() + ", consumer count: " + queue.getConsumerCount() + ", message count: " +
|
"Declared queue: " + queue.getQueue() + ", consumer count: " + queue.getConsumerCount() + ", message count: " +
|
||||||
queue.getMessageCount());
|
queue.getMessageCount());
|
||||||
@@ -52,17 +66,39 @@ public class RabbitConnector {
|
|||||||
channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
|
channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
|
||||||
LOGGER.info("Successfully acknowledged message with delivery tag: " + delivery.getEnvelope().getDeliveryTag());
|
LOGGER.info("Successfully acknowledged message with delivery tag: " + delivery.getEnvelope().getDeliveryTag());
|
||||||
|
|
||||||
LOGGER.info("Getting alert details via GBO API 8851...");
|
if (QUEUE_NAME.equals("BEID_3.TRIPS")) {
|
||||||
try {
|
getTripDetails(message);
|
||||||
String alertId = Helpers.getAlertId(message);
|
} else if (QUEUE_NAME.equals("BEID_3.ALERTS")) {
|
||||||
String xBot = Helpers.getXbot(message);
|
getAlertDetails(message);
|
||||||
String gboBearerToken = Helpers.getGboBearerToken();
|
|
||||||
|
|
||||||
Helpers.getAlertDetails(alertId, xBot, gboBearerToken);
|
|
||||||
|
|
||||||
} catch (Exception e) {
|
|
||||||
throw new RuntimeException(e);
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private static void getAlertDetails(String message) {
|
||||||
|
try {
|
||||||
|
String alertId = Helpers.getAlertId(message);
|
||||||
|
String xBot = Helpers.getXbot(message);
|
||||||
|
String gboBearerToken = Helpers.getGboBearerToken();
|
||||||
|
|
||||||
|
LOGGER.info("Getting alert details for xBOT {} and alertId {} via GBO API 8851...", xBot, alertId);
|
||||||
|
Helpers.getAlertDetails(alertId, xBot, gboBearerToken);
|
||||||
|
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void getTripDetails(String message) {
|
||||||
|
try {
|
||||||
|
String tripId = Helpers.getTripId(message);
|
||||||
|
String xBot = Helpers.getXbot(message);
|
||||||
|
String gboBearerToken = Helpers.getGboBearerToken();
|
||||||
|
|
||||||
|
LOGGER.info("Getting trip details for xBOT {} and tripId {} via GBO API 8659...", xBot, tripId);
|
||||||
|
Helpers.getTripDetails(tripId, xBot, gboBearerToken);
|
||||||
|
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -2999,8 +2999,12 @@ paths:
|
|||||||
transactionItems:
|
transactionItems:
|
||||||
- transactionItemId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
|
- transactionItemId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
|
||||||
status: returned to src
|
status: returned to src
|
||||||
|
aggregationReference: null
|
||||||
|
accountingSystemReference: null
|
||||||
- transactionItemId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
|
- transactionItemId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
|
||||||
status: returned to src
|
status: returned to src
|
||||||
|
aggregationReference: null
|
||||||
|
accountingSystemReference: null
|
||||||
List of transactions items to return:
|
List of transactions items to return:
|
||||||
summary: List of transaction items to return to transaction database
|
summary: List of transaction items to return to transaction database
|
||||||
description: List of transaction items to return to transaction database in bulk.
|
description: List of transaction items to return to transaction database in bulk.
|
||||||
@@ -3008,8 +3012,12 @@ paths:
|
|||||||
transactionItems:
|
transactionItems:
|
||||||
- transactionItemId: eacb9bdc-c6b5-4277-942b-cebb102944f5
|
- transactionItemId: eacb9bdc-c6b5-4277-942b-cebb102944f5
|
||||||
status: returned to trx-db
|
status: returned to trx-db
|
||||||
|
aggregationReference: null
|
||||||
|
accountingSystemReference: null
|
||||||
- transactionItemId: 2f361bfb-9df0-4e0f-af7c-7b9be3e7bc61
|
- transactionItemId: 2f361bfb-9df0-4e0f-af7c-7b9be3e7bc61
|
||||||
status: returned to trx-db
|
status: returned to trx-db
|
||||||
|
aggregationReference: null
|
||||||
|
accountingSystemReference: null
|
||||||
responses:
|
responses:
|
||||||
"202":
|
"202":
|
||||||
description: Accepted
|
description: Accepted
|
||||||
@@ -3061,10 +3069,32 @@ paths:
|
|||||||
Body of a batch of transaction items that was successfully patched.
|
Body of a batch of transaction items that was successfully patched.
|
||||||
A number of transaction items were patched.
|
A number of transaction items were patched.
|
||||||
value:
|
value:
|
||||||
|
startTime: 2025-02-14T05:32:47.067Z
|
||||||
|
status: Finished
|
||||||
|
clientTrackingId: 08584620957189579629541919368CU00
|
||||||
summary:
|
summary:
|
||||||
created: 0
|
created: 0
|
||||||
updated: 15
|
updated: 15
|
||||||
total: 15
|
total: 15
|
||||||
|
"202":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GetResponseStatus"
|
||||||
|
examples:
|
||||||
|
Batch is still being processed:
|
||||||
|
summary: Batch is still being processed
|
||||||
|
description: |
|
||||||
|
Batch is still being processed
|
||||||
|
value:
|
||||||
|
startTime: 2025-02-14T05:32:47.067Z
|
||||||
|
status: Running
|
||||||
|
clientTrackingId: 08584620957189579629541919368CU00
|
||||||
|
summary:
|
||||||
|
created: 0
|
||||||
|
updated: 0
|
||||||
|
total: 0
|
||||||
security:
|
security:
|
||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
@@ -3089,8 +3119,10 @@ paths:
|
|||||||
processingFailures:
|
processingFailures:
|
||||||
- processingFailureId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
|
- processingFailureId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
|
||||||
resolved: true
|
resolved: true
|
||||||
|
change: Configuratie aangepast voor artikelnummer 1337.
|
||||||
- processingFailureId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
|
- processingFailureId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
|
||||||
resolved: true
|
resolved: true
|
||||||
|
change: Configuratie aangepast voor artikelnummer 1337.
|
||||||
responses:
|
responses:
|
||||||
"202":
|
"202":
|
||||||
description: Accepted
|
description: Accepted
|
||||||
@@ -3142,10 +3174,32 @@ paths:
|
|||||||
Body of a batch of processing failures that was successfully patched.
|
Body of a batch of processing failures that was successfully patched.
|
||||||
A number of processing failures were patched.
|
A number of processing failures were patched.
|
||||||
value:
|
value:
|
||||||
|
startTime: 2025-02-14T05:32:47.067Z
|
||||||
|
status: Finished
|
||||||
|
clientTrackingId: 08584620957189579629541919368CU00
|
||||||
summary:
|
summary:
|
||||||
created: 0
|
created: 0
|
||||||
updated: 15
|
updated: 15
|
||||||
total: 15
|
total: 15
|
||||||
|
"202":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GetResponseStatus"
|
||||||
|
examples:
|
||||||
|
Batch is still being processed:
|
||||||
|
summary: Batch is still being processed
|
||||||
|
description: |
|
||||||
|
Batch is still being processed
|
||||||
|
value:
|
||||||
|
startTime: 2025-02-14T05:32:47.067Z
|
||||||
|
status: Running
|
||||||
|
clientTrackingId: 08584620957189579629541919368CU00
|
||||||
|
summary:
|
||||||
|
created: 0
|
||||||
|
updated: 0
|
||||||
|
total: 0
|
||||||
security:
|
security:
|
||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
|
|||||||
@@ -5,6 +5,12 @@ info:
|
|||||||
description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://services.acc.api.htm.nl/abt/abtorder/1.0
|
- url: https://services.acc.api.htm.nl/abt/abtorder/1.0
|
||||||
|
tags:
|
||||||
|
- name: Order
|
||||||
|
- name: Order Line
|
||||||
|
- name: Payment
|
||||||
|
- name: Customer
|
||||||
|
- name: Order Voucher
|
||||||
paths:
|
paths:
|
||||||
/orders:
|
/orders:
|
||||||
get:
|
get:
|
||||||
@@ -50,6 +56,13 @@ paths:
|
|||||||
example: 1
|
example: 1
|
||||||
required: false
|
required: false
|
||||||
description: The id of the touch point where the order was initiated.
|
description: The id of the touch point where the order was initiated.
|
||||||
|
- in: query
|
||||||
|
name: deviceId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: "7a28bd54-7ca9-499a-a722-d15ab858ab99"
|
||||||
|
required: false
|
||||||
|
description: The id of the device used to place the order.
|
||||||
- in: query
|
- in: query
|
||||||
name: languageId
|
name: languageId
|
||||||
schema:
|
schema:
|
||||||
@@ -98,6 +111,14 @@ paths:
|
|||||||
explode: false
|
explode: false
|
||||||
required: false
|
required: false
|
||||||
description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
|
description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
|
||||||
|
- in: query
|
||||||
|
name: issuedVoucherId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: "b0a9f3c9-9b92-4f8c-b78d-6129be7218a6"
|
||||||
|
required: false
|
||||||
|
description: Filter on applied issuedVoucherId for the order.
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
@@ -119,6 +140,7 @@ paths:
|
|||||||
"touchPointId": 1,
|
"touchPointId": 1,
|
||||||
"name": "Perplex"
|
"name": "Perplex"
|
||||||
},
|
},
|
||||||
|
"deviceId": "42e77532-d831-41da-b07a-7edb9bb7f004",
|
||||||
"language":
|
"language":
|
||||||
{
|
{
|
||||||
"languageId": 1,
|
"languageId": 1,
|
||||||
@@ -148,6 +170,52 @@ paths:
|
|||||||
"description": "Betaling in behandeling",
|
"description": "Betaling in behandeling",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
"order_OrderVouchers": [
|
||||||
|
{
|
||||||
|
"order_OrderVoucherId": "399bd3b3-9721-4f09-a936-d64637de1621",
|
||||||
|
"issuedVoucher":{
|
||||||
|
"issuedVoucherId": "a0996218-bc5e-4826-9020-cda98a32838d",
|
||||||
|
"voucherCode": "Voucher1234",
|
||||||
|
"voucherStatusInstances":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"voucherStatus":
|
||||||
|
{
|
||||||
|
"voucherStatusId": 2,
|
||||||
|
"name": "issued"
|
||||||
|
},
|
||||||
|
"createdOn": "2025-11-22T13:00:00"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"productId": 31,
|
||||||
|
"fromInclusive": "2025-03-22T08:55:00",
|
||||||
|
"untillInclusive": "2026-03-22T08:55:00"
|
||||||
|
},
|
||||||
|
"orderLineId": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"order_OrderVoucherId": "f6c7ac42-1811-4e4d-82af-53e18fe16110",
|
||||||
|
"issuedVoucher":{
|
||||||
|
"issuedVoucherId": "54668baf-4905-4e9a-af02-09c170f295ed",
|
||||||
|
"voucherCode": "Voucher124",
|
||||||
|
"voucherStatusInstances":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"voucherStatus":
|
||||||
|
{
|
||||||
|
"voucherStatusId": 2,
|
||||||
|
"name": "issued"
|
||||||
|
},
|
||||||
|
"createdOn": "2025-11-22T13:00:00"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"productId": 35,
|
||||||
|
"fromInclusive": "2025-03-22T08:55:00",
|
||||||
|
"untillInclusive": "2026-03-22T08:55:00"
|
||||||
|
},
|
||||||
|
"orderLineId": "7a7a9d1a-3fc8-4058-a28b-082860aaa311"
|
||||||
|
}
|
||||||
|
],
|
||||||
"orderLines":
|
"orderLines":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
@@ -327,21 +395,24 @@ paths:
|
|||||||
"customerProfileId": 1337,
|
"customerProfileId": 1337,
|
||||||
"totalAmount": 121,
|
"totalAmount": 121,
|
||||||
"touchPointId": 1,
|
"touchPointId": 1,
|
||||||
|
"deviceId": "b8ca9fdf-0bb9-4e49-b48d-41e395563377",
|
||||||
"languageId": 1,
|
"languageId": 1,
|
||||||
"createdOn": "2024-03-22T09:00:00",
|
"createdOn": "2024-03-22T09:00:00",
|
||||||
"order_OrderStatus":
|
"order_OrderStatus":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"orderStatusId": 4,
|
"orderStatusId": 1,
|
||||||
"createdOn": "2024-03-22T09:00:00",
|
|
||||||
"description": "Order succesvol betaald",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"orderStatusId": 3,
|
|
||||||
"createdOn": "2024-03-22T08:55:00",
|
"createdOn": "2024-03-22T08:55:00",
|
||||||
"description": "Betaling in behandeling",
|
"description": "Concept order",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
"order_OrderVouchers":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"issuedVoucherId": "e81b2197-a6c2-45b6-9560-8ce8442e8604",
|
||||||
|
"orderLineId": "97824d2e-5189-456d-b6da-4cca511a7685"
|
||||||
|
},
|
||||||
|
],
|
||||||
"orderLines":
|
"orderLines":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
@@ -390,57 +461,6 @@ paths:
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
"payments":
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"createdOn": "2024-03-22T09:00:00",
|
|
||||||
"amountDebit": 121,
|
|
||||||
"paymentMethodId": 1,
|
|
||||||
"touchPointId": 1,
|
|
||||||
"isRefund": false,
|
|
||||||
"htmPaymentReference": "HTM-1234",
|
|
||||||
"pspPaymentReference": "Buckaroo-1234",
|
|
||||||
"paymentStatuses":
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"createdOn": "2024-03-22T09:00:00",
|
|
||||||
"statusCode": "190",
|
|
||||||
"statusDescription": "Success",
|
|
||||||
"statusSubCode": "S001",
|
|
||||||
"statusSubDescription": "PaymentSuccessFul",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"mandateInput":
|
|
||||||
{
|
|
||||||
"directDebitMandateTypeId": 1,
|
|
||||||
"createdOn": "2024-03-22T09:00:00",
|
|
||||||
"bic": "RABONL2U",
|
|
||||||
"iban": "NL44RABO0123456789",
|
|
||||||
"ascription": "J. de Vries",
|
|
||||||
"place": "Den Haag",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"orderCustomer":
|
|
||||||
{
|
|
||||||
"birthname": "Jan",
|
|
||||||
"surname": "Vries",
|
|
||||||
"prefix": "de",
|
|
||||||
"emailAddress": "jandevries@outlook.com",
|
|
||||||
"dateOfBirth": "1970-01-01",
|
|
||||||
"orderCustomerAddresses":
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"addressTypeId": 1,
|
|
||||||
"street": "Kon. Julianaplein",
|
|
||||||
"houseNumber": 10,
|
|
||||||
"houseNumberSuffix": "a",
|
|
||||||
"postalCode": "2595 AA",
|
|
||||||
"city": "Den Haag",
|
|
||||||
"country": "NL",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
responses:
|
responses:
|
||||||
"201":
|
"201":
|
||||||
@@ -487,6 +507,7 @@ paths:
|
|||||||
"touchPointId": 1,
|
"touchPointId": 1,
|
||||||
"name": "Perplex"
|
"name": "Perplex"
|
||||||
},
|
},
|
||||||
|
"deviceId": null,
|
||||||
"language":
|
"language":
|
||||||
{
|
{
|
||||||
"languageId": 1,
|
"languageId": 1,
|
||||||
@@ -512,6 +533,7 @@ paths:
|
|||||||
"description": "Betaling in behandeling",
|
"description": "Betaling in behandeling",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
"order_OrderVouchers": null,
|
||||||
"orderLines":
|
"orderLines":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
@@ -658,6 +680,7 @@ paths:
|
|||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"customerProfileId": 1337,
|
"customerProfileId": 1337,
|
||||||
|
"deviceId": "fe68e624-b75f-48ca-a179-d5f86a8ab7d5",
|
||||||
"totalAmount": 121,
|
"totalAmount": 121,
|
||||||
"languageId": 1,
|
"languageId": 1,
|
||||||
"lastUpdatedOn": "2024-03-22T09:00:00",
|
"lastUpdatedOn": "2024-03-22T09:00:00",
|
||||||
@@ -678,6 +701,7 @@ paths:
|
|||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
|
|
||||||
/orders/{orderId}/statuses:
|
/orders/{orderId}/statuses:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
@@ -715,6 +739,136 @@ paths:
|
|||||||
{
|
{
|
||||||
"order_orderStatusId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
|
"order_orderStatusId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
|
||||||
}
|
}
|
||||||
|
/orders/{orderId}/ordervouchers:
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: orderId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: d1dd439b-6072-4b97-89c9-724268865b93
|
||||||
|
required: true
|
||||||
|
description: The id of the order to process.
|
||||||
|
post:
|
||||||
|
summary: Add an order voucher.
|
||||||
|
description: Add an order voucher.
|
||||||
|
tags:
|
||||||
|
- Order Voucher
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13",
|
||||||
|
"orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67"
|
||||||
|
}
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
description: Created
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
|
||||||
|
}
|
||||||
|
/ordervouchers:
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
name: order_OrderVoucherId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: d1dd439b-6072-4b97-89c9-724268865b93
|
||||||
|
required: false
|
||||||
|
description: The id of the orderVoucher you are looking for.
|
||||||
|
- in: query
|
||||||
|
name: orderId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: 90c926b9-3178-4757-acca-34cff66b980c
|
||||||
|
required: false
|
||||||
|
description: The id of the order
|
||||||
|
- in: query
|
||||||
|
name: orderLineId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: 9e3363c8-e776-4675-b108-99b8c2e38eb6
|
||||||
|
required: false
|
||||||
|
description: The id of the orderLine
|
||||||
|
get:
|
||||||
|
summary: Find vouchers on the order
|
||||||
|
description: Find vouchers on the order
|
||||||
|
tags:
|
||||||
|
- Order Voucher
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"order_OrderVoucherId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50",
|
||||||
|
"orderId": "f59e4769-53a0-4156-8991-6f9119ba629f",
|
||||||
|
"orderLineId": "eeb86071-4f59-405d-b2be-7d7a77044bfa"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
/ordervouchers/{order_ordervoucherId}:
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: order_ordervoucherId
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: d1dd439b-6072-4b97-89c9-724268865b93
|
||||||
|
required: true
|
||||||
|
description: The id of the order to process.
|
||||||
|
patch:
|
||||||
|
summary: Update an order voucher.
|
||||||
|
description: Update an order voucher.
|
||||||
|
tags:
|
||||||
|
- Order Voucher
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"issuedVoucherId": "eec6af41-1a60-49f6-a92e-440054a92f13",
|
||||||
|
"orderLineId": "7a9d6e15-7c5c-421d-9ea9-00b9bb6dbe67"
|
||||||
|
}
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{
|
||||||
|
"order_orderVoucherId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066",
|
||||||
|
}
|
||||||
|
delete:
|
||||||
|
summary: Delete an order voucher.
|
||||||
|
description: Delete an order voucher.
|
||||||
|
tags:
|
||||||
|
- Order Voucher
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
example:
|
||||||
|
{}
|
||||||
/orders/{orderId}/orderlines:
|
/orders/{orderId}/orderlines:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
@@ -1844,6 +1998,7 @@ paths:
|
|||||||
"touchPointId": 1,
|
"touchPointId": 1,
|
||||||
"name": "Perplex"
|
"name": "Perplex"
|
||||||
},
|
},
|
||||||
|
"deviceId": null,
|
||||||
"isRefund": false,
|
"isRefund": false,
|
||||||
"htmPaymentReference": "HTM-1234",
|
"htmPaymentReference": "HTM-1234",
|
||||||
"pspPaymentReference": "Buckaroo-1234",
|
"pspPaymentReference": "Buckaroo-1234",
|
||||||
|
|||||||
@@ -5300,6 +5300,261 @@ paths:
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
/orders/{orderId}/ordervouchers:
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: orderId
|
||||||
|
required: true
|
||||||
|
style: simple
|
||||||
|
explode: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: a0ef57fa-395c-4a03-96e9-234c26dccea9
|
||||||
|
- in: header
|
||||||
|
name: X-HTM-JWT-AUTH-HEADER
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
||||||
|
description: The JWT of the logged in customer (in case of a web shop).
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Order Creation Flow
|
||||||
|
summary: Add a voucher to an existing orders.
|
||||||
|
description: Add a voucher to an existing order.
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
examples:
|
||||||
|
Add a voucher to an existing order:
|
||||||
|
summary: Add a voucher to an existing order
|
||||||
|
description: Add a voucher to an existing order
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"voucherCode": "Voucher1234",
|
||||||
|
"orderLineId": "6bb3d8a1-474f-4bdb-9cbc-31bf4ed0482e"
|
||||||
|
}
|
||||||
|
responses:
|
||||||
|
"201":
|
||||||
|
description: Created
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/unavailable"
|
||||||
|
examples:
|
||||||
|
Order with added voucher:
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"validContents": true,
|
||||||
|
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
|
||||||
|
"externalOrderId": null,
|
||||||
|
"orderNumber": "ORD-123456",
|
||||||
|
"customerProfileId": 1337,
|
||||||
|
"totalAmount": 121,
|
||||||
|
"touchPoint":
|
||||||
|
{
|
||||||
|
"salesTouchpointId": 3,
|
||||||
|
"name": "Website (Perplex)",
|
||||||
|
"isActive": true,
|
||||||
|
"retailerId": 1001,
|
||||||
|
},
|
||||||
|
"language":
|
||||||
|
{
|
||||||
|
"languageId": 1,
|
||||||
|
"name": "Nederlands",
|
||||||
|
"iso639Code": "nl-NL",
|
||||||
|
"ietfCode": "nl",
|
||||||
|
},
|
||||||
|
"createdOn": "2024-03-22T09:00:00",
|
||||||
|
"lastUpdatedOn": "2024-03-22T09:00:00",
|
||||||
|
"order_OrderStatuses":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
|
||||||
|
"orderStatus":
|
||||||
|
{ "orderStatusId": 1, "name": "concept" },
|
||||||
|
"createdOn": "2024-03-22T09:00:00",
|
||||||
|
"description": "Order is aangemaakt",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"order_OrderVouchers":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"order_orderVoucherId": "a66f224f-347b-47e7-b480-0b84b8ef5177",
|
||||||
|
"issuedVoucher":
|
||||||
|
{ "voucherCode": "HTM1234",
|
||||||
|
"productName": "Ooievaarspas voucher",
|
||||||
|
"productDescription": "Ontvang de ooievaarspas om gratis te reizen bij de HTM",
|
||||||
|
"voucherStatus": {
|
||||||
|
"voucherStatusId": 2,
|
||||||
|
"name": "Issued"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468",
|
||||||
|
"validations": [
|
||||||
|
{
|
||||||
|
"code": "VOUCHER_CLAIM_GBO_BIRTHDATE",
|
||||||
|
"detail": "Birthdate does not match the claim",
|
||||||
|
"path": "#/orderLines[cccada2c-d5ea-48ab-b4be-f590e16b5468]/customerToken[878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e]/personalAccountData",
|
||||||
|
"parameter": "dateOfBirth",
|
||||||
|
"type": "ERROR"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"code": "VOUCHER_CLAIM_EMAIL",
|
||||||
|
"detail": "Email on the order needs to be filled",
|
||||||
|
"path": "#/orderCustomer",
|
||||||
|
"parameter": "emailAddress",
|
||||||
|
"type": "REMARK"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"orderLines":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"orderLineId": "cccada2c-d5ea-48ab-b4be-f590e16b5468",
|
||||||
|
"externalOrderLineId": null,
|
||||||
|
"productId": 1,
|
||||||
|
"productName": "HTM Maandkorting 20%",
|
||||||
|
"fikoArticleNumber": "6609",
|
||||||
|
"productDescription": "HTM Maandkorting 20%",
|
||||||
|
"taxCode": "V21",
|
||||||
|
"taxPercentage": 21.0000,
|
||||||
|
"taxAmount": null,
|
||||||
|
"amountExclTax": null,
|
||||||
|
"amountInclTax": 121,
|
||||||
|
"quantity": 1,
|
||||||
|
"orderLineTerms":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"orderLineTermsId": "cccada2c-d5ea-48ab-b4be-f590e16b5468",
|
||||||
|
"termsUrl": "generalTermsAndConditions.pdf",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"orderLineTermsId": "bd76f723-9308-4629-a291-4c4fafd7ed87",
|
||||||
|
"termsUrl": "productTermsAndConditions.pdf",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"createdOn": "2024-03-22T09:00:00",
|
||||||
|
"validFrom": "2024-03-22T09:00:00",
|
||||||
|
"validUntil": null,
|
||||||
|
"orderLineStatus":
|
||||||
|
{ "orderLineStatusId": 1, "name": "pending" },
|
||||||
|
"customerTokens":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
|
||||||
|
"tokenType":
|
||||||
|
{ "tokenTypeId": 1, "name": "EMV" },
|
||||||
|
"ovPayTokenId": 1,
|
||||||
|
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||||
|
"amount": 34,
|
||||||
|
"ovpasNumber": "OV34567",
|
||||||
|
"verificationCode": "A7H6",
|
||||||
|
"personalAccountData":
|
||||||
|
{
|
||||||
|
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
|
||||||
|
"name": "Jan de Vries",
|
||||||
|
"birthdate": "1970-01-01",
|
||||||
|
"photo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAAWJLR0Q+SWQA4wAAAAd0SU1FB+YCBAwmK58TFQgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjItMDItMDRUMTI6Mzg6NDMrMDA6MDBAjYOrAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIyLTAyLTA0VDEyOjM4OjQzKzAwOjAwMdA7FwAAAFd6VFh0UmF3IHByb2ZpbGUgdHlwZSBpcHRjAAB4nOPyDAhxVigoyk/LzEnlUgADIwsuYwsTIxNLkxQDEyBEgDTDZAMjs1Qgy9jUyMTMxBzEB8uASKBKLgDqFxF08kI1lQAAAYdpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0n77u/JyBpZD0nVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkJz8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIj48cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPjx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+PC9yZGY6RGVzY3JpcHRpb24+PC9yZGY6UkRGPjwveDp4bXBtZXRhPg0KPD94cGFja2V0IGVuZD0ndyc/PiyUmAsAAAANSURBVBhXY3grk/YfAAXYAm/HQierAAAAAElFTkSuQmCC",
|
||||||
|
"challengeType":
|
||||||
|
{
|
||||||
|
"challengeTypeId": 1,
|
||||||
|
"name": "email",
|
||||||
|
},
|
||||||
|
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||||
|
},
|
||||||
|
"ovPayToken":
|
||||||
|
{
|
||||||
|
"customerProfileId": 1,
|
||||||
|
"ovPayTokenId": 1,
|
||||||
|
"xTat": "32089cc8-d187-47ff-a3a9-5c2558def811",
|
||||||
|
"tokenType":
|
||||||
|
{
|
||||||
|
"tokenTypeId": 2,
|
||||||
|
"name": "OV-pas physical",
|
||||||
|
},
|
||||||
|
"alias": "MyToken",
|
||||||
|
"tokenStatus":
|
||||||
|
{
|
||||||
|
"tokenStatusId": 2,
|
||||||
|
"name": "Active",
|
||||||
|
},
|
||||||
|
"expirationDate": "2028-02-01",
|
||||||
|
"replacedByTokenId": null,
|
||||||
|
"autoReloadRegistration":
|
||||||
|
{
|
||||||
|
"autoReloadAmount": 500,
|
||||||
|
"retailerReferenceId": "abc",
|
||||||
|
"arrit": "425f7fc2-1103-4822-9c79-7c4aaa2fb6aa",
|
||||||
|
"autoReloadRegistrationStatus": "ACTIVE",
|
||||||
|
"autoReloadRegistrationStartDateTime": "2024-06-02T15:03:46Z",
|
||||||
|
},
|
||||||
|
"ePurse":
|
||||||
|
{
|
||||||
|
"e-PurseBalance":
|
||||||
|
{
|
||||||
|
"currency": "EUR",
|
||||||
|
"amount": 350,
|
||||||
|
},
|
||||||
|
"status": "ACTIVE",
|
||||||
|
"originDate": "2019-07-16T11:00:00+02:00",
|
||||||
|
},
|
||||||
|
"personalAccountData":
|
||||||
|
{
|
||||||
|
"name":
|
||||||
|
{
|
||||||
|
"inaccuracyFlag": false,
|
||||||
|
"inaccuracyFlagReason": null,
|
||||||
|
"inaccuracyFlagSetCounter": 0,
|
||||||
|
"isValidated": false,
|
||||||
|
"changeCounter": 0,
|
||||||
|
"maxUpdatesVerificationCount": 0,
|
||||||
|
"lastChangeDate": "2024-08-24T14:15:22Z",
|
||||||
|
},
|
||||||
|
"birthdate":
|
||||||
|
{
|
||||||
|
"inaccuracyFlag": false,
|
||||||
|
"inaccuracyFlagReason": null,
|
||||||
|
"inaccuracyFlagSetCounter": 0,
|
||||||
|
"isValidated": false,
|
||||||
|
"changeCounter": 0,
|
||||||
|
"maxUpdatesVerificationCount": 0,
|
||||||
|
"lastChangeDate": "2024-08-24T14:15:22Z",
|
||||||
|
},
|
||||||
|
"photo":
|
||||||
|
{
|
||||||
|
"inaccuracyFlag": false,
|
||||||
|
"inaccuracyFlagReason": null,
|
||||||
|
"inaccuracyFlagSetCounter": 0,
|
||||||
|
"isValidated": false,
|
||||||
|
"changeCounter": 0,
|
||||||
|
"maxUpdatesVerificationCount": 0,
|
||||||
|
"lastChangeDate": "2024-08-24T14:15:22Z",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"gboAgeProfile":
|
||||||
|
{
|
||||||
|
"gboAgeProfileId": 1,
|
||||||
|
"name": "Kind (4 t/m 11 jaar)",
|
||||||
|
"ageFromInclusive": 4,
|
||||||
|
"ageToInclusive": 11,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"orderAccountingStatuses": [],
|
||||||
|
"validationResult": "valid",
|
||||||
|
"additionalRemarks": [],
|
||||||
|
"validationErrors": [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"payments": [],
|
||||||
|
"orderCustomer": null
|
||||||
|
}
|
||||||
/orders/{orderId}/fulfill:
|
/orders/{orderId}/fulfill:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|||||||
@@ -0,0 +1,477 @@
|
|||||||
|
openapi: 3.0.1
|
||||||
|
info:
|
||||||
|
title: TapConnect
|
||||||
|
description: >-
|
||||||
|
Welcome to the TapConnect Issuing API documentation. These pages describe the endpoints available within TapConnect. Please note that for historical reasons, Date/times are always in the "Europe/Amsterdam" timezone. The endpoints in this document are grouped as follows:
|
||||||
|
|
||||||
|
- **Export endpoints**: Export related endpoints return information about events related to tickets that have been issued. This can be used for Business Intelligence purposes or for financial record keeping.
|
||||||
|
- **Product endpoints**: Product related endpoints return information about products that are available to you as a sales partner and the details of each of these products.
|
||||||
|
- **Ticket endpoints**: Ticket related endpoints allow you to manage tickets throughout their lifecycle. This includes ticket creation, retrieving ticket information, or retrieving the barcode for a ticket.
|
||||||
|
- **Journey endpoints**: Used to calculate the price of a journey and to issue a ticket for that journey using the external fare calculation engine.
|
||||||
|
|
||||||
|
For more information on TapConnect please visit [https://tapconnect.io](https://tapconnect.io) or [https://documentation.tapconnect.io](https://documentation.tapconnect.io).
|
||||||
|
version: '1.0'
|
||||||
|
servers:
|
||||||
|
- url: https://services.acc.api.htm.nl/tapconnect/1.0
|
||||||
|
tags:
|
||||||
|
- name: Export
|
||||||
|
description: >-
|
||||||
|
Export data that can be used to generate reports about issued tickets
|
||||||
|
and related information
|
||||||
|
paths:
|
||||||
|
/v5/ticket-events-export:
|
||||||
|
get:
|
||||||
|
summary: Elastic Search ticket events export
|
||||||
|
description: "Exports ticket events data from Elastic Search.\n\nBoth parameters\
|
||||||
|
\ are a string, and they have to represent a date. Consider the list of valid\
|
||||||
|
\ formats below:\n1. 2021 - searches for all events in a year\n2. 2021-02\
|
||||||
|
\ - searches for all events in a month\n3. 2021-02-02 - searches for all events\
|
||||||
|
\ in a day\n4. 2021-02-02T12 - searches for all events in a specific hour\n\
|
||||||
|
5. 2021-02-02T12:00 - searches for all events in a specific minute\n6. 2021-02-02T12:00:00\
|
||||||
|
\ - searches for all events in a specific second\n\nIf an error occur, the\
|
||||||
|
\ last element returned will be a message with \"An error occurred on Elasticsearch\"\
|
||||||
|
\ and it \nmeans that not all the results are returned.\n_Keep in mind that\
|
||||||
|
\ the above timestamps would also be accepted as Zulu: 2021-02-02T11:00:00Z\
|
||||||
|
\ (winter time)_\n"
|
||||||
|
parameters:
|
||||||
|
- explode: true
|
||||||
|
in: query
|
||||||
|
name: start
|
||||||
|
required: true
|
||||||
|
description: The date to be considered as the interval starting date
|
||||||
|
schema:
|
||||||
|
example: 2021-02-01T00:00:00
|
||||||
|
type: string
|
||||||
|
style: form
|
||||||
|
- explode: true
|
||||||
|
in: query
|
||||||
|
name: end
|
||||||
|
required: true
|
||||||
|
description: The date to be considered as the interval ending date
|
||||||
|
schema:
|
||||||
|
example: 2021-02-02T00:00:00
|
||||||
|
type: string
|
||||||
|
style: form
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/v5_ticket_events_export_response'
|
||||||
|
description: Returns a JSON chunked array of ticket events exported from elastic search.
|
||||||
|
"400":
|
||||||
|
description: |
|
||||||
|
The request could not be validated. The request body or parameters contain incomplete or incorrect parameters. The body of the response will contain information about the problem.
|
||||||
|
"401":
|
||||||
|
description: |
|
||||||
|
Unauthorized call, you are not authorized to call this endpoint with the api key provided in the Authorization header. Please verify that your api key is correct and/or if you are authorized to call this endpoint.
|
||||||
|
"403":
|
||||||
|
description: |
|
||||||
|
Unauthorized call, you are not authorized to call this endpoint with the api key provided in the Authorization header. Please verify that your api key is correct and/or if you are authorized to call this endpoint.
|
||||||
|
"404":
|
||||||
|
description: |
|
||||||
|
The requested URL does not exist, or the requested object was not found.
|
||||||
|
"406":
|
||||||
|
description: |
|
||||||
|
The request was not accepted by the server. The body of the response will contain information about the problem.
|
||||||
|
tags:
|
||||||
|
- Export
|
||||||
|
components:
|
||||||
|
schemas:
|
||||||
|
v5_ticket_events_export_response:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
anyOf:
|
||||||
|
- $ref: '#/components/schemas/ActivateTicketEvent'
|
||||||
|
- $ref: '#/components/schemas/CreateBarcodeEvent'
|
||||||
|
- $ref: '#/components/schemas/CreateTicketEvent'
|
||||||
|
- $ref: '#/components/schemas/TapEvent'
|
||||||
|
- $ref: '#/components/schemas/InspectTicketEvent'
|
||||||
|
- $ref: '#/components/schemas/NotifyEvent'
|
||||||
|
ActivateTicketEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 1
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: ACTIVATE_TICKET
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:00.791992000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:00.791992000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: hkbu3415fbidswd803nfdg7
|
||||||
|
type: string
|
||||||
|
validityStart:
|
||||||
|
example: 2021-06-06T22:00:00.000000000Z
|
||||||
|
type: string
|
||||||
|
validityEnd:
|
||||||
|
example: 2021-06-07T23:40:00.000000000Z
|
||||||
|
type: string
|
||||||
|
validityType:
|
||||||
|
example: FIXED
|
||||||
|
type: string
|
||||||
|
CreateBarcodeEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 2
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: CREATE_BARCODE
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:01.629279000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:01.629279000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: 2huCpR99LHjGfiq8ZJoF
|
||||||
|
type: string
|
||||||
|
barcodeSignatureKeyId:
|
||||||
|
example: TCT07
|
||||||
|
type: string
|
||||||
|
barcodeValidityStart:
|
||||||
|
example: 2021-06-06T22:00:00.000000000Z
|
||||||
|
type: string
|
||||||
|
barcodeValidityEnd:
|
||||||
|
example: 2021-06-07T23:40:00.000000000Z
|
||||||
|
type: string
|
||||||
|
CreateTicketEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 0
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: CREATE_TICKET
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
reportedAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: 344BEuHcFkEChOPm06sY
|
||||||
|
type: string
|
||||||
|
serviceId:
|
||||||
|
example: HTM-0987-7477-0993
|
||||||
|
type: string
|
||||||
|
productName:
|
||||||
|
example: HTM Kinder Dagkaart
|
||||||
|
type: string
|
||||||
|
productCode:
|
||||||
|
example: "303"
|
||||||
|
type: string
|
||||||
|
productValidityPeriodUnit:
|
||||||
|
example: "DAYS"
|
||||||
|
type: string
|
||||||
|
productValidityPeriod:
|
||||||
|
example: 1
|
||||||
|
type: number
|
||||||
|
lifespanStart:
|
||||||
|
example: 2021-06-07
|
||||||
|
type: string
|
||||||
|
lifespanEnd:
|
||||||
|
example: 2021-06-08
|
||||||
|
type: string
|
||||||
|
language:
|
||||||
|
example: NL
|
||||||
|
type: string
|
||||||
|
salesChannelId:
|
||||||
|
example: "9999"
|
||||||
|
type: string
|
||||||
|
salesChannelName:
|
||||||
|
example: HTM App
|
||||||
|
type: string
|
||||||
|
startStation:
|
||||||
|
example: Haarlem
|
||||||
|
type: string
|
||||||
|
endStation:
|
||||||
|
example: Leiden Centraal
|
||||||
|
type: string
|
||||||
|
barcodeType:
|
||||||
|
example: UIC
|
||||||
|
type: string
|
||||||
|
validityType:
|
||||||
|
example: FIXED
|
||||||
|
type: string
|
||||||
|
refundable:
|
||||||
|
example: true
|
||||||
|
type: boolean
|
||||||
|
priceInCents:
|
||||||
|
example: 150,
|
||||||
|
type: number
|
||||||
|
numberOfAdults:
|
||||||
|
example: 1
|
||||||
|
type: number
|
||||||
|
numberOfChildren:
|
||||||
|
example: 0
|
||||||
|
type: number
|
||||||
|
roundToBusinessDay:
|
||||||
|
example: true
|
||||||
|
type: boolean
|
||||||
|
modalities:
|
||||||
|
example: ["BUS", "TRAM"]
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
example: BUS
|
||||||
|
type: string
|
||||||
|
TapEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 5
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: TAP
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
validationAction:
|
||||||
|
example: CHECK_OUT
|
||||||
|
type: string
|
||||||
|
validationResult:
|
||||||
|
example: Approved
|
||||||
|
type: string
|
||||||
|
tapId:
|
||||||
|
example: a9aea0ae-52de-42cd-a2f1-93b80d9af389
|
||||||
|
type: string
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: hkbu3415fbidswd803nfdg7
|
||||||
|
type: string
|
||||||
|
modality:
|
||||||
|
example: BUS
|
||||||
|
type: string
|
||||||
|
line:
|
||||||
|
example: "25"
|
||||||
|
type: string
|
||||||
|
trip:
|
||||||
|
example: "240"
|
||||||
|
type: string
|
||||||
|
vehicle:
|
||||||
|
example: "1512"
|
||||||
|
type: string
|
||||||
|
deviceId:
|
||||||
|
example: "13513A"
|
||||||
|
type: string
|
||||||
|
deviceType:
|
||||||
|
example: VBS
|
||||||
|
type: string
|
||||||
|
lastStopId:
|
||||||
|
example: "3409"
|
||||||
|
type: string
|
||||||
|
lastStopName:
|
||||||
|
example: Gramsbergenlaan
|
||||||
|
type: string
|
||||||
|
nextStopId:
|
||||||
|
example: "3409"
|
||||||
|
type: string
|
||||||
|
nextStopName:
|
||||||
|
example: Gramsbergenlaan
|
||||||
|
type: string
|
||||||
|
location:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
lat:
|
||||||
|
example: 52.00089453333333
|
||||||
|
type: number
|
||||||
|
lon:
|
||||||
|
example: 4.004570666666667
|
||||||
|
type: number
|
||||||
|
InspectTicketEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 3
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: INSPECT_TICKET
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: uv1hzvrRd7Xd1Fs9vTxi
|
||||||
|
type: string
|
||||||
|
modality:
|
||||||
|
example: BUS
|
||||||
|
type: string
|
||||||
|
deviceId:
|
||||||
|
example: 6959bd00eaec8e68
|
||||||
|
type: string
|
||||||
|
deviceType:
|
||||||
|
example: IBS
|
||||||
|
type: string
|
||||||
|
validationResult:
|
||||||
|
example: Approved
|
||||||
|
type: string
|
||||||
|
NotifyEvent:
|
||||||
|
properties:
|
||||||
|
eventId:
|
||||||
|
example: 1185
|
||||||
|
type: number
|
||||||
|
eventType:
|
||||||
|
example: NOTIFY
|
||||||
|
type: string
|
||||||
|
occurredAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
receivedAt:
|
||||||
|
example: 2021-06-07T08:42:00.790992000Z
|
||||||
|
type: string
|
||||||
|
timeToDie:
|
||||||
|
example: 2445836980
|
||||||
|
type: number
|
||||||
|
tapId:
|
||||||
|
example: a9aea0ae-52de-42cd-a2f1-93b80d9af389
|
||||||
|
type: string
|
||||||
|
sequence:
|
||||||
|
example: 2
|
||||||
|
type: number
|
||||||
|
tapResponseTimeMillis:
|
||||||
|
example: 402
|
||||||
|
type: number
|
||||||
|
validationAction:
|
||||||
|
example: CHECK_OUT
|
||||||
|
type: string
|
||||||
|
validationMethod:
|
||||||
|
example: ONLINE
|
||||||
|
type: string
|
||||||
|
validationResult:
|
||||||
|
example: Approved
|
||||||
|
type: string
|
||||||
|
operators:
|
||||||
|
items:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
type: array
|
||||||
|
createdBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
definedBy:
|
||||||
|
example: HTM
|
||||||
|
type: string
|
||||||
|
modality:
|
||||||
|
example: TRAM
|
||||||
|
type: string
|
||||||
|
line:
|
||||||
|
example: "3"
|
||||||
|
type: string
|
||||||
|
trip:
|
||||||
|
example: "692"
|
||||||
|
type: string
|
||||||
|
vehicle:
|
||||||
|
example: "4058"
|
||||||
|
type: string
|
||||||
|
deviceId:
|
||||||
|
example: "13A886"
|
||||||
|
type: string
|
||||||
|
deviceType:
|
||||||
|
example: VBS
|
||||||
|
type: string
|
||||||
|
lastStopId:
|
||||||
|
example: "2005"
|
||||||
|
type: string
|
||||||
|
lastStopName:
|
||||||
|
example: Fahrenheitstraat
|
||||||
|
type: string
|
||||||
|
nextStopId:
|
||||||
|
example: "2011"
|
||||||
|
type: string
|
||||||
|
nextStopName:
|
||||||
|
example: Valkenbosplein
|
||||||
|
type: string
|
||||||
|
ticketId:
|
||||||
|
example: hkbu3415fbidswd803nfdg7
|
||||||
|
type: string
|
||||||
|
location:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
lat:
|
||||||
|
example: 52.001300283333336
|
||||||
|
type: number
|
||||||
|
lon:
|
||||||
|
example: 4.004586633333333
|
||||||
|
type: number
|
||||||
Reference in new issue
Block a user