Migration to version 1

Versioning of the API was introduced in May 2021. With the introduction of versioning, we are deprecating all non-versioned endpoints and strongly advising users to update their integrations to version 1. The unversioned endpoints will reach end-of-life on January 1st 2024. Please note that no further improvements will be done to the unversioned endpoints until end-of-life.

Changes in version 1

The following changes are done in version 1 of the API:

• HTTPS is required.

• All products endpoints are renamed to items.

• All sortments related endpoints are renamed to assortments.

• The format path parameter found in many endpoints is moved to a request parameter and made optional. The default value for format is always JSON.

• All JSON responses are UTF-8 encoded.

• All JSON responses are now camelCased. A few old responses were PascalCased.

• The GET /properties endpoint will now include ETIM information when available. In addition, the following fields have been removed from the response:

  • Multiplicity

  • BsddPredefinedValueGuid

  • EtimValueId (replaced by EtimValueCode)

• The new GET /properties/items/{nobbno} will return 404 when the result is empty. The similar unversioned endpoint would return 200 with content “null”.

• In the GET /media/metadata endpoint, the hasRelation request parameter and hasRelations response attribute are removed.

• In POST endpoints where Nobb numbers or Participant numbers are posted, we now require these to be a list of integers.

• In the /api/v1/media/images/{guid}/{imagesize} and /api/v1/media/images/items/{nobbno}/{imagesize} endpoints, we have new imageSizes. The new sizes are:

  • ORIGINAL

  • PORTRAIT (1200x1500)

  • SQUARE (600x600) - corresponds to the previous XLARGE

  • WIDE (480x200) - corresponds to the previous LARGE

  • THUMBNAIL (48x48)

Migration to JSON format

With the introduction of version 1 of the API, all endpoints will deliver JSON formatted responses. We will continue to support the old XML80 format, and no end-of-life has been set for this format yet. However, the XML80 format will not continue to be developed, and we strongly advise our customers to migrate to JSON as soon as possible.

The structure of the JSON responses is more or less the same as for XML80, with the main difference being attribute names in English instead of in Norwegian. In order to support the migration process, we have created a document that helps in the translation of field names. This is found here: https://byggtjeneste-docs.atlassian.net/wiki/download/attachments/291864641/XML80-JSON-migration.xlsx?api=v2.