HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog
Terms of Use
Back to All

3.276.0 release notes

about 2 hours ago by ReadMe API
  1. ⚠️ Breaking changes
    1. Made partner.id required for sub-operator tokens on POST /public-api/resources/tariffs/v1.0 and PUT /public-api/resources/tariffs/v1.0/{tariff}, and partnerId required on POST /public-api/resources/tariff-groups/v1.0 and PUT /public-api/resources/tariff-groups/v1.0/{tariffGroup}. The partner must be assignable by the token's administrator; tariff requests that assign a different partner now also reject deleted partners and partners belonging to another operator.
    2. Changed tariff validation on POST /public-api/resources/tariffs/v1.0, PUT /public-api/resources/tariffs/v1.0/{tariff}, and PATCH /public-api/resources/tariffs/v1.0/{tariff} to reject non-object partner values. Sub-operator tokens cannot clear the partner assignment through PATCH.
    3. Made partnerId required for sub-operator tokens on POST /public-api/resources/vehicles/v1.0 and POST /public-api/resources/reimbursement-policies/v1.0, and non-null when supplied on PATCH /public-api/resources/vehicles/v1.0/{vehicle} and PATCH /public-api/resources/reimbursement-policies/v1.0/{reimbursementPolicy}. Requests made with partner tokens now use the token's own partner when creating these resources or supplying partnerId on an update.
    4. Changed partner validation on POST /public-api/resources/reimbursement-policies/v1.0 and PATCH /public-api/resources/reimbursement-policies/v1.0/{reimbursementPolicy} to require newly assigned partners to be assignable by the token's administrator and newly assigned partnerContractId values to belong to the effective partner.
    5. Removed access to POST /public-api/resources/users/v1.0 for sub-operator tokens.
    6. Removed integrationId and externalId from responses to installation and maintenance company tokens on GET /public-api/resources/installation-and-maintenance-companies/v1.0, GET /public-api/resources/installation-and-maintenance-companies/v1.0/{imCompany}, and PATCH /public-api/resources/installation-and-maintenance-companies/v1.0/{imCompany}. These tokens can no longer submit businessName, integrationId, or externalId on updates, or use filter[integrationId] and filter[externalId] on the listing; those requests return 422.
    7. Changed filter[method] validation on GET /public-api/resources/authorizations/v2.0 and GET /public-api/resources/authorizations/v2.1 to return 422 for unsupported authorization methods.
    8. Changed userId validation on POST /public-api/actions/charge-point/v1.0/{chargePoint}/change-owner to require a user visible to the token's administrator, rather than any existing user.
    9. Changed charge point assignment and sharing to return 409 when a new assignment targets an offboarding or disabled partner. Affected endpoints are POST /public-api/resources/charge-points/v1.0, PATCH /public-api/resources/charge-points/v1.0/{chargePoint}, POST /public-api/resources/charge-points/v2.0, and PUT /public-api/resources/charge-points/v2.0/{chargePoint}/shared-partners.
    10. Changed partner contract, invite, and administrator creation to return 409 when the partner is offboarding or disabled. Affected endpoints are POST /public-api/resources/partner-contracts/v1.0, POST /public-api/resources/partner-invites/v1.0, POST /public-api/resources/partner-invites/v2.0, and POST /public-api/resources/partners/v2.0/{partner}/admins; moving an invite to such a partner is also rejected on PATCH /public-api/resources/partner-invites/v1.0/{partnerInvite} and PATCH /public-api/resources/partner-invites/v2.0/{partnerInvite}.
    11. Changed POST /public-api/actions/partner-contract/v1.0/{partnerContract}/reactivate to return 409 while the partner is offboarding or disabled, and POST /public-api/actions/admin/v1.0/{admin}/activate to return 409 when the administrator belongs to a disabled partner or sub-operator. Enable the organization before retrying.
    12. Changed POST /public-api/actions/partner-invite/v1.0/{partnerInvite}/restore to return 409 when restoration is blocked by the partner or the original expiration date keeps the invite expired. Changes to expiresOn on PATCH /public-api/resources/partner-invites/v2.0/{partnerInvite} are also rejected with 409 when they would restore an invite blocked by the partner.
    13. Changed POST /public-api/actions/session/v1.0/{session}/retry-payment to return 409 when corporate billing refuses the retry and there is no unpaid driver amount to retry. When an unpaid driver amount exists, that amount can still be retried without charging the partner's refused amount to the driver's payment method.
    14. Changed GET /public-api/resources/users/v1.0/{user}/invoice-details and POST /public-api/resources/users/v1.0/{user}/invoice-details to enforce invoice-detail permissions for the token's administrator. Partner and sub-operator tokens receive 404 for users outside their scope.
  2. ✨ New features
    1. Added experimental partner lifecycle actions: POST /public-api/actions/partner/v1.0/{partner}/start-offboarding, POST /public-api/actions/partner/v1.0/{partner}/disable, and POST /public-api/actions/partner/v1.0/{partner}/enable. Offboarding requires endsOn and churnReason; disabling supports disableChargePoints, requires churnReason unless offboarding is already in progress, and both actions support keepViewOnlyAccess.
    2. Added experimental sub-operator lifecycle actions at POST /public-api/actions/sub-operator/v1.0/{subOperator}/disable and POST /public-api/actions/sub-operator/v1.0/{subOperator}/enable. Disabling accepts the optional keepViewOnlyAccess field.
    3. Added read-only status (enabled, offboarding, or disabled) and optional offboardingEndsOn fields to partner responses on GET /public-api/resources/partners/v2.0, POST /public-api/resources/partners/v2.0, GET /public-api/resources/partners/v2.0/{partner}, PATCH /public-api/resources/partners/v2.0/{partner}, and POST /public-api/actions/partner/v1.0/{partner}/set-custom-fields. The offboardingEndsOn field is present only during offboarding and gives the last day before the partner becomes disabled.
    4. Added a read-only status field (enabled or disabled) to sub-operator responses on GET /public-api/resources/sub-operators/v2.0, POST /public-api/resources/sub-operators/v2.0, GET /public-api/resources/sub-operators/v2.0/{subOperator}, and PATCH /public-api/resources/sub-operators/v2.0/{subOperator}.
    5. Added filter[status] to GET /public-api/resources/partners/v2.0 and GET /public-api/resources/sub-operators/v2.0 to filter by lifecycle status. Unsupported status values return 422.
    6. Added administrator endpoints at GET /public-api/resources/admins/v1.1, GET /public-api/resources/admins/v1.1/{admin}, PATCH /public-api/resources/admins/v1.1/{admin}, GET /public-api/resources/admins/v1.1/{admin}/permissions, and GET /public-api/resources/admins/v1.1/{admin}/sessions. In v1.1, expiresOn represents the last day of access, inclusive, in the administrator's operator timezone, rather than the deactivation date used by v1.0; updates accept today's date, and null clears the expiration date.
    7. Added partnerId to the request body on POST /public-api/resources/issues/v1.0 to associate an issue with a partner available to the token's administrator. The field is required for sub-operator tokens, optional for operator and global tokens, and cannot be supplied on PATCH /public-api/resources/issues/v1.0/{issue}.
  3. 🔧 Improvements
    1. Changed malformed request handling on POST /public-api/oauth/token and POST /public-api/oauth/revoke to return an OAuth invalid_request error when request fields fail validation.
    2. Changed PATCH /public-api/resources/tariffs/v1.0/{tariff} to preserve the existing partner assignment when partner is omitted or supplied without an id. Updates that resubmit the existing partner ID can retain that assignment without revalidating it as a new assignment.
    3. Changed charge point ownership validation errors on POST /public-api/resources/charge-points/v1.0, PATCH /public-api/resources/charge-points/v1.0/{chargePoint}, POST /public-api/resources/charge-points/v2.0, and PATCH /public-api/resources/charge-points/v2.0/{chargePoint} to associate additional ownership-contract errors with the corresponding public request field.
  4. 🗑️ Deprecations
    1. Deprecated GET /public-api/resources/admins/v1.0, GET /public-api/resources/admins/v1.0/{admin}, PATCH /public-api/resources/admins/v1.0/{admin}, GET /public-api/resources/admins/v1.0/{admin}/permissions, and GET /public-api/resources/admins/v1.0/{admin}/sessions in favor of their v1.1 equivalents. The v1.0 endpoints remain available.
    2. Deprecated the v1.0 expiresOn request and response field on the administrator endpoints above, and the expiresOn response field on POST /public-api/actions/admin/v1.0/{admin}/activate and POST /public-api/actions/admin/v1.0/{admin}/deactivate. Use the v1.1 administrator resource endpoints for last-day-of-access semantics.