5. API Instructies

Documentatie

Dit is de technische documentatie van de Transport Kompas tool.

API endpoints

GET /

Deze endpoint haalt de index pagina van de tool op.

URL parameters:

Geen parameters

GET /documentation

Deze endpoint haalt documentatie pagina van de tool op.

URL parameters:

Geen parameters

GET /local_excel

Deze endpoint voert de berekeningen van het PANTEIA model uit met lokale Excel bestanden.

URL parameters:

• fleet_data (string) [optioneel]: Dit is het pad naar het Excel bestand met de wagenpark data. Deze kan absoluut of relatief zijn. Gebruik wel alleen "/" en geen "\". Als het pad dit normaal wel bevat, dan vervang deze simpelweg met "/". Is standaard: "./input/wagenpark.xlsx".
• scenario_data (string) [optioneel]: Dit is het pad naar het Excel bestand met de wagenpark data. Deze kan absoluut of relatief zijn. Gebruik wel alleen "/" en geen "\". Als het pad dit normaal wel bevat, dan vervang deze simpelweg met "/". Is standaard: "./input/scenarios.xlsx".
• company (string) [verplicht]: Dit is de naam van het Excel werkblad waarvan de wagenpark data zal ingelezen worden.
• comparing (string) [optioneel]: Dit is een optie van het model om aan te geven wat met elkaar vergeleken moet worden. Hiervoor zijn de volgende opties:
  • strategies: Het model zal meerdere strategieën met 1 scenario vergelijken.
  • scenarios: Het model zal meerdere scenarios met 1 strategie vergelijken.Is standaard: "strategies".
• strategies (string) [optioneel]: Dit is een komma gesplitste lijst van strategieën. Als comparing gelijk is aan "strategies", dan wordt deze lijst gebruikt. Anders worden standaard alle strategieën gebruikt. Als comparing gelijk is aan "scenarios", dan wordt de eerste strategie in de lijst geselecteerd.
• scenarios (string) [optioneel]: Dit is een komma gesplitste lijst van scenarios. Als comparing gelijk is aan "scenarios", dan wordt deze lijst gebruikt. Anders worden standaard alle beschikbare scenarios gebruikt. Als comparing gelijk is aan "strategies", dan wordt de eerste scenario in de lijst geselecteerd.
• output (string) [optioneel]: Dit is een komma geplitste lijst van resultaten. Hiervoor zijn de volgende opties:
  • graphs: Het resultaat zal verschillende grafieken met TCO waardes bevatten.
  • results: Het resultaat zal de TCO waardes bevatten.
  • input: Het resultaat zal de input data van het model versturen.Is standaard: "graphs,results".
• output_format (string) [optioneel]: Dit is de optie die selecteert in welk bestandsformaat het resultaat zal verstuurd worden. Hiervoor zijn de volgende opties:
  • html: Het resultaat zal als een HTML pagina getoond worden.
  • json: Het resultaat zal als een JSON object verstuurd worden.Is standaard: "html".

POST /external_excel

Deze endpoint voert de berekeningen van het PANTEIA model uit met externe Excel bestanden.

URL parameters:

• company (string) [verplicht]: Dit is de naam van het Excel werkblad waarvan de wagenpark data zal ingelezen worden.
• comparing (string) [optioneel]: Dit is een optie van het model om aan te geven wat met elkaar vergeleken moet worden. Hiervoor zijn de volgende opties:
  • strategies: Het model zal meerdere strategieën met 1 scenario vergelijken.
  • scenarios: Het model zal meerdere scenarios met 1 strategie vergelijken.Is standaard: "strategies".
• strategies (string) [optioneel]: Dit is een komma gesplitste lijst van strategieën. Als comparing gelijk is aan "strategies", dan wordt deze lijst gebruikt. Anders worden standaard alle strategieën gebruikt. Als comparing gelijk is aan "scenarios", dan wordt de eerste strategie in de lijst geselecteerd.
• scenarios (string) [optioneel]: Dit is een komma gesplitste lijst van scenarios. Als comparing gelijk is aan "scenarios", dan wordt deze lijst gebruikt. Anders worden standaard alle beschikbare scenarios gebruikt. Als comparing gelijk is aan "strategies", dan wordt de eerste scenario in de lijst geselecteerd.
• output (string) [optioneel]: Dit is een komma geplitste lijst van resultaten. Hiervoor zijn de volgende opties:
  • graphs: Het resultaat zal verschillende grafieken met TCO waardes bevatten.
  • results: Het resultaat zal de TCO waardes bevatten.
  • input: Het resultaat zal de input data van het model versturen.Is standaard: "graphs,results".
