OVPAY-2370 - Status codes async jobs.

This commit is contained in:
Bas Boterman 2025-12-10 12:26:09 +01:00
parent a52dfcab93
commit 3ae52206fc

View File

@ -187,25 +187,21 @@ paths:
examples: examples:
minimalCustomerProfile: minimalCustomerProfile:
value: value:
{ { "person": { "emailAddress": "j.jansen@hatseflats.nl" } }
"person": {
"emailAddress": "j.jansen@hatseflats.nl"
}
}
fullCustomerProfile: fullCustomerProfile:
value: value:
{ {
"customerPreference": { "customerPreference": { "languageId": 1 },
"languageId": 1 "person":
}, {
"person": {
"birthname": "Jan", "birthname": "Jan",
"surname": "Jansen", "surname": "Jansen",
"prefix": "dhr", "prefix": "dhr",
"suffix": "jr", "suffix": "jr",
"dateOfBirth": "1970-01-01", "dateOfBirth": "1970-01-01",
"emailAddress": "j.jansen@hatseflats.nl", "emailAddress": "j.jansen@hatseflats.nl",
"addresses": [ "addresses":
[
{ {
"street": "Laan van Meerdervoort", "street": "Laan van Meerdervoort",
"houseNumber": 5, "houseNumber": 5,
@ -214,7 +210,7 @@ paths:
"city": "Den Haag", "city": "Den Haag",
"country": "NL", "country": "NL",
"isPreferred": true, "isPreferred": true,
"addressTypeId": 1 "addressTypeId": 1,
}, },
{ {
"street": "Beeklaan", "street": "Beeklaan",
@ -224,24 +220,26 @@ paths:
"city": "Den Haag", "city": "Den Haag",
"country": "NL", "country": "NL",
"isPreferred": false, "isPreferred": false,
"addressTypeId": 2 "addressTypeId": 2,
} },
], ],
"phones": [ "phones":
[
{ {
"number": "6123456789", "number": "6123456789",
"countryCode": "0031", "countryCode": "0031",
"phoneTypeId": 1, "phoneTypeId": 1,
"isPreferred": true "isPreferred": true,
}, },
{ {
"number": "7012345678", "number": "7012345678",
"countryCode": "0031", "countryCode": "0031",
"phoneTypeId": 2, "phoneTypeId": 2,
"isPreferred": false "isPreferred": false,
} },
], ],
"devices": [ "devices":
[
{ {
"externalDeviceId": "123e4567-e89b-12d3-a456-426614174000", "externalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
"alias": "My iPhone", "alias": "My iPhone",
@ -249,9 +247,9 @@ paths:
{ {
"externalDeviceId": "987e6543-e21b-12d3-a456-426614174999", "externalDeviceId": "987e6543-e21b-12d3-a456-426614174999",
"alias": "My iPad", "alias": "My iPad",
} },
] ],
} },
} }
responses: responses:
"201": "201":
@ -296,20 +294,22 @@ paths:
patchCustomer: patchCustomer:
value: value:
{ {
"person": { "person":
{
"birthname": "Jan", "birthname": "Jan",
"surname": "Jansen", "surname": "Jansen",
"prefix": "dhr", "prefix": "dhr",
"suffix": "jr", "suffix": "jr",
"dateOfBirth": "1970-01-01", "dateOfBirth": "1970-01-01",
"addresses": [ "addresses":
[
{ {
"addressId": 2, "addressId": 2,
"street": "Laan van Meerdervoort", "street": "Laan van Meerdervoort",
"houseNumber": 5, "houseNumber": 5,
"postalCode": "2500AA", "postalCode": "2500AA",
"city": "Den Haag", "city": "Den Haag",
"country": "NL" "country": "NL",
}, },
{ {
"addressId": 1, "addressId": 1,
@ -319,26 +319,28 @@ paths:
"postalCode": "2500AA", "postalCode": "2500AA",
"city": "Den Haag", "city": "Den Haag",
"country": "NL", "country": "NL",
"addressTypeId": 2 "addressTypeId": 2,
} },
], ],
"phones": [ "phones":
[
{ {
"phoneId": 1, "phoneId": 1,
"number": "6123456789", "number": "6123456789",
"countryCode": "0031", "countryCode": "0031",
"phoneTypeId": 1, "phoneTypeId": 1,
"isPreferred": true "isPreferred": true,
}, },
{ {
"phoneId": 2, "phoneId": 2,
"number": "7012345678", "number": "7012345678",
"countryCode": "0031", "countryCode": "0031",
"phoneTypeId": 2, "phoneTypeId": 2,
"isPreferred": false "isPreferred": false,
} },
], ],
"devices": [ "devices":
[
{ {
"deviceId": "813afdd8-bf8c-4e26-bfda-4da79552bd38", "deviceId": "813afdd8-bf8c-4e26-bfda-4da79552bd38",
"externalDeviceId": "123e4567-e89b-12d3-a456-426614174000", "externalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
@ -348,9 +350,9 @@ paths:
"deviceId": "4f4249a2-ac6c-44f9-b740-66e66b6f3c28", "deviceId": "4f4249a2-ac6c-44f9-b740-66e66b6f3c28",
"externalDeviceId": "987e6543-e21b-12d3-a456-426614174999", "externalDeviceId": "987e6543-e21b-12d3-a456-426614174999",
"alias": "My iPad", "alias": "My iPad",
} },
] ],
} },
} }
responses: responses:
"200": "200":
@ -707,7 +709,7 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
}, },
"_links": "_links":
{ {
@ -804,7 +806,7 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
}, },
"_links": "_links":
{ {
@ -919,7 +921,7 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
}, },
"_links": "_links":
{ {
@ -1037,7 +1039,7 @@ paths:
"birthdate": null, "birthdate": null,
"photo": null, "photo": null,
}, },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
{ {
"customerProfileId": 132, "customerProfileId": 132,
@ -1058,7 +1060,7 @@ paths:
"birthdate": null, "birthdate": null,
"photo": null, "photo": null,
}, },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
{ {
"customerProfileId": 166, "customerProfileId": 166,
@ -1082,7 +1084,7 @@ paths:
"birthdate": null, "birthdate": null,
"photo": null, "photo": null,
}, },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
{ {
"customerProfileId": 166, "customerProfileId": 166,
@ -1103,7 +1105,7 @@ paths:
"birthdate": null, "birthdate": null,
"photo": null, "photo": null,
}, },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
{ {
"customerProfileId": 1, "customerProfileId": 1,
@ -1124,7 +1126,7 @@ paths:
"birthdate": null, "birthdate": null,
"photo": null, "photo": null,
}, },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
], ],
_links: _links:
@ -2369,7 +2371,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"newOvPayToken": "newOvPayToken":
{ {
@ -2386,7 +2388,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"isTransferable": true, "isTransferable": true,
"transferableObjects": "transferableObjects":
@ -2399,7 +2401,7 @@ paths:
"ePurse": true, "ePurse": true,
"personalAccountData": "personalAccountData":
{ "name": true, "birthdate": true, "photo": true }, { "name": true, "birthdate": true, "photo": true },
"gboAgeProfile": true "gboAgeProfile": true,
}, },
"_links": "_links":
{ {
@ -2423,50 +2425,57 @@ paths:
"tokenStatus": "tokenStatus":
{ "tokenStatusId": 2, "name": "Active" }, { "tokenStatusId": 2, "name": "Active" },
"expirationDate": "2028-02-01", "expirationDate": "2028-02-01",
"productInstances": [ "productInstances":
[
{ {
"productId": 1, "productId": 1,
"name": "HTM 90% Korting EMV", "name": "HTM 90% Korting EMV",
"status": "Active", "status": "Active",
"isRenewable": true, "isRenewable": true,
"productCategory": { "productCategory":
{
"productCategoryId": 1, "productCategoryId": 1,
"name": "Kortingsabonnement" "name": "Kortingsabonnement",
}, },
"fromInclusive": "2025-11-25T13:25:00+01:00", "fromInclusive": "2025-11-25T13:25:00+01:00",
"untilInclusive": "2025-12-25T03:59:59+01:00", "untilInclusive": "2025-12-25T03:59:59+01:00",
"orderId": "501B17EF-36C4-4039-B92C-6517969B464E", "orderId": "501B17EF-36C4-4039-B92C-6517969B464E",
"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": { {
"self":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens/1/productinstances/1", "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens/1/productinstances/1",
"method": "GET" "method": "GET",
}, },
"get_order": { "get_order":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/orders/501B17EF-36C4-4039-B92C-6517969B464E", "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/orders/501B17EF-36C4-4039-B92C-6517969B464E",
"method": "GET" "method": "GET",
}, },
"get_contract": { "get_contract":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/56B17EF-C436-9043-B76C-481797WEB464F", "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/56B17EF-C436-9043-B76C-481797WEB464F",
"method": "GET" "method": "GET",
} },
} },
} },
], ],
"replacedByTokenId": null, "replacedByTokenId": null,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"newOvPayToken": "newOvPayToken":
{ {
"customerProfileId": null, "customerProfileId": null,
"ovPayTokenId": null, "ovPayTokenId": null,
"xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811",
"tokenType": { "tokenTypeId": 2, "name": "OV-pas physical" }, "tokenType":
{ "tokenTypeId": 2, "name": "OV-pas physical" },
"alias": null, "alias": null,
"tokenStatus": null, "tokenStatus": null,
"expirationDate": "2028-02-01", "expirationDate": "2028-02-01",
@ -2476,7 +2485,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"isTransferable": false, "isTransferable": false,
"transferableObjects": "transferableObjects":
@ -2513,7 +2522,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"newOvPayToken": "newOvPayToken":
{ {
@ -2530,7 +2539,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"isTransferable": false, "isTransferable": false,
"transferableObjects": "transferableObjects":
@ -2602,8 +2611,8 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
} },
}, },
"newOvPayToken": "newOvPayToken":
{ {
@ -2620,7 +2629,7 @@ paths:
"ePurse": null, "ePurse": null,
"personalAccountData": "personalAccountData":
{ "name": null, "birthdate": null, "photo": null }, { "name": null, "birthdate": null, "photo": null },
"gboAgeProfile": null "gboAgeProfile": null,
}, },
"isTransferable": false, "isTransferable": false,
"transferableObjects": "transferableObjects":
@ -2678,8 +2687,8 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
} },
}, },
"newOvPayToken": "newOvPayToken":
{ {
@ -2714,8 +2723,8 @@ paths:
"gboAgeProfileId": 4, "gboAgeProfileId": 4,
"name": "Kind (19 t/m 65 jaar)", "name": "Kind (19 t/m 65 jaar)",
"ageFromInclusive": 19, "ageFromInclusive": 19,
"ageToInclusive": 65 "ageToInclusive": 65,
} },
}, },
"isTransferable": false, "isTransferable": false,
"transferableObjects": "transferableObjects":
@ -3078,7 +3087,7 @@ paths:
"gboAgeProfileId": 1, "gboAgeProfileId": 1,
"name": "Kind (4 t/m 11 jaar)", "name": "Kind (4 t/m 11 jaar)",
"ageFromInclusive": 4, "ageFromInclusive": 4,
"ageToInclusive": 11 "ageToInclusive": 11,
}, },
"_links": "_links":
{ {
@ -3119,60 +3128,22 @@ paths:
}, },
}, },
} }
"202":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Token transfer in progress: Token transfer in progress:
description: | description: |
The transfer of the token is still in progress. The response body shows the details of the The transfer of the token is still in progress. The response body shows the details of the
processing status. processing status.
value: value:
{ {
"properties": "startTime": "2025-02-14T05:32:47.067Z",
{
"waitEndTime": "2025-06-04T09:29:21.9641991Z",
"startTime": "2025-06-04T09:29:21.9641991Z",
"status": "Running", "status": "Running",
"correlation": "clientTrackingId": "08584620957189579629541919368CU00",
{
"clientTrackingId": "08584525775244808022011782750CU00",
},
"workflow":
{
"id": "/workflows/9cd96b77c0b94b31832778569f8ef2f9/versions/08584532480062676349",
"name": "08584532480062676349",
"type": "workflows/versions",
},
"trigger":
{
"name": "token_transfer",
"inputsLink":
{
"uri": "https://htm-abt-logicapp-acc.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/9cd96b77c0b94b31832778569f8ef2f9/runs/08584525775235278538475939776CU00/contents/TriggerInputs?api-version=2022-05-01&code=C6PDQGl3MGwt8KyA9BjWDdQbzBwm-01gEmZaTp-hPJ5UAzFuPU-thg%3d%3d&se=2025-06-04T13%3A00%3A00.0000000Z&sp=%2Fruns%2F08584525775235278538475939776CU00%2Fcontents%2FTriggerInputs%2Fread&sv=1.0&sig=6Uxs33K7cQ7jONWzhv9XFPzx4RRHZ6smzfM6wNPk5Mc",
"contentSize": 298,
},
"outputsLink":
{
"uri": "https://htm-abt-logicapp-acc.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/9cd96b77c0b94b31832778569f8ef2f9/runs/08584525775235278538475939776CU00/contents/TriggerOutputs?api-version=2022-05-01&code=C6PDQGl3MGwt8KyA9BjWDdQbzBwm-01gEmZaTp-hPJ5UAzFuPU-thg%3d%3d&se=2025-06-04T13%3A00%3A00.0000000Z&sp=%2Fruns%2F08584525775235278538475939776CU00%2Fcontents%2FTriggerOutputs%2Fread&sv=1.0&sig=vJ6pmCsmz2aP7f73MVOmCTes3YvC1e2w0ZLqdypLXrM",
"contentSize": 6110,
},
"startTime": "2025-06-04T09:29:21.9497457Z",
"endTime": "2025-06-04T09:29:21.9497457Z",
"originHistoryName": "08584525775235278538475939776CU00",
"correlation":
{
"clientTrackingId": "08584525775244808022011782750CU00",
},
"status": "Succeeded",
},
"outputs": {},
"response":
{
"startTime": "2025-06-04T09:29:21.9642901Z",
"correlation": {},
"status": "Waiting",
},
},
"id": "/workflows/9cd96b77c0b94b31832778569f8ef2f9/runs/08584525775235278538475939776CU00",
"name": "08584525775235278538475939776CU00",
"type": "workflows/runs",
} }
"404": "404":
description: Not found description: Not found
@ -3371,10 +3342,7 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
Update alias of a device: Update alias of a device:
value: value: { "alias": "My old iPhone 13" }
{
"alias": "My old iPhone 13",
}
responses: responses:
"200": "200":
description: OK description: OK