@ampeco/public-api-mcp 3.251.10 → 3.253.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/build-stats.json +9 -9
- package/dist/generated/endpoints.json +369 -49
- package/dist/generated/response-schemas.json +799 -47
- package/dist/generated/schemas.d.ts +91 -18
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +28 -6
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +31 -6
- package/package.json +1 -1
|
@@ -1631,9 +1631,16 @@
|
|
|
1631
1631
|
"type": "string",
|
|
1632
1632
|
"enum": [
|
|
1633
1633
|
"corporate_billing_policy_inactive",
|
|
1634
|
+
"corporate_billing_limit_exceeded",
|
|
1635
|
+
"corporate_billing_currency_mismatch",
|
|
1636
|
+
"corporate_billing_charger_type_not_covered",
|
|
1637
|
+
"corporate_billing_location_not_covered",
|
|
1638
|
+
"corporate_billing_cross_operator_not_opted_in",
|
|
1639
|
+
"corporate_billing_exchange_rate_unavailable",
|
|
1640
|
+
"corporate_billing_ad_hoc_tariff_unavailable",
|
|
1634
1641
|
"cannot_use_payment_method"
|
|
1635
1642
|
],
|
|
1636
|
-
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method
|
|
1643
|
+
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
1637
1644
|
}
|
|
1638
1645
|
}
|
|
1639
1646
|
}
|
|
@@ -3911,9 +3918,16 @@
|
|
|
3911
3918
|
"type": "string",
|
|
3912
3919
|
"enum": [
|
|
3913
3920
|
"corporate_billing_policy_inactive",
|
|
3921
|
+
"corporate_billing_limit_exceeded",
|
|
3922
|
+
"corporate_billing_currency_mismatch",
|
|
3923
|
+
"corporate_billing_charger_type_not_covered",
|
|
3924
|
+
"corporate_billing_location_not_covered",
|
|
3925
|
+
"corporate_billing_cross_operator_not_opted_in",
|
|
3926
|
+
"corporate_billing_exchange_rate_unavailable",
|
|
3927
|
+
"corporate_billing_ad_hoc_tariff_unavailable",
|
|
3914
3928
|
"cannot_use_payment_method"
|
|
3915
3929
|
],
|
|
3916
|
-
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method
|
|
3930
|
+
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
3917
3931
|
}
|
|
3918
3932
|
}
|
|
3919
3933
|
}
|
|
@@ -10412,7 +10426,8 @@
|
|
|
10412
10426
|
"de-CH",
|
|
10413
10427
|
"fr-CH",
|
|
10414
10428
|
"it-CH",
|
|
10415
|
-
"en-GB"
|
|
10429
|
+
"en-GB",
|
|
10430
|
+
"tl-PH"
|
|
10416
10431
|
]
|
|
10417
10432
|
}
|
|
10418
10433
|
}
|
|
@@ -13990,14 +14005,16 @@
|
|
|
13990
14005
|
"description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
|
|
13991
14006
|
},
|
|
13992
14007
|
"restrictionCause": {
|
|
13993
|
-
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
|
|
14008
|
+
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
|
|
13994
14009
|
"type": "string",
|
|
13995
14010
|
"enum": [
|
|
13996
14011
|
"partner",
|
|
13997
14012
|
"country",
|
|
13998
14013
|
"location",
|
|
13999
14014
|
"location_tag",
|
|
14000
|
-
"roaming"
|
|
14015
|
+
"roaming",
|
|
14016
|
+
"cross_operator_not_opted_in",
|
|
14017
|
+
"exchange_rate_unavailable"
|
|
14001
14018
|
]
|
|
14002
14019
|
},
|
|
14003
14020
|
"breakdown": {
|
|
@@ -79331,28 +79348,465 @@
|
|
|
79331
79348
|
}
|
|
79332
79349
|
}
|
|
79333
79350
|
},
|
|
79334
|
-
"422": {
|
|
79335
|
-
"schema": {
|
|
79336
|
-
"type": "object",
|
|
79337
|
-
"required": [
|
|
79338
|
-
"message"
|
|
79339
|
-
],
|
|
79340
|
-
"properties": {
|
|
79341
|
-
"message": {
|
|
79342
|
-
"type": "string"
|
|
79343
|
-
},
|
|
79344
|
-
"errors": {
|
|
79345
|
-
"type": "object",
|
|
79346
|
-
"additionalProperties": {
|
|
79347
|
-
"type": "array",
|
|
79348
|
-
"items": {
|
|
79349
|
-
"type": "string"
|
|
79350
|
-
}
|
|
79351
|
-
}
|
|
79352
|
-
}
|
|
79353
|
-
}
|
|
79354
|
-
}
|
|
79355
|
-
},
|
|
79351
|
+
"422": {
|
|
79352
|
+
"schema": {
|
|
79353
|
+
"type": "object",
|
|
79354
|
+
"required": [
|
|
79355
|
+
"message"
|
|
79356
|
+
],
|
|
79357
|
+
"properties": {
|
|
79358
|
+
"message": {
|
|
79359
|
+
"type": "string"
|
|
79360
|
+
},
|
|
79361
|
+
"errors": {
|
|
79362
|
+
"type": "object",
|
|
79363
|
+
"additionalProperties": {
|
|
79364
|
+
"type": "array",
|
|
79365
|
+
"items": {
|
|
79366
|
+
"type": "string"
|
|
79367
|
+
}
|
|
79368
|
+
}
|
|
79369
|
+
}
|
|
79370
|
+
}
|
|
79371
|
+
}
|
|
79372
|
+
},
|
|
79373
|
+
"429": {
|
|
79374
|
+
"schema": {
|
|
79375
|
+
"type": "object",
|
|
79376
|
+
"properties": {
|
|
79377
|
+
"message": {
|
|
79378
|
+
"type": "string"
|
|
79379
|
+
}
|
|
79380
|
+
}
|
|
79381
|
+
}
|
|
79382
|
+
}
|
|
79383
|
+
},
|
|
79384
|
+
"ocpiCommandsListing": {
|
|
79385
|
+
"200": {
|
|
79386
|
+
"schema": {
|
|
79387
|
+
"type": "object",
|
|
79388
|
+
"properties": {
|
|
79389
|
+
"data": {
|
|
79390
|
+
"type": "array",
|
|
79391
|
+
"items": {
|
|
79392
|
+
"description": "A command received from an eMSP over OCPI and the result returned for it.",
|
|
79393
|
+
"type": "object",
|
|
79394
|
+
"properties": {
|
|
79395
|
+
"id": {
|
|
79396
|
+
"type": "integer",
|
|
79397
|
+
"readOnly": true,
|
|
79398
|
+
"description": "Identifier of the command."
|
|
79399
|
+
},
|
|
79400
|
+
"type": {
|
|
79401
|
+
"description": "The command the roaming partner sent:\n- **cancel_reservation**: Cancel a reservation\n- **reserve_now**: Reserve an EVSE\n- **start_session**: Start a charging session\n- **stop_session**: Stop a charging session\n- **unlock_connector**: Unlock a connector\n- **change_availability**: Change the availability of an EVSE (protocol extension)\n- **get_diagnostics**: Request charge point diagnostics (protocol extension)\n- **reset_evse**: Reset an EVSE (protocol extension)\n- **unknown**: Any command outside this set\n",
|
|
79402
|
+
"type": "string",
|
|
79403
|
+
"enum": [
|
|
79404
|
+
"cancel_reservation",
|
|
79405
|
+
"reserve_now",
|
|
79406
|
+
"start_session",
|
|
79407
|
+
"stop_session",
|
|
79408
|
+
"unlock_connector",
|
|
79409
|
+
"change_availability",
|
|
79410
|
+
"get_diagnostics",
|
|
79411
|
+
"reset_evse",
|
|
79412
|
+
"unknown"
|
|
79413
|
+
]
|
|
79414
|
+
},
|
|
79415
|
+
"result": {
|
|
79416
|
+
"description": "The result the platform returned to the roaming partner:\n- **accepted**: The command was accepted\n- **rejected**: The command was rejected\n- **not_supported**: The command is not supported for this charge point\n- **timeout**: The charge point did not respond in time\n- **unknown_session**: The referenced session is unknown\n- **failed**: The command failed during execution\n- **evse_occupied**: The EVSE is already in use\n- **evse_inoperative**: The EVSE is not operational\n- **unknown_reservation**: The referenced reservation is unknown\n- **canceled_reservation**: The reservation was cancelled\n- **unknown**: Any result outside the OCPI result set\n",
|
|
79417
|
+
"type": "string",
|
|
79418
|
+
"enum": [
|
|
79419
|
+
"accepted",
|
|
79420
|
+
"rejected",
|
|
79421
|
+
"not_supported",
|
|
79422
|
+
"timeout",
|
|
79423
|
+
"unknown_session",
|
|
79424
|
+
"failed",
|
|
79425
|
+
"evse_occupied",
|
|
79426
|
+
"evse_inoperative",
|
|
79427
|
+
"unknown_reservation",
|
|
79428
|
+
"canceled_reservation",
|
|
79429
|
+
"unknown"
|
|
79430
|
+
]
|
|
79431
|
+
},
|
|
79432
|
+
"failureReason": {
|
|
79433
|
+
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: The corporate account limit is reached\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
|
|
79434
|
+
"type": "string",
|
|
79435
|
+
"enum": [
|
|
79436
|
+
"charging_not_allowed",
|
|
79437
|
+
"location_is_closed",
|
|
79438
|
+
"access_restricted",
|
|
79439
|
+
"user_verification_not_complete",
|
|
79440
|
+
"terms_not_accepted",
|
|
79441
|
+
"subscription_required",
|
|
79442
|
+
"cannot_bill_payment_method",
|
|
79443
|
+
"session_already_running",
|
|
79444
|
+
"previous_session_not_paid",
|
|
79445
|
+
"unpaid_subscription_fees",
|
|
79446
|
+
"payment_method_required",
|
|
79447
|
+
"corporate_billing_policy_inactive",
|
|
79448
|
+
"corporate_billing_limit_exceeded",
|
|
79449
|
+
"corporate_account_limit_reached",
|
|
79450
|
+
"corporate_billing_currency_mismatch",
|
|
79451
|
+
"corporate_billing_cross_operator_not_opted_in",
|
|
79452
|
+
"corporate_billing_exchange_rate_unavailable",
|
|
79453
|
+
"corporate_billing_charger_type_not_covered",
|
|
79454
|
+
"corporate_billing_partner_not_covered",
|
|
79455
|
+
"corporate_billing_country_not_covered",
|
|
79456
|
+
"corporate_billing_location_not_covered",
|
|
79457
|
+
"corporate_billing_location_tag_not_covered",
|
|
79458
|
+
"corporate_billing_roaming_not_covered",
|
|
79459
|
+
"payment_method_expired",
|
|
79460
|
+
"payment_method_not_allowed",
|
|
79461
|
+
"payment_method_doesnt_have_sufficient_funds",
|
|
79462
|
+
"internal_roaming_not_setup",
|
|
79463
|
+
"rfid_tag_expired",
|
|
79464
|
+
"rfid_tag_disabled",
|
|
79465
|
+
"rfid_tag_suspended",
|
|
79466
|
+
"user_invoice_details_not_provided",
|
|
79467
|
+
"invalid_payment_method_for_direct_charges",
|
|
79468
|
+
"user_is_disabled",
|
|
79469
|
+
"token_not_authorized_for_booking",
|
|
79470
|
+
"evse_has_queued_reservations",
|
|
79471
|
+
"evse_disabled",
|
|
79472
|
+
"evse_out_of_order",
|
|
79473
|
+
"tariff_charging_not_allowed",
|
|
79474
|
+
"no_tariff_group_configured",
|
|
79475
|
+
"tariff_resolution_failed",
|
|
79476
|
+
"operator_in_migration_mode",
|
|
79477
|
+
"rfid_charge_point_scope_mismatch",
|
|
79478
|
+
"remote_start_failed",
|
|
79479
|
+
"rejected",
|
|
79480
|
+
"canceled_reservation",
|
|
79481
|
+
"evse_occupied",
|
|
79482
|
+
"evse_inoperative",
|
|
79483
|
+
"failed",
|
|
79484
|
+
"not_supported",
|
|
79485
|
+
"timeout",
|
|
79486
|
+
"unknown_reservation",
|
|
79487
|
+
"ev_not_connected_to_evse",
|
|
79488
|
+
"authorization_failed",
|
|
79489
|
+
"pre_authorization_failed",
|
|
79490
|
+
"unknown_session",
|
|
79491
|
+
"ocpi_roaming_not_setup",
|
|
79492
|
+
"command_expired"
|
|
79493
|
+
]
|
|
79494
|
+
},
|
|
79495
|
+
"sessionId": {
|
|
79496
|
+
"type": "integer",
|
|
79497
|
+
"description": "The related charging session ID."
|
|
79498
|
+
},
|
|
79499
|
+
"reservationId": {
|
|
79500
|
+
"type": "integer",
|
|
79501
|
+
"description": "The related reservation ID."
|
|
79502
|
+
},
|
|
79503
|
+
"evseId": {
|
|
79504
|
+
"type": "integer",
|
|
79505
|
+
"description": "The targeted EVSE ID."
|
|
79506
|
+
},
|
|
79507
|
+
"roamingEmspId": {
|
|
79508
|
+
"type": "integer",
|
|
79509
|
+
"description": "The roaming eMSP ID (`resources/roaming-emsps/v1.0`) the command was received from."
|
|
79510
|
+
},
|
|
79511
|
+
"roamingConnectionId": {
|
|
79512
|
+
"type": "integer",
|
|
79513
|
+
"description": "The roaming connection ID."
|
|
79514
|
+
},
|
|
79515
|
+
"createdAt": {
|
|
79516
|
+
"type": "string",
|
|
79517
|
+
"format": "date-time",
|
|
79518
|
+
"description": "ISO 8601 formatted date",
|
|
79519
|
+
"readOnly": true
|
|
79520
|
+
}
|
|
79521
|
+
},
|
|
79522
|
+
"required": [
|
|
79523
|
+
"id",
|
|
79524
|
+
"type",
|
|
79525
|
+
"createdAt"
|
|
79526
|
+
]
|
|
79527
|
+
}
|
|
79528
|
+
},
|
|
79529
|
+
"links": {
|
|
79530
|
+
"type": "object",
|
|
79531
|
+
"properties": {
|
|
79532
|
+
"first": {
|
|
79533
|
+
"type": "string",
|
|
79534
|
+
"description": "The URL to fetch the first page",
|
|
79535
|
+
"nullable": true
|
|
79536
|
+
},
|
|
79537
|
+
"last": {
|
|
79538
|
+
"type": "string",
|
|
79539
|
+
"description": "The URL to fetch the last page",
|
|
79540
|
+
"nullable": true
|
|
79541
|
+
},
|
|
79542
|
+
"prev": {
|
|
79543
|
+
"type": "string",
|
|
79544
|
+
"description": "The URL to fetch the previous page",
|
|
79545
|
+
"nullable": true
|
|
79546
|
+
},
|
|
79547
|
+
"next": {
|
|
79548
|
+
"type": "string",
|
|
79549
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
79550
|
+
"nullable": true
|
|
79551
|
+
}
|
|
79552
|
+
}
|
|
79553
|
+
},
|
|
79554
|
+
"meta": {
|
|
79555
|
+
"type": "object",
|
|
79556
|
+
"properties": {
|
|
79557
|
+
"path": {
|
|
79558
|
+
"type": "string",
|
|
79559
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
79560
|
+
},
|
|
79561
|
+
"per_page": {
|
|
79562
|
+
"type": "integer",
|
|
79563
|
+
"description": "The max number of items in each page"
|
|
79564
|
+
},
|
|
79565
|
+
"next_cursor": {
|
|
79566
|
+
"type": "string",
|
|
79567
|
+
"description": "The cursor to fetch the next page. Do not use this directly. It will be populated by using the previous response's links.next.",
|
|
79568
|
+
"nullable": true
|
|
79569
|
+
},
|
|
79570
|
+
"prev_cursor": {
|
|
79571
|
+
"type": "string",
|
|
79572
|
+
"description": "The cursor to fetch the previous page. Do not use this directly. It will be populated by using the previous response's links.prev.",
|
|
79573
|
+
"nullable": true
|
|
79574
|
+
}
|
|
79575
|
+
}
|
|
79576
|
+
}
|
|
79577
|
+
}
|
|
79578
|
+
}
|
|
79579
|
+
},
|
|
79580
|
+
"401": {
|
|
79581
|
+
"schema": {
|
|
79582
|
+
"type": "object",
|
|
79583
|
+
"properties": {
|
|
79584
|
+
"message": {
|
|
79585
|
+
"type": "string"
|
|
79586
|
+
}
|
|
79587
|
+
}
|
|
79588
|
+
}
|
|
79589
|
+
},
|
|
79590
|
+
"403": {
|
|
79591
|
+
"schema": {
|
|
79592
|
+
"type": "object",
|
|
79593
|
+
"properties": {
|
|
79594
|
+
"message": {
|
|
79595
|
+
"type": "string",
|
|
79596
|
+
"default": "This action is unauthorized."
|
|
79597
|
+
}
|
|
79598
|
+
}
|
|
79599
|
+
}
|
|
79600
|
+
},
|
|
79601
|
+
"422": {
|
|
79602
|
+
"schema": {
|
|
79603
|
+
"type": "object",
|
|
79604
|
+
"required": [
|
|
79605
|
+
"message"
|
|
79606
|
+
],
|
|
79607
|
+
"properties": {
|
|
79608
|
+
"message": {
|
|
79609
|
+
"type": "string"
|
|
79610
|
+
},
|
|
79611
|
+
"errors": {
|
|
79612
|
+
"type": "object",
|
|
79613
|
+
"additionalProperties": {
|
|
79614
|
+
"type": "array",
|
|
79615
|
+
"items": {
|
|
79616
|
+
"type": "string"
|
|
79617
|
+
}
|
|
79618
|
+
}
|
|
79619
|
+
}
|
|
79620
|
+
}
|
|
79621
|
+
}
|
|
79622
|
+
},
|
|
79623
|
+
"429": {
|
|
79624
|
+
"schema": {
|
|
79625
|
+
"type": "object",
|
|
79626
|
+
"properties": {
|
|
79627
|
+
"message": {
|
|
79628
|
+
"type": "string"
|
|
79629
|
+
}
|
|
79630
|
+
}
|
|
79631
|
+
}
|
|
79632
|
+
}
|
|
79633
|
+
},
|
|
79634
|
+
"ocpiCommandRead": {
|
|
79635
|
+
"200": {
|
|
79636
|
+
"schema": {
|
|
79637
|
+
"type": "object",
|
|
79638
|
+
"properties": {
|
|
79639
|
+
"data": {
|
|
79640
|
+
"description": "A command received from an eMSP over OCPI and the result returned for it.",
|
|
79641
|
+
"type": "object",
|
|
79642
|
+
"properties": {
|
|
79643
|
+
"id": {
|
|
79644
|
+
"type": "integer",
|
|
79645
|
+
"readOnly": true,
|
|
79646
|
+
"description": "Identifier of the command."
|
|
79647
|
+
},
|
|
79648
|
+
"type": {
|
|
79649
|
+
"description": "The command the roaming partner sent:\n- **cancel_reservation**: Cancel a reservation\n- **reserve_now**: Reserve an EVSE\n- **start_session**: Start a charging session\n- **stop_session**: Stop a charging session\n- **unlock_connector**: Unlock a connector\n- **change_availability**: Change the availability of an EVSE (protocol extension)\n- **get_diagnostics**: Request charge point diagnostics (protocol extension)\n- **reset_evse**: Reset an EVSE (protocol extension)\n- **unknown**: Any command outside this set\n",
|
|
79650
|
+
"type": "string",
|
|
79651
|
+
"enum": [
|
|
79652
|
+
"cancel_reservation",
|
|
79653
|
+
"reserve_now",
|
|
79654
|
+
"start_session",
|
|
79655
|
+
"stop_session",
|
|
79656
|
+
"unlock_connector",
|
|
79657
|
+
"change_availability",
|
|
79658
|
+
"get_diagnostics",
|
|
79659
|
+
"reset_evse",
|
|
79660
|
+
"unknown"
|
|
79661
|
+
]
|
|
79662
|
+
},
|
|
79663
|
+
"result": {
|
|
79664
|
+
"description": "The result the platform returned to the roaming partner:\n- **accepted**: The command was accepted\n- **rejected**: The command was rejected\n- **not_supported**: The command is not supported for this charge point\n- **timeout**: The charge point did not respond in time\n- **unknown_session**: The referenced session is unknown\n- **failed**: The command failed during execution\n- **evse_occupied**: The EVSE is already in use\n- **evse_inoperative**: The EVSE is not operational\n- **unknown_reservation**: The referenced reservation is unknown\n- **canceled_reservation**: The reservation was cancelled\n- **unknown**: Any result outside the OCPI result set\n",
|
|
79665
|
+
"type": "string",
|
|
79666
|
+
"enum": [
|
|
79667
|
+
"accepted",
|
|
79668
|
+
"rejected",
|
|
79669
|
+
"not_supported",
|
|
79670
|
+
"timeout",
|
|
79671
|
+
"unknown_session",
|
|
79672
|
+
"failed",
|
|
79673
|
+
"evse_occupied",
|
|
79674
|
+
"evse_inoperative",
|
|
79675
|
+
"unknown_reservation",
|
|
79676
|
+
"canceled_reservation",
|
|
79677
|
+
"unknown"
|
|
79678
|
+
]
|
|
79679
|
+
},
|
|
79680
|
+
"failureReason": {
|
|
79681
|
+
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: The corporate account limit is reached\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
|
|
79682
|
+
"type": "string",
|
|
79683
|
+
"enum": [
|
|
79684
|
+
"charging_not_allowed",
|
|
79685
|
+
"location_is_closed",
|
|
79686
|
+
"access_restricted",
|
|
79687
|
+
"user_verification_not_complete",
|
|
79688
|
+
"terms_not_accepted",
|
|
79689
|
+
"subscription_required",
|
|
79690
|
+
"cannot_bill_payment_method",
|
|
79691
|
+
"session_already_running",
|
|
79692
|
+
"previous_session_not_paid",
|
|
79693
|
+
"unpaid_subscription_fees",
|
|
79694
|
+
"payment_method_required",
|
|
79695
|
+
"corporate_billing_policy_inactive",
|
|
79696
|
+
"corporate_billing_limit_exceeded",
|
|
79697
|
+
"corporate_account_limit_reached",
|
|
79698
|
+
"corporate_billing_currency_mismatch",
|
|
79699
|
+
"corporate_billing_cross_operator_not_opted_in",
|
|
79700
|
+
"corporate_billing_exchange_rate_unavailable",
|
|
79701
|
+
"corporate_billing_charger_type_not_covered",
|
|
79702
|
+
"corporate_billing_partner_not_covered",
|
|
79703
|
+
"corporate_billing_country_not_covered",
|
|
79704
|
+
"corporate_billing_location_not_covered",
|
|
79705
|
+
"corporate_billing_location_tag_not_covered",
|
|
79706
|
+
"corporate_billing_roaming_not_covered",
|
|
79707
|
+
"payment_method_expired",
|
|
79708
|
+
"payment_method_not_allowed",
|
|
79709
|
+
"payment_method_doesnt_have_sufficient_funds",
|
|
79710
|
+
"internal_roaming_not_setup",
|
|
79711
|
+
"rfid_tag_expired",
|
|
79712
|
+
"rfid_tag_disabled",
|
|
79713
|
+
"rfid_tag_suspended",
|
|
79714
|
+
"user_invoice_details_not_provided",
|
|
79715
|
+
"invalid_payment_method_for_direct_charges",
|
|
79716
|
+
"user_is_disabled",
|
|
79717
|
+
"token_not_authorized_for_booking",
|
|
79718
|
+
"evse_has_queued_reservations",
|
|
79719
|
+
"evse_disabled",
|
|
79720
|
+
"evse_out_of_order",
|
|
79721
|
+
"tariff_charging_not_allowed",
|
|
79722
|
+
"no_tariff_group_configured",
|
|
79723
|
+
"tariff_resolution_failed",
|
|
79724
|
+
"operator_in_migration_mode",
|
|
79725
|
+
"rfid_charge_point_scope_mismatch",
|
|
79726
|
+
"remote_start_failed",
|
|
79727
|
+
"rejected",
|
|
79728
|
+
"canceled_reservation",
|
|
79729
|
+
"evse_occupied",
|
|
79730
|
+
"evse_inoperative",
|
|
79731
|
+
"failed",
|
|
79732
|
+
"not_supported",
|
|
79733
|
+
"timeout",
|
|
79734
|
+
"unknown_reservation",
|
|
79735
|
+
"ev_not_connected_to_evse",
|
|
79736
|
+
"authorization_failed",
|
|
79737
|
+
"pre_authorization_failed",
|
|
79738
|
+
"unknown_session",
|
|
79739
|
+
"ocpi_roaming_not_setup",
|
|
79740
|
+
"command_expired"
|
|
79741
|
+
]
|
|
79742
|
+
},
|
|
79743
|
+
"sessionId": {
|
|
79744
|
+
"type": "integer",
|
|
79745
|
+
"description": "The related charging session ID."
|
|
79746
|
+
},
|
|
79747
|
+
"reservationId": {
|
|
79748
|
+
"type": "integer",
|
|
79749
|
+
"description": "The related reservation ID."
|
|
79750
|
+
},
|
|
79751
|
+
"evseId": {
|
|
79752
|
+
"type": "integer",
|
|
79753
|
+
"description": "The targeted EVSE ID."
|
|
79754
|
+
},
|
|
79755
|
+
"roamingEmspId": {
|
|
79756
|
+
"type": "integer",
|
|
79757
|
+
"description": "The roaming eMSP ID (`resources/roaming-emsps/v1.0`) the command was received from."
|
|
79758
|
+
},
|
|
79759
|
+
"roamingConnectionId": {
|
|
79760
|
+
"type": "integer",
|
|
79761
|
+
"description": "The roaming connection ID."
|
|
79762
|
+
},
|
|
79763
|
+
"createdAt": {
|
|
79764
|
+
"type": "string",
|
|
79765
|
+
"format": "date-time",
|
|
79766
|
+
"description": "ISO 8601 formatted date",
|
|
79767
|
+
"readOnly": true
|
|
79768
|
+
}
|
|
79769
|
+
},
|
|
79770
|
+
"required": [
|
|
79771
|
+
"id",
|
|
79772
|
+
"type",
|
|
79773
|
+
"createdAt"
|
|
79774
|
+
]
|
|
79775
|
+
}
|
|
79776
|
+
}
|
|
79777
|
+
}
|
|
79778
|
+
},
|
|
79779
|
+
"401": {
|
|
79780
|
+
"schema": {
|
|
79781
|
+
"type": "object",
|
|
79782
|
+
"properties": {
|
|
79783
|
+
"message": {
|
|
79784
|
+
"type": "string"
|
|
79785
|
+
}
|
|
79786
|
+
}
|
|
79787
|
+
}
|
|
79788
|
+
},
|
|
79789
|
+
"403": {
|
|
79790
|
+
"schema": {
|
|
79791
|
+
"type": "object",
|
|
79792
|
+
"properties": {
|
|
79793
|
+
"message": {
|
|
79794
|
+
"type": "string",
|
|
79795
|
+
"default": "This action is unauthorized."
|
|
79796
|
+
}
|
|
79797
|
+
}
|
|
79798
|
+
}
|
|
79799
|
+
},
|
|
79800
|
+
"404": {
|
|
79801
|
+
"schema": {
|
|
79802
|
+
"type": "object",
|
|
79803
|
+
"properties": {
|
|
79804
|
+
"message": {
|
|
79805
|
+
"type": "string"
|
|
79806
|
+
}
|
|
79807
|
+
}
|
|
79808
|
+
}
|
|
79809
|
+
},
|
|
79356
79810
|
"429": {
|
|
79357
79811
|
"schema": {
|
|
79358
79812
|
"type": "object",
|
|
@@ -93579,7 +94033,8 @@
|
|
|
93579
94033
|
"de-CH",
|
|
93580
94034
|
"fr-CH",
|
|
93581
94035
|
"it-CH",
|
|
93582
|
-
"en-GB"
|
|
94036
|
+
"en-GB",
|
|
94037
|
+
"tl-PH"
|
|
93583
94038
|
]
|
|
93584
94039
|
},
|
|
93585
94040
|
"acceptUrl": {
|
|
@@ -93890,7 +94345,8 @@
|
|
|
93890
94345
|
"de-CH",
|
|
93891
94346
|
"fr-CH",
|
|
93892
94347
|
"it-CH",
|
|
93893
|
-
"en-GB"
|
|
94348
|
+
"en-GB",
|
|
94349
|
+
"tl-PH"
|
|
93894
94350
|
]
|
|
93895
94351
|
},
|
|
93896
94352
|
"acceptUrl": {
|
|
@@ -94152,7 +94608,8 @@
|
|
|
94152
94608
|
"de-CH",
|
|
94153
94609
|
"fr-CH",
|
|
94154
94610
|
"it-CH",
|
|
94155
|
-
"en-GB"
|
|
94611
|
+
"en-GB",
|
|
94612
|
+
"tl-PH"
|
|
94156
94613
|
]
|
|
94157
94614
|
},
|
|
94158
94615
|
"acceptUrl": {
|
|
@@ -94445,7 +94902,8 @@
|
|
|
94445
94902
|
"de-CH",
|
|
94446
94903
|
"fr-CH",
|
|
94447
94904
|
"it-CH",
|
|
94448
|
-
"en-GB"
|
|
94905
|
+
"en-GB",
|
|
94906
|
+
"tl-PH"
|
|
94449
94907
|
]
|
|
94450
94908
|
},
|
|
94451
94909
|
"acceptUrl": {
|
|
@@ -101480,7 +101938,8 @@
|
|
|
101480
101938
|
"de-CH",
|
|
101481
101939
|
"fr-CH",
|
|
101482
101940
|
"it-CH",
|
|
101483
|
-
"en-GB"
|
|
101941
|
+
"en-GB",
|
|
101942
|
+
"tl-PH"
|
|
101484
101943
|
]
|
|
101485
101944
|
}
|
|
101486
101945
|
}
|
|
@@ -102721,7 +103180,8 @@
|
|
|
102721
103180
|
"de-CH",
|
|
102722
103181
|
"fr-CH",
|
|
102723
103182
|
"it-CH",
|
|
102724
|
-
"en-GB"
|
|
103183
|
+
"en-GB",
|
|
103184
|
+
"tl-PH"
|
|
102725
103185
|
]
|
|
102726
103186
|
}
|
|
102727
103187
|
}
|
|
@@ -103837,7 +104297,8 @@
|
|
|
103837
104297
|
"de-CH",
|
|
103838
104298
|
"fr-CH",
|
|
103839
104299
|
"it-CH",
|
|
103840
|
-
"en-GB"
|
|
104300
|
+
"en-GB",
|
|
104301
|
+
"tl-PH"
|
|
103841
104302
|
]
|
|
103842
104303
|
}
|
|
103843
104304
|
}
|
|
@@ -105016,7 +105477,8 @@
|
|
|
105016
105477
|
"de-CH",
|
|
105017
105478
|
"fr-CH",
|
|
105018
105479
|
"it-CH",
|
|
105019
|
-
"en-GB"
|
|
105480
|
+
"en-GB",
|
|
105481
|
+
"tl-PH"
|
|
105020
105482
|
]
|
|
105021
105483
|
}
|
|
105022
105484
|
}
|
|
@@ -129176,14 +129638,16 @@
|
|
|
129176
129638
|
"description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
|
|
129177
129639
|
},
|
|
129178
129640
|
"restrictionCause": {
|
|
129179
|
-
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
|
|
129641
|
+
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
|
|
129180
129642
|
"type": "string",
|
|
129181
129643
|
"enum": [
|
|
129182
129644
|
"partner",
|
|
129183
129645
|
"country",
|
|
129184
129646
|
"location",
|
|
129185
129647
|
"location_tag",
|
|
129186
|
-
"roaming"
|
|
129648
|
+
"roaming",
|
|
129649
|
+
"cross_operator_not_opted_in",
|
|
129650
|
+
"exchange_rate_unavailable"
|
|
129187
129651
|
]
|
|
129188
129652
|
},
|
|
129189
129653
|
"breakdown": {
|
|
@@ -130456,14 +130920,16 @@
|
|
|
130456
130920
|
"description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
|
|
130457
130921
|
},
|
|
130458
130922
|
"restrictionCause": {
|
|
130459
|
-
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
|
|
130923
|
+
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n- **cross_operator_not_opted_in**: The service operator and the corporate account home operator have not both opted in to cross-operator corporate billing\n- **exchange_rate_unavailable**: No exchange rate was available to convert the session currency into the corporate account billing currency\n",
|
|
130460
130924
|
"type": "string",
|
|
130461
130925
|
"enum": [
|
|
130462
130926
|
"partner",
|
|
130463
130927
|
"country",
|
|
130464
130928
|
"location",
|
|
130465
130929
|
"location_tag",
|
|
130466
|
-
"roaming"
|
|
130930
|
+
"roaming",
|
|
130931
|
+
"cross_operator_not_opted_in",
|
|
130932
|
+
"exchange_rate_unavailable"
|
|
130467
130933
|
]
|
|
130468
130934
|
},
|
|
130469
130935
|
"breakdown": {
|
|
@@ -142194,6 +142660,29 @@
|
|
|
142194
142660
|
"maximum": 99,
|
|
142195
142661
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
142196
142662
|
"nullable": true
|
|
142663
|
+
},
|
|
142664
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
142665
|
+
"type": "number",
|
|
142666
|
+
"format": "decimal",
|
|
142667
|
+
"minimum": 0,
|
|
142668
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
142669
|
+
},
|
|
142670
|
+
"autoStopAmount": {
|
|
142671
|
+
"type": "number",
|
|
142672
|
+
"format": "decimal",
|
|
142673
|
+
"minimum": 0,
|
|
142674
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
142675
|
+
}
|
|
142676
|
+
}
|
|
142677
|
+
},
|
|
142678
|
+
"startSessionRestrictions": {
|
|
142679
|
+
"type": "object",
|
|
142680
|
+
"properties": {
|
|
142681
|
+
"minimumBalance": {
|
|
142682
|
+
"type": "number",
|
|
142683
|
+
"format": "decimal",
|
|
142684
|
+
"minimum": 0,
|
|
142685
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
142197
142686
|
}
|
|
142198
142687
|
}
|
|
142199
142688
|
},
|
|
@@ -143348,6 +143837,29 @@
|
|
|
143348
143837
|
"maximum": 99,
|
|
143349
143838
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
143350
143839
|
"nullable": true
|
|
143840
|
+
},
|
|
143841
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
143842
|
+
"type": "number",
|
|
143843
|
+
"format": "decimal",
|
|
143844
|
+
"minimum": 0,
|
|
143845
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
143846
|
+
},
|
|
143847
|
+
"autoStopAmount": {
|
|
143848
|
+
"type": "number",
|
|
143849
|
+
"format": "decimal",
|
|
143850
|
+
"minimum": 0,
|
|
143851
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
143852
|
+
}
|
|
143853
|
+
}
|
|
143854
|
+
},
|
|
143855
|
+
"startSessionRestrictions": {
|
|
143856
|
+
"type": "object",
|
|
143857
|
+
"properties": {
|
|
143858
|
+
"minimumBalance": {
|
|
143859
|
+
"type": "number",
|
|
143860
|
+
"format": "decimal",
|
|
143861
|
+
"minimum": 0,
|
|
143862
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
143351
143863
|
}
|
|
143352
143864
|
}
|
|
143353
143865
|
},
|
|
@@ -144629,6 +145141,29 @@
|
|
|
144629
145141
|
"maximum": 99,
|
|
144630
145142
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
144631
145143
|
"nullable": true
|
|
145144
|
+
},
|
|
145145
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
145146
|
+
"type": "number",
|
|
145147
|
+
"format": "decimal",
|
|
145148
|
+
"minimum": 0,
|
|
145149
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
145150
|
+
},
|
|
145151
|
+
"autoStopAmount": {
|
|
145152
|
+
"type": "number",
|
|
145153
|
+
"format": "decimal",
|
|
145154
|
+
"minimum": 0,
|
|
145155
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
145156
|
+
}
|
|
145157
|
+
}
|
|
145158
|
+
},
|
|
145159
|
+
"startSessionRestrictions": {
|
|
145160
|
+
"type": "object",
|
|
145161
|
+
"properties": {
|
|
145162
|
+
"minimumBalance": {
|
|
145163
|
+
"type": "number",
|
|
145164
|
+
"format": "decimal",
|
|
145165
|
+
"minimum": 0,
|
|
145166
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
144632
145167
|
}
|
|
144633
145168
|
}
|
|
144634
145169
|
},
|
|
@@ -145795,6 +146330,29 @@
|
|
|
145795
146330
|
"maximum": 99,
|
|
145796
146331
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
145797
146332
|
"nullable": true
|
|
146333
|
+
},
|
|
146334
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
146335
|
+
"type": "number",
|
|
146336
|
+
"format": "decimal",
|
|
146337
|
+
"minimum": 0,
|
|
146338
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
146339
|
+
},
|
|
146340
|
+
"autoStopAmount": {
|
|
146341
|
+
"type": "number",
|
|
146342
|
+
"format": "decimal",
|
|
146343
|
+
"minimum": 0,
|
|
146344
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
146345
|
+
}
|
|
146346
|
+
}
|
|
146347
|
+
},
|
|
146348
|
+
"startSessionRestrictions": {
|
|
146349
|
+
"type": "object",
|
|
146350
|
+
"properties": {
|
|
146351
|
+
"minimumBalance": {
|
|
146352
|
+
"type": "number",
|
|
146353
|
+
"format": "decimal",
|
|
146354
|
+
"minimum": 0,
|
|
146355
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
145798
146356
|
}
|
|
145799
146357
|
}
|
|
145800
146358
|
},
|
|
@@ -146949,6 +147507,29 @@
|
|
|
146949
147507
|
"maximum": 99,
|
|
146950
147508
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
146951
147509
|
"nullable": true
|
|
147510
|
+
},
|
|
147511
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
147512
|
+
"type": "number",
|
|
147513
|
+
"format": "decimal",
|
|
147514
|
+
"minimum": 0,
|
|
147515
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
147516
|
+
},
|
|
147517
|
+
"autoStopAmount": {
|
|
147518
|
+
"type": "number",
|
|
147519
|
+
"format": "decimal",
|
|
147520
|
+
"minimum": 0,
|
|
147521
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
147522
|
+
}
|
|
147523
|
+
}
|
|
147524
|
+
},
|
|
147525
|
+
"startSessionRestrictions": {
|
|
147526
|
+
"type": "object",
|
|
147527
|
+
"properties": {
|
|
147528
|
+
"minimumBalance": {
|
|
147529
|
+
"type": "number",
|
|
147530
|
+
"format": "decimal",
|
|
147531
|
+
"minimum": 0,
|
|
147532
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
146952
147533
|
}
|
|
146953
147534
|
}
|
|
146954
147535
|
},
|
|
@@ -148178,6 +148759,29 @@
|
|
|
148178
148759
|
"maximum": 99,
|
|
148179
148760
|
"description": "Stop the session when the vehicle's reported State of Charge reaches or exceeds this value. If the charge point does not report SoC, this criterion is ignored. Accepts values between 70 and 99.",
|
|
148180
148761
|
"nullable": true
|
|
148762
|
+
},
|
|
148763
|
+
"stopWhenPreAuthorizedAmountFallsBelow": {
|
|
148764
|
+
"type": "number",
|
|
148765
|
+
"format": "decimal",
|
|
148766
|
+
"minimum": 0,
|
|
148767
|
+
"description": "Tariff-level override that stops the session when the remaining pre-authorised amount drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method and authorize certain amount before starting session` or `Require payment method OR minimum amount in balance`, and currently only for tariff types `Duration + Energy`, `Duration + Energy ToD`, and `Power Levels`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
148768
|
+
},
|
|
148769
|
+
"autoStopAmount": {
|
|
148770
|
+
"type": "number",
|
|
148771
|
+
"format": "decimal",
|
|
148772
|
+
"minimum": 0,
|
|
148773
|
+
"description": "Tariff-level override that stops the session when the user's available balance drops below this value. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
148774
|
+
}
|
|
148775
|
+
}
|
|
148776
|
+
},
|
|
148777
|
+
"startSessionRestrictions": {
|
|
148778
|
+
"type": "object",
|
|
148779
|
+
"properties": {
|
|
148780
|
+
"minimumBalance": {
|
|
148781
|
+
"type": "number",
|
|
148782
|
+
"format": "decimal",
|
|
148783
|
+
"minimum": 0,
|
|
148784
|
+
"description": "Tariff-level override for the minimum balance a user must have before a session is allowed to start. When unset, the global default from User billing settings applies. Honoured only when the tariff's billing strategy is `Require payment method OR minimum amount in balance`. Values set on a tariff with an incompatible billing strategy are reset to the global default on save.\n"
|
|
148181
148785
|
}
|
|
148182
148786
|
}
|
|
148183
148787
|
},
|
|
@@ -154943,12 +155547,14 @@
|
|
|
154943
155547
|
},
|
|
154944
155548
|
"invoiceId": {
|
|
154945
155549
|
"type": "integer",
|
|
154946
|
-
"nullable": true
|
|
155550
|
+
"nullable": true,
|
|
155551
|
+
"description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
|
|
154947
155552
|
},
|
|
154948
155553
|
"invoiceNo": {
|
|
154949
155554
|
"deprecated": true,
|
|
154950
155555
|
"type": "string",
|
|
154951
|
-
"nullable": true
|
|
155556
|
+
"nullable": true,
|
|
155557
|
+
"description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
|
|
154952
155558
|
},
|
|
154953
155559
|
"receiptId": {
|
|
154954
155560
|
"type": "integer",
|
|
@@ -155505,12 +156111,14 @@
|
|
|
155505
156111
|
},
|
|
155506
156112
|
"invoiceId": {
|
|
155507
156113
|
"type": "integer",
|
|
155508
|
-
"nullable": true
|
|
156114
|
+
"nullable": true,
|
|
156115
|
+
"description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
|
|
155509
156116
|
},
|
|
155510
156117
|
"invoiceNo": {
|
|
155511
156118
|
"deprecated": true,
|
|
155512
156119
|
"type": "string",
|
|
155513
|
-
"nullable": true
|
|
156120
|
+
"nullable": true,
|
|
156121
|
+
"description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
|
|
155514
156122
|
},
|
|
155515
156123
|
"receiptId": {
|
|
155516
156124
|
"type": "integer",
|
|
@@ -155805,6 +156413,19 @@
|
|
|
155805
156413
|
}
|
|
155806
156414
|
}
|
|
155807
156415
|
},
|
|
156416
|
+
"424": {
|
|
156417
|
+
"schema": {
|
|
156418
|
+
"type": "object",
|
|
156419
|
+
"required": [
|
|
156420
|
+
"message"
|
|
156421
|
+
],
|
|
156422
|
+
"properties": {
|
|
156423
|
+
"message": {
|
|
156424
|
+
"type": "string"
|
|
156425
|
+
}
|
|
156426
|
+
}
|
|
156427
|
+
}
|
|
156428
|
+
},
|
|
155808
156429
|
"429": {
|
|
155809
156430
|
"schema": {
|
|
155810
156431
|
"type": "object",
|
|
@@ -155939,12 +156560,14 @@
|
|
|
155939
156560
|
},
|
|
155940
156561
|
"invoiceId": {
|
|
155941
156562
|
"type": "integer",
|
|
155942
|
-
"nullable": true
|
|
156563
|
+
"nullable": true,
|
|
156564
|
+
"description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
|
|
155943
156565
|
},
|
|
155944
156566
|
"invoiceNo": {
|
|
155945
156567
|
"deprecated": true,
|
|
155946
156568
|
"type": "string",
|
|
155947
|
-
"nullable": true
|
|
156569
|
+
"nullable": true,
|
|
156570
|
+
"description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
|
|
155948
156571
|
},
|
|
155949
156572
|
"receiptId": {
|
|
155950
156573
|
"type": "integer",
|
|
@@ -156384,12 +157007,14 @@
|
|
|
156384
157007
|
},
|
|
156385
157008
|
"invoiceId": {
|
|
156386
157009
|
"type": "integer",
|
|
156387
|
-
"nullable": true
|
|
157010
|
+
"nullable": true,
|
|
157011
|
+
"description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
|
|
156388
157012
|
},
|
|
156389
157013
|
"invoiceNo": {
|
|
156390
157014
|
"deprecated": true,
|
|
156391
157015
|
"type": "string",
|
|
156392
|
-
"nullable": true
|
|
157016
|
+
"nullable": true,
|
|
157017
|
+
"description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
|
|
156393
157018
|
},
|
|
156394
157019
|
"receiptId": {
|
|
156395
157020
|
"type": "integer",
|
|
@@ -156684,6 +157309,19 @@
|
|
|
156684
157309
|
}
|
|
156685
157310
|
}
|
|
156686
157311
|
},
|
|
157312
|
+
"424": {
|
|
157313
|
+
"schema": {
|
|
157314
|
+
"type": "object",
|
|
157315
|
+
"required": [
|
|
157316
|
+
"message"
|
|
157317
|
+
],
|
|
157318
|
+
"properties": {
|
|
157319
|
+
"message": {
|
|
157320
|
+
"type": "string"
|
|
157321
|
+
}
|
|
157322
|
+
}
|
|
157323
|
+
}
|
|
157324
|
+
},
|
|
156687
157325
|
"429": {
|
|
156688
157326
|
"schema": {
|
|
156689
157327
|
"type": "object",
|
|
@@ -157413,6 +158051,120 @@
|
|
|
157413
158051
|
}
|
|
157414
158052
|
}
|
|
157415
158053
|
},
|
|
158054
|
+
"userGroupReplace": {
|
|
158055
|
+
"200": {
|
|
158056
|
+
"schema": {
|
|
158057
|
+
"type": "object",
|
|
158058
|
+
"properties": {
|
|
158059
|
+
"data": {
|
|
158060
|
+
"type": "object",
|
|
158061
|
+
"properties": {
|
|
158062
|
+
"id": {
|
|
158063
|
+
"type": "integer",
|
|
158064
|
+
"readOnly": true
|
|
158065
|
+
},
|
|
158066
|
+
"operatorId": {
|
|
158067
|
+
"type": "integer",
|
|
158068
|
+
"readOnly": true,
|
|
158069
|
+
"description": "The ID of the operator this resource belongs to",
|
|
158070
|
+
"example": 1
|
|
158071
|
+
},
|
|
158072
|
+
"name": {
|
|
158073
|
+
"type": "string"
|
|
158074
|
+
},
|
|
158075
|
+
"partnerId": {
|
|
158076
|
+
"type": "integer",
|
|
158077
|
+
"description": "The partnerId can be updated only if there are no users added to the user group",
|
|
158078
|
+
"nullable": true
|
|
158079
|
+
},
|
|
158080
|
+
"description": {
|
|
158081
|
+
"type": "string",
|
|
158082
|
+
"nullable": true
|
|
158083
|
+
},
|
|
158084
|
+
"externalId": {
|
|
158085
|
+
"type": "string",
|
|
158086
|
+
"description": "Used to store custom information, usually used for external references or metadata to the resource."
|
|
158087
|
+
},
|
|
158088
|
+
"lastUpdatedAt": {
|
|
158089
|
+
"type": "string",
|
|
158090
|
+
"format": "date-time",
|
|
158091
|
+
"description": "ISO 8601 formatted date",
|
|
158092
|
+
"readOnly": true
|
|
158093
|
+
}
|
|
158094
|
+
},
|
|
158095
|
+
"required": [
|
|
158096
|
+
"id",
|
|
158097
|
+
"operatorId",
|
|
158098
|
+
"name"
|
|
158099
|
+
]
|
|
158100
|
+
}
|
|
158101
|
+
}
|
|
158102
|
+
}
|
|
158103
|
+
},
|
|
158104
|
+
"401": {
|
|
158105
|
+
"schema": {
|
|
158106
|
+
"type": "object",
|
|
158107
|
+
"properties": {
|
|
158108
|
+
"message": {
|
|
158109
|
+
"type": "string"
|
|
158110
|
+
}
|
|
158111
|
+
}
|
|
158112
|
+
}
|
|
158113
|
+
},
|
|
158114
|
+
"403": {
|
|
158115
|
+
"schema": {
|
|
158116
|
+
"type": "object",
|
|
158117
|
+
"properties": {
|
|
158118
|
+
"message": {
|
|
158119
|
+
"type": "string",
|
|
158120
|
+
"default": "This action is unauthorized."
|
|
158121
|
+
}
|
|
158122
|
+
}
|
|
158123
|
+
}
|
|
158124
|
+
},
|
|
158125
|
+
"404": {
|
|
158126
|
+
"schema": {
|
|
158127
|
+
"type": "object",
|
|
158128
|
+
"properties": {
|
|
158129
|
+
"message": {
|
|
158130
|
+
"type": "string"
|
|
158131
|
+
}
|
|
158132
|
+
}
|
|
158133
|
+
}
|
|
158134
|
+
},
|
|
158135
|
+
"422": {
|
|
158136
|
+
"schema": {
|
|
158137
|
+
"type": "object",
|
|
158138
|
+
"required": [
|
|
158139
|
+
"message"
|
|
158140
|
+
],
|
|
158141
|
+
"properties": {
|
|
158142
|
+
"message": {
|
|
158143
|
+
"type": "string"
|
|
158144
|
+
},
|
|
158145
|
+
"errors": {
|
|
158146
|
+
"type": "object",
|
|
158147
|
+
"additionalProperties": {
|
|
158148
|
+
"type": "array",
|
|
158149
|
+
"items": {
|
|
158150
|
+
"type": "string"
|
|
158151
|
+
}
|
|
158152
|
+
}
|
|
158153
|
+
}
|
|
158154
|
+
}
|
|
158155
|
+
}
|
|
158156
|
+
},
|
|
158157
|
+
"429": {
|
|
158158
|
+
"schema": {
|
|
158159
|
+
"type": "object",
|
|
158160
|
+
"properties": {
|
|
158161
|
+
"message": {
|
|
158162
|
+
"type": "string"
|
|
158163
|
+
}
|
|
158164
|
+
}
|
|
158165
|
+
}
|
|
158166
|
+
}
|
|
158167
|
+
},
|
|
157416
158168
|
"userGroupDelete": {
|
|
157417
158169
|
"401": {
|
|
157418
158170
|
"schema": {
|