# 📘 Charging Station Filter – Glossary

This glossary defines how to use the `filters` parameter in the Charging Station API (v1.0.0). Filters allow advanced selection and prioritization of charging stations.

## 🔍 Filter Pattern Syntax

Each filter is a **string** formatted as:


```
CLASS.FIELD OPERATOR VALUE
```

Or with an **action**:


```
CLASS.FIELD OPERATOR VALUE -> ACTION_KEY=ACTION_VALUE;
```

Multiple filters can be joined with `||` (logical OR).

## 🧱 CLASS

| Class | Description |
|  --- | --- |
| `pool` | Refers to the pool (group of charging points) |
| `station` | Refers to the charging station |
| `chargingPoint` | Refers to individual charging points |
| `vehicleAccess` | Refers to access constraints (height, weight) |


## ⚙️ OPERATORS

| Operator | Meaning |
|  --- | --- |
| `==` | Equals |
| `!=` | Not equals |
| `<`, `>`, `<=`, `>=` | Numeric comparisons |
| `IN` | Match one of multiple values (separated by `;`) |
| `/= /.../` | Regex (supports `/i` for case-insensitive) |


## 🧪 ACTIONS

By default, filters are **exclusion rules**. To modify behavior, use **actions**:

| Action Key | Description |
|  --- | --- |
| `prefCoeff` | Preference coefficient if condition is matched. Values: |
|  | - `> 1` → prefer (up to 10) |
|  | - `< 1` → avoid (e.g. 0.5 means half-priority) |
|  | - `1` → neutral |


🧠 *Example:* Boost free charging stations:


```json
"station.freeCharging==true -> prefCoeff=7.0;"
```

## 🧾 Examples


```json
[
  "pool.brand /= /Izivia|IONITY.*/ || pool.brand == Tesla",
  "station.available == true",
  "chargingPoint.nominalPower >= 7",
  "chargingPoint.currency IN EUR;GBP;DKK",
  "station.freeCharging==true -> prefCoeff=7.0;"
]
```

## ✅ Supported Filter Fields

### 🏢 Pool Filters

- `available` (boolean)
- `accessibility`
- `addressComplement`
- `availabilityStatus`
- `availabilityUntil`
- `brand`
- `comment`
- `countryCode`
- `customerId`
- `dbId`
- `floorNumber`
- `id`
- `maxNominalPower`
- `name`
- `numberOfChargingPoint`
- `numberOfParkingSpace`
- `open24x7`
- `operatorId`
- `phoneNumber`
- `providerName`
- `reliabilityScore`
- `siteCategory`
- `siteType`
- `sourceProvider`
- `tags`
- `updateDate`


### 🏪 Station Filters

- `available` (boolean)
- `freeCharging` (boolean)
- `creditCardPayment` (boolean)
- `chargePass` (string)
- `rfidAuth` (boolean)
- `appAuth` (boolean)
- `authenticationInformation`
- `authenticationModes`
- `availabilityStatus`
- `bookable`
- `floorNumber`
- `id`
- `operatorId`
- `paymentInformation`
- `paymentModes`
- `tags`


### ⚡ Charging Point Filters

- `available` (boolean)
- `ampere`
- `availabilityStatus`
- `availabilityUntil`
- `busyStatus`
- `chargingSpeed`
- `currency`
- `currentType`
- `id`
- `nominalPower`
- `operatorId`
- `remoteCharging`
- `tags`
- `usabilityStatus`
- `voltage`


### 🚗 Vehicle Access Filters

- `maxHeight`
- `maxLength`
- `maxWeight`
- `maxWidth`


📌 For real-world examples and advanced use cases, refer to the dedicated "filters" tutorial.