Badge Usage Documentation
==========================

To display the environmental badge on your website, link to the badge view with the appropriate query parameters in the URL.

URL Format
-----------

The basic URL format to access the badge is:

milieudatabase.nl/nl/badge/`<id>`

Where `<id>` is the registration number associated with the environmental declaration.

Query Parameters
----------------

You can add the following query parameters to customize the appearance and data shown on the badge:

.. list-table:: Query Parameters
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Explanation
   * - `filled`
     - boolean
     - false
     - Display a filled badge with the green NMD color.
   * - `show_registration`
     - boolean
     - false
     - Display the registration number on the badge.
   * - `show_category`
     - boolean
     - false
     - Display the category of the construction product.
   * - `show_mki_a1`
     - boolean
     - false
     - Display the MKI A1 value (environmental cost for strategy A1).
   * - `show_mki_a2`
     - boolean
     - false
     - Display the MKI A2 value (environmental cost for strategy A2).
   * - `show_lifespan`
     - boolean
     - false
     - Display the lifespan of the construction product.
   * - `show_unit`
     - boolean
     - false
     - Display the unit of the construction product.
   * - `year_of_construction`
     - integer
     - 0
     - Option to add a (expected) year of construction (`bouwjaar`). See details below
   * - `show_year_of_construction`
     - boolean
     - false
     - Display the supplied year of construction value.
   * - `show_unforeseen_reuse_mki_net_a1`
     - boolean
     - false
     - Display the unforeseen reuse MKI a1 netto.
   * - `show_unforeseen_reuse_mki_net_a2`
     - boolean
     - false
     - Display the unforeseen reuse MKI a2 netto.
   * - `show_unforeseen_reuse_mki_a1`
     - boolean
     - false
     - Display the unforeseen reuse MKI a1.
   * - `show_unforeseen_reuse_mki_a2`
     - boolean
     - false
     - Display the unforeseen reuse MKI a2.
   * - `show_co2_a1`
     - boolean
     - false
     - Display the CO2 A1 value.
   * - `show_co2_a2`
     - boolean
     - false
     - Display the CO2 A2 value.

Behavior for Unforeseen Reuse
-------------

The following rules determine whether unforeseen reuse values are displayed:

- Unforeseen reuse is not shown if there is no unforeseen reuse factor in the declaration or it is set to 0.
- Unforeseen reuse is not shown for declarations with an expected year of construction (bouwjaar) in 2010 or later.
- Unforeseen reuse is shown only for declarations with an unforeseen reuse factor and an expected year of construction before 2010.
- Unforeseen reuse is not visible if the expected year of construction (bouwjaar) is not defined in the url query parameters.

Example Usage
-------------

To render a badge with the registration number `nmd_96375` and display the registration number, category, and MKI A1 value, use the following URL:

https://milieudatabase.nl/nl/badge/nmd_96375?show_registration=true&show_category=true&show_mki_a1=true

This will render the badge with the specified information visible.