Changelog

2022-03-30 - Preprod

  • New : Improved the use of the resourceId
    You can now use a string version of the id, which will include the boatId to access a specific boat.
    A resource is originally an object based on a "master boat", which is the primary boat of a set of multiple boats. Secondary boats inherits prices, some options, but doesn't share the same availabilities as its siblings. When specifying just the primary resource, a rental will be created on the first subset available. When specifying a secondary resource, the targeted subset will be used for the creation of the rental. As well on the availabilities.
    The format of the stringable resourceId is the following:
    {resourceId}-{boatId}
    Example: 4394-6684 is the flotilla/boatId 6684 corresponding to the resource 4394

2022-03-07

  • Added 'false' value to 'partners' filter on v3/companies to get refused terms of sales

2020-05-27

Improvements

  • Better handling of exceptions

  • Hooks are triggered more regularly

Bugfixes

  • Fix availability endpoints, the response now reflects the availabilities of the flotilla

  • Fix unavailability endpoint, the response now reflects the unavailabilities of the flotilla

Feature

  • A "Last minute" option can be defined by our professionnals to allow publication during a short window of time if the resource is available for a rental.

  • Two new hooks for the publication :

    • Resource / Published, when a set of resources is published
    • Resource / Unpublished, when a set of resources is unpublished

2020-04-16

Improvements

  • Added gzip compression. You can use gzip compression by adding the following header to your requests : 'Accept-Encoding: gzip' It can be useful to save bandwith on large requests as the pricetable, or objects, like resources.
  • Added caching mechanisms, bringing significant performance improvements over the response time on some endpoints. Many other improvements to come later.

Bugfixes

  • Delete a crew member or an user returns a 204 code.

  • Fix header Accept to be used with aplication/xml and application/json responses

  • Fix header Accept-Language to define the language of the reponse you will receive. The "locale" parameter is being deprecated and will be discontinued in the future.

Deprecations

  • The "locale" parameter is being deprecated and will be discontinued in the future. Please use the header Accept-Language to define the language of the response you want to get.

2020-04-01

Updates

  • Ability to update more fields into PUT /v3/rentals/{rentalId}, the same fields you can edit when creating a rental

2020-03-18

Features

  • Add of a new endpoint GET /v3/resources/{resourceId}/pricetable to get the pricings of a resource. This endpoint is faster than the /pricings endpoint and returns all the prices of the resources between two given dates.

Bugfixes

  • Fixed PUT /v3/rentals/{rentalId} to cancel a rental.
  • The informations about the partner is no longer stored in the internal message of a Rental after a creation

Updates

  • Update DELETE /v3/rentals/{rentalId} to delete a rental, the cancellation have to be called via PUT /v3/rentals/{rentalId}

Deprecations

  • The endpoint /v3/resources/{resourceId}/pricings is now marked as deprecated. You should use the new /v3/resources/{resourceId}/pricetable endpoint to get the pricings.

2020-03-04

Features

  • 'name' is added on the Resource object, alongside the boatId.

Bugfixes

  • Fixed an error triggered when trying to change the email of an user

Deprecations

  • No deprecated elements in this release

2020-02-19

Features

  • No new features in this release

Bugfixes

  • Search - Searching availabilities failed when querying an end date
  • Pagination - When specifying a page which is out of range, an empty response will now be returned instead of the last page

Deprecations

  • No deprecated elements in this release

2020-01-22

Features

  • It is now possible to edit your webhooks directly. See the webhook guide for more information.

  • The Rental API is more flexible. It is now possible to edit options, and payment lines after the rental has been validated.

  • New /rentalPaymentMethods endpoint. Lists available rental payment methods.

  • New /userLicenseTypes endpoint. Lists available user license types.

  • Documentation improvements: whenever an endpoint expects a specific pattern, that pattern will also be visible in the documentation. It was previsouly only displayed on the OpenAPI export.

Bugfixes

  • /resources/{id}/durations: takes battery into account when returning available durations. In practice, that means the endpoint won't respond with durations longer than the battery's autonomy.

  • /users: Does not return deactived users by default. You'll need to use the new ?deactivated=true param for that.

  • PUT /users: Some fields weren't properly edited.

Deprecations

  • Disabling pagination with ?pagination=false is now deprecated. For some endpoints, the endpoint returns the entire dataset. For others, the endpoint only returns 20 elements at a time. Details follow:
    • Endpoints returning their entire dataset at once:
    • /administrativeAreaLevel1
    • /administrativeAreaLevel2
    • /characteristics
    • /cities
    • /companyLegalForms
    • /countries
    • /equipments
    • /harbours
    • /navigationAreas
    • /subtypes
    • /types
    • Paginated endpoint where you cannot disable pagination anymore:
    • /companies
    • /rentals
    • /resources
    • /users

2019-10-07

Features

  • New expandTranslations parameter available on localized endpoints. When set to true, instead of returning localized data as strings, will return localized data as an object. The key is the locale, and the value is the localized data. Furthermore, the default key contains text that should be used whenever localized data isn't available for the desired locale. We want to make this format the new default, but deprecation of the old format isn't planned right now.

Bugfixes

  • None

Deprecations

  • None

2019-09-18

Features

  • New endpoint: /v3/resources/{resourceID}/unavailabilities This endpoint takes in a resource ID, a starting date, and an ending date. It responds with a list of unavailable dates. The information returned is more precise than the "availabilities" bitstring. It may prove useful if you're building a dynamic calendar, for instance.

  • New param to automatically add mandatory options when initiating. Instead of having to keep track of which options are mandatory, and then adding them to the already initiated rental, you can add all mandatory options to the rental by setting "addMandatoryOptions" to "true" on the rental creation object. Please note however that mandatory options aren't necessary free, so the final rental price may differ from the sole slot price.

  • We no longer check for minimum downpayment. We previously made sure you paid at least the amount required by our renters. However, if you know for sure a renter is OK with a different amount, then you may simply confirm the rental with a different amount, or even no additional payment entry either.

  • New filters on multiple endpoints:

    • "id" filter on /users endpoint
    • "name" filter on /users endpoint
    • "organizationType" filter on /users endpoint
    • "id" filter on /companies endpoint
    • "id" filter on /resources endpoint
    • "id" filter on /rental endpoint
    • "status" filter on /rental endpoint
  • Changes to existing filters

    • the "email" filter on /users endpoint uses ILIKE instead of "="

Bugfixes

  • In our documentation, a few IDs were incorrectly labeled as being of type "string". They are now correctly labeled as "integer".
  • In our documentation, a few IDs were labeled as "number" while only integers were allowed. This has been fixed.
  • In our documentation, a few strings were of format date or date-time, but they weren't explicitely labeled as such on the documentation. This has been fixed.

Deprecations

  • None