• output_format (string) [optioneel]: Dit is de optie die selecteert in welk bestandsformaat het resultaat zal verstuurd worden. Hiervoor zijn de volgende opties:
  • html: Het resultaat zal als een HTML pagina getoond worden.
  • json: Het resultaat zal als een JSON object verstuurd worden.Is standaard: "html".

Body

De body bestaat uit JSON data:

• fleet_data (string) [verplicht]: Dit is het base 64 geencodeerde Excel bestand van de wagenpark data.
• scenario_data (string) [verplicht]: Dit is het base 64 geencodeerde Excel bestand van de scenario data.

POST /json_data

Deze endpoint voert de berekeningen van het PANTEIA model uit met JSON input data.

URL parameters:

• comparing (string) [optioneel]: Dit is een optie van het model om aan te geven wat met elkaar vergeleken moet worden. Hiervoor zijn de volgende opties:
  • strategies: Het model zal meerdere strategieën met 1 scenario vergelijken.
  • scenarios: Het model zal meerdere scenarios met 1 strategie vergelijken.Is standaard: "strategies".
• strategies (string) [optioneel]: Dit is een komma gesplitste lijst van strategieën. Als comparing gelijk is aan "strategies", dan wordt deze lijst gebruikt. Anders worden standaard alle strategieën gebruikt. Als comparing gelijk is aan "scenarios", dan wordt de eerste strategie in de lijst geselecteerd.
• scenarios (string) [optioneel]: Dit is een komma gesplitste lijst van scenarios. Als comparing gelijk is aan "scenarios", dan wordt deze lijst gebruikt. Anders worden standaard alle beschikbare scenarios gebruikt. Als comparing gelijk is aan "strategies", dan wordt de eerste scenario in de lijst geselecteerd.
• output (string) [optioneel]: Dit is een komma geplitste lijst van resultaten. Hiervoor zijn de volgende opties:
  • graphs: Het resultaat zal verschillende grafieken met TCO waardes bevatten.
  • results: Het resultaat zal de TCO waardes bevatten.
  • input: Het resultaat zal de input data van het model versturen.Is standaard: "graphs,results".
• output_format (string) [optioneel]: Dit is de optie die selecteert in welk bestandsformaat het resultaat zal verstuurd worden. Hiervoor zijn de volgende opties:
  • html: Het resultaat zal als een HTML pagina getoond worden.
  • json: Het resultaat zal als een JSON object verstuurd worden.Is standaard: "html".

Body

De body bestaat uit JSON data:

• fleet (object) [verplicht]:
  • De nummerplaat/naam van een voertuig (object):
    • number_plate (string) [verplicht]: De nummerplaat van het voertuig.
    • type (string) [verplicht]: Het type voertuig.
    • category (string) [verplicht]: De voertuigcategorie.
    • fuel_type (string) [verplicht]: Het brandstoftype.
    • euronorm (integer) [verplicht]: De Europese emissieklasse.
    • year_of_purchase (integer) [verplicht]: Het jaar van aankoop.
    • is_cooled (float) [boolean]: Of het voertuig een koelmachine bezit.
    • PTO_fuel_consumption (integer) [verplicht]: Het PTO brandstofverbruik.
    • expected_total_distance_traveled_in_km (integer) [verplicht]: De huidige kilometerstand (in km).
    • maximum_daily_distance_in_km (integer) [verplicht]: De maximum dagelijkse afstand (in km).
    • amount_of_operational_days (integer) [verplicht]: De hoeveelheid dagen per jaar dat het voertuig operationeel is.
    • drives_in_future_ZE_zone (boolean) [verplicht]: Of het voertuig in een toekomstige Zero Emissie zone rijdt.
    • flexible_planning (boolean) [verplicht]: Of het voertuig flexibel ingepland kan worden.
    • technological_lifespan (integer) [verplicht]: De technologische levensduur (in jaren)
    • expected_residual_value_after_repayment (integer) [verplicht]: De verwachte restwaarde na afschrijving.
    • electricity_type (string) [verplicht]: Het type elektriciteit waarmee het voertuig zich zou kunnen opladen.
