General:

When constructing URLs with parameters, it's important to adhere to certain conventions and encoding standards to ensure that the URL is correctly interpreted by web browsers and servers. Here are some key conventions to consider:

1. URL Encoding: 

   • Special characters in URLs need to be encoded to ensure they are correctly processed. This process is known as URL encoding or percent encoding.

   • Spaces are encoded as %20. For example, in &Brands=Jaguar,Land%20Rover, the %20 represents a space in "Land Rover".

   • Other characters that need encoding include:

     • ! as %21

     • # as %23

     • $ as %24

     • & as %26

     • ' as %27

     • ( as %28

     • ) as %29

     • * as %2A

     • + as %2B

     • , as %2C

     • / as %2F

     • : as %3A

     • ; as %3B

     • = as %3D

     • ? as %3F

     • @ as %40

     • [ as %5B

     • ] as %5D

2. Query String Structure:

   • Parameters in a URL are added after a ? mark in a query string format.

   • Each parameter is in the format key=value.

   • Multiple parameters are separated by an & symbol.

3. Case Sensitivity:

   • URL paths are case-sensitive. However, the domain part of the URL is not. For instance, Example.com and example.com are equivalent, but example.com/Page and example.com/page might lead to different pages.

4. Use of Hyphens and Underscores:

   • Hyphens (-) and underscores (_) do not need encoding and are often used to improve readability of URLs.

Parameters for the Rent-Platform:

The Rent-Search feature allows users to find rental options. Here's how to use the parameters in the link structure:

1. Basic Link Structure: Start with /rent? followed by your parameters.

2. Coordinates (Coords): 

   • Format: Coords=latitude,longitude

   • Example: Coords=52.52000659999999,13.404954

   • Purpose: Use coordinates from a location picker to specify the geographic area for the search. The shop will then find the closest station that has relevant offers (considering also the date-parameters, brands and models selected)

3. Language Selection:

   • Format: &language=language_code

   • Supported Languages (depending on client):

     • German: de_de

     • German (Swiss): de_ch

     • English: en_uk

     • Portuguese: pt_pt

     • Spanish: es_es

     • Czech: cz_cs

     • Slovakian: sk_sk

   • Example: &language=de_de

4. Date Selection:

   • Format: &DateStart=YYYY-MM-DD&DateStop=YYYY-MM-DD

   • Example: &DateStart=2024-03-19&DateStop=2024-03-20

   • Note: Without this, the default is a 24-hour rental on two consecutive weekdays.

5. Time Selection: 

   1. Format: &TimeStart=HH:MM&TimeStop=HH:MM

   2. Example: &TimeStart=11:00&TimeStop=12:00

6. Brands:

   • Format: &Brands=brand_names

   • Example: &Brands=Jaguar,Land%20Rover

   • Purpose: Specify car brands in the search.

7. Tariff Groups/ Models:

   • Format: &TariffGroups=group_codes

   • Example: &TariffGroups=5F,5G

   • Purpose: Specify the tariff group codes, which are defined in the Backoffice.

8. Booking Step:

   • Format: &Step=number

   • Options:

     • Step 0: Shows the “Select your Station” screen with a map.

     • Step 1: Available if geo-location is given. Selects the closest station with relevant offers considering the tariff group, dates, and geo-location.

 Rent-Search Link Example:

Parameters for the  Subscription-Platform:

The Subscription-Search feature is for finding subscription offers. Here's how to use its parameters:

1. Basic Link Structure: Start with /offers? followed by your parameters.

2. Coordinates (Coords):

   • Format: Coords=latitude,longitude

   • Example: Coords=52.52000659999999,13.404954

   • Purpose: Use coordinates from a location picker to specify the geographic area for the search.

3. Language Selection:

   • Supported Languages (depending on client):

     • German: de_de

     • German (Swiss): de_ch

     • English: en_uk

     • Portuguese: pt_pt

     • Spanish: es_es

     • Czech: cz_cs

     • Slovakian: sk_sk

   • Example: &language=de_de

4. Date Start:

   • Format: &DateStart=YYYY-MM-DD

   • Example: &DateStart=2024-03-19

   • Purpose: Find offers starting after the chosen date.

5. Brands:

   • Format: &Brands=brand_names

   • Example: &Brands=Jaguar,Land%20Rover

   • Purpose: Specify car brands in the search.

6. Vehicle models:

   • Format: &Models=model_codes

   • Example: &Models=XC60,V90,EX60

   • Purpose: Specify model name, which are defined in the Backoffice.

Subscription Search Link Example: