Bredbandsval API changelog

Change log for Bredbandsval API. Changes listed here are the ones that are relevant to external users.

v2.23.0

Orders are refused if the start date is further ahead than each ISP allows. This result in a 400 error response. The number of days ahead allowed is output as the property allowedStartDateDaysAhead on each offer in the results output. It is also available as part of the terms endpoints (b2c/b2b). This new property is provided for users to be able to check how many days they should allow for an order in a GUI. Note that the allowed range differs between operators and also that they are seprate for b2c and b2b. See the documentation for examples and details.

The search status endpoint has a new boolean property called "finished". This should be used as check for when the search is completed and the result can be fetched. The previous method of checking that "pending" reached zero was susceptible to a race condition since some decorators might not have had time to run. The effect was that in rare cases a user could initially see offers that were not correct.

New TV channel output format displaying more info can be enabled by setting the query param format=cms on the TV channels endpoint.

New integrity terms.
New endpoints /terms/providers/b2c and /terms/providers/b2b for fetching links to operator terms.

All routes starting with /session are renamed /search. POST to /session is now replaced with POST to /search/create.
/search/create returns status code 201, instead of 202 used by /session.
References to the session identifier has been standardized and is now always used as 'sessionUUID' (used to be a mix of 'session' and 'sessionGuid').
Wrapper property 'data' has been removed from the status endpoint.
Status endpoint return each company as 'companyId' and not just 'company'.
Wrapper property 'data' has been removed from the result endpoint.
Result endpoint returns all offers in a single flat array in property 'offers'. Each offer has the product data in a property called 'product'.
Property on product data that was previously called 'groupDeal' is now called 'groupDealBroadband' to clarify and to allow separate properties for group deals on other products.

Deprecated path /session/{sessionUUID}/order has been removed. /order is now the valid path to create and finish an order. To create a draft order that can have order data added in multiple calls, use the endpoint /order/draft.
Endpoints for order extraction by operators have dropped the wrapper property 'data'.
The property 'selectedProducts' that can be sent to select extra additional products on order placing has been changed to be an array of product IDs and it is now called 'selectAdditionalProducts' to clarify that they are selected in additional to what is already selected (i.e. this array can not be used to deselect anything). See information about deselecting additional products under the new features section below.
Wrapper property 'data' has been dropped from response on order creation endpoints.

All error responses have been standardized. They are always returned in the property 'error' and contains a string code and a message property.

Possible to start search and wait for results using a GET request to /search.
Changelog available under /changelog.
Documentation available under /docs.
Possible to delesect pre-selected additional products (assuming that they have 'optional' set to true) by sending the ID of the additional product in the array 'deselectAdditionalProducts'.
Possible for the user that created an order to extract it using GET /order/{orderId} (assuming that the user has been given access to this feature).

The logic for flat nrs has a new property used, called 'flatNrFreeTextAllowed'. This is by default true and is found on all broadband products. A value of true tells the API user that the order endpoint will accept any string as flat nr (as long as it is valid according to the quite liberal validator). If the value is false, only values in the array 'flatNrs' are allowed. If 'flatNrs' is empty, the flat nr is already pre-selected, and none can be sent. This latter case will also result in the property 'requireFlatNr' being false.