• scenarios (object) [verplicht]:
  • Het scenario type (object):
    • Het voertuig type (object):
      • name (string) [verplicht]: De gehele naam van de scenario.
      • scenario_type (string) [verplicht]: Het scenario type.
      • vehicle_type (string) [verplicht]: Het voertuig type.
      • years (object) [verplicht]:
        • Het jaar van de data (object):
          • year (integer) [verplicht]: Het huidige jaar.
          • diesel_price_in_euro (float) [verplicht]: De inkoopprijs van diesel per liter in euro.
          • electric_price_in_euro (float) [verplicht]: De inkoopprijs van elektriciteit per kWh in euro.
          • capacity_in_kWh (int) [verplicht]: De huidige elektrische capaciteit.
          • repair_costs_EV_euro_per_year (float) [verplicht]: De jaarlijkse reparatiekosten van een elektrisch voertuig.
          • maintenance_costs_EV_euro_per_year (float) [verplicht]: De jaarlijkse onderhoudskosten van een elektrisch voertuig.
          • maintenance_costs_diesel_euro_per_year (float) [verplicht]: De jaarlijkse onderhoudskosten van een diesel voertuig.
          • standstil_EV_in_days (float) [verplicht]: De jaarlijkse hoeveelheid aan tijd voor onderhoud en reparatie in dagen voor een elektrsich voertuig.
          • subsidies_EV_in_euro (float) [verplicht]: De jaarlijkse hoeveelheid subsidies voor elektrische voertuigen.
          • CO2_price_in_euro_per_ton (float) [verplicht]: De boete voor CO2 uitstoot in euro per ton.
          • efficiency_diesel_in_liter_per_km (float) [verplicht]: De brandstofefficiëntie van diesel in liter per km.
          • efficiency_electricity_in_kWh_per_km (float) [verplicht]: De brandstofefficiëntie van elektriciteit in kWh per km.
          • electricity_price_excluding_tax_in_euro_per_kWh (float) [verplicht]: De inkoopprijs van elektriciteit zonder BTW in euro per kWh.
          • gross_purchase_cost_charging_system_in_euro (float) [verplicht]: De kosten van een elektrisch oplaadsysteem in euro (met BTW).
          • gross_installation_cost_charging_system_in_euro (float) [verplicht]: De installatiekosten van een elektrisch oplaadsysteem in euro (met BTW).
          • fuel_price_diesel_excluding_tax_in_euro_per_liter (float) [verplicht]: De inkoopprijs van diesel zonder BTW in euro per liter.
          • change_in_excise_duty_diesel_in_percentage (float) [verplicht]: De relatieve verandering van diesel accijns in percentages.
          • vehicle_tax_diesel_in_euro_per_year (float) [verplicht]: De wegenbelasting van een diesel voertuig in euro per jaar.
          • vehicle_tax_electric_in_euro_per_year (float) [verplicht]: De wegenbelasting van een elektrisch voertuig in euro per jaar.
          • economical_lifespan_diesel (integer) [verplicht]: De economische levensduur van een diesel voertuig in jaren.
          • economical_lifespan_electric (integer) [verplicht]: De economische levensduur van een elektrisch voertuig in jaren.
          • energy_subsidy_in_euro_per_kWh (float) [verplicht]: De energiesubsidie voor elektrsiche voertuigen in euro per kWh.
          • fixed_ZE_vehicle_tax_in_euro_per_year (float) [verplicht]: De jaarlijkse boete/belasting voor dieselvoertuigen die in Zero Emissie zones rijden.
          • difference_truck_toll_tax_in_euro_per_km (float) [verplicht]: De relatieve verandering van vrachtwagen tolbelasting in euro per km.
          • subsidy_charging_system_installation_in_euro_per_installation (float) [verplicht]: De subsidie voor het installeren van een elektrisch oplaadsysteem in euro.
          • residual_value_EV_year_1_in_percentage (float) [verplicht]: De restwaarde van een 1 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_2_in_percentage (float) [verplicht]: De restwaarde van een 2 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_3_in_percentage (float) [verplicht]: De restwaarde van een 3 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_4_in_percentage (float) [verplicht]: De restwaarde van een 4 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_5_in_percentage (float) [verplicht]: De restwaarde van een 5 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_6_in_percentage (float) [verplicht]: De restwaarde van een 6 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_7_in_percentage (float) [verplicht]: De restwaarde van een 7 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_8_in_percentage (float) [verplicht]: De restwaarde van een 8 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_9_in_percentage (float) [verplicht]: De restwaarde van een 9 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_10_in_percentage (float) [verplicht]: De restwaarde van een 10 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_11_in_percentage (float) [verplicht]: De restwaarde van een 11 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_12_in_percentage (float) [verplicht]: De restwaarde van een 12 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_13_in_percentage (float) [verplicht]: De restwaarde van een 13 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_14_in_percentage (float) [verplicht]: De restwaarde van een 14 jaar oude elektrische voertuig in percentages.
          • residual_value_EV_year_15_in_percentage (float) [verplicht]: De restwaarde van een 15 jaar oude elektrische voertuig in percentages.
          • residual_value_diesel_year_1_in_percentage (float) [verplicht]: De restwaarde van een 1 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_2_in_percentage (float) [verplicht]: De restwaarde van een 2 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_3_in_percentage (float) [verplicht]: De restwaarde van een 3 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_4_in_percentage (float) [verplicht]: De restwaarde van een 4 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_5_in_percentage (float) [verplicht]: De restwaarde van een 5 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_6_in_percentage (float) [verplicht]: De restwaarde van een 6 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_7_in_percentage (float) [verplicht]: De restwaarde van een 7 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_8_in_percentage (float) [verplicht]: De restwaarde van een 8 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_9_in_percentage (float) [verplicht]: De restwaarde van een 9 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_10_in_percentage (float) [verplicht]: De restwaarde van een 10 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_11_in_percentage (float) [verplicht]: De restwaarde van een 11 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_12_in_percentage (float) [verplicht]: De restwaarde van een 12 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_13_in_percentage (float) [verplicht]: De restwaarde van een 13 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_14_in_percentage (float) [verplicht]: De restwaarde van een 14 jaar oude diesel voertuig in percentages.
          • residual_value_diesel_year_15_in_percentage (float) [verplicht]: De restwaarde van een 15 jaar oude diesel voertuig in percentages.
          • charging_capacity_external_charging_pole (float) [verplicht]: De oplaadcapaciteit van een externe oplaadpaal.
          • charging_capacity_charging_pole_on_depot (float) [verplicht]: De oplaadcapaciteit van een oplaadpaal op depot.
          • needed_charging_capacity_depot (float) [verplicht]: De nodige oplaadcapaciteit om op depot op te laden.
          • needed_charging_capacity_in_transit (float) [verplicht]: De nodige oplaadcapaciteit om onderweg op te laden.
          • AC37_at_home (float) [verplicht]: De oplaadkosten van een AC37 oplaadpaal (op depot) per kWh in euro.
          • AC10_in_transit (float) [verplicht]: De oplaadkosten van een AC10 oplaadpaal (onderweg) per kWh in euro.
          • AC20_in_transit (float) [verplicht]: De oplaadkosten van een AC20 oplaadpaal (onderweg) per kWh in euro.
          • AC20_at_home (float) [verplicht]: De oplaadkosten van een AC20 oplaadpaal (op depot) per kWh in euro.
          • FC50_in_transit (float) [verplicht]: De oplaadkosten van een FC50 oplaadpaal (onderweg) per kWh in euro.
          • FC50_at_home (float) [verplicht]: De oplaadkosten van een FC50 oplaadpaal (op depot) per kWh in euro.
          • HPC150_in_transit (float) [verplicht]: De oplaadkosten van een HPC150 oplaadpaal (onderweg) per kWh in euro.
          • HPC150_at_home (float) [verplicht]: De oplaadkosten van een HPC150 oplaadpaal (op depot) per kWh in euro.
          • HPC350_in_transit (float) [verplicht]: De oplaadkosten van een HPC350 oplaadpaal (onderweg) per kWh in euro.
          • HPC350_at_home (float) [verplicht]: De oplaadkosten van een HPC350 oplaadpaal (op depot) per kWh in euro.