# Charging station charge pass

REST API, Service version 1.0.0

> API reference: [`GET /chargingstation/chargepass/1.0/list`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-chargepass-list.md)

The service returns a list of charge pass information.

The charge pass can be used in the Charging Stations, see the [API Charging Stations](https://benomad.com/dev/doc/bemap-api/guides/services/chargingstation-search.md)
and the EV Smart Routing, see [API EV Smart Routing](https://benomad.com/dev/doc/bemap-api/guides/services/evsmartrouting-v2-0.md).

## Request
The request must be sent with the HTTP method `GET`.

Sample:
URI: `/bgis/service/chargingstation/chargepass/1.0/list`

Exemple: `/bgis/service/chargingstation/chargepass/1.0/list?providerName=ecoMovement`

### __Parameters__

- `providerName`: Define the provider name of charge pass will used the return the charge pass list.
- `geoServer`: Optional, define the Geo-server to use. A Geo-server is a reference to the server configuration. It can be selected in left menu of documentation page. Also is provided by the account configuration. 

## Response

### Details of fields

- `chargePasses` (ChargingTariffChargePassFront[]): List of charge pass.
  - `hashId` (string, required): Unique identifier of charge pass.
  - `title` (string, required): Name of charge pass.
  - `networkName` (string): Unique name of charge network.
  - `description` (string): A brief description or summary of the station charge pass.
  - `currency` (string): Currency used for the subscription fee. This field stores the currency code or symbol used for the subscription fee.
  - `subscriptionType` (string): Type of subscription associated with the entity. This may denote the specific subscription model or tier for accessing the station service.
  - `subscriptionFeeExclVat` (number (float)): Subscription fee excluding VAT. This field stores the fee amount charged for a subscription before any value-added tax is applied.
  - `networkUrl` (string): URL link to the website of charge network.
  - `androidAppUrl` (string): URL link to the Android application of charge network.
  - `iosAppUrl` (string): URL link to the iOS application of charge network.

### Response samples

JSON Sample:
```
{
  "chargePasses": [
    {
      "hashId": "32cb6f255139b61f36708abf8c3cc4c9",
      "networkName": "RCN",
      "title": "Ad hoc",
      "currency": "EUR",
      "subscriptionType": "n/a",
      "subscriptionFeeExclVat": 0
    },
    {
      "hashId": "7637702e95b24bef906350a0f0cf513f",
      "networkName": "Autel",
      "title": "OCPI Tariff Adhoc price",
      "currency": "EUR",
      "subscriptionType": "n/a",
      "subscriptionFeeExclVat": 0
    },

. . .
    
    {
      "hashId": "b774604ea286ff2dd535bdddeb744b4d",
      "networkName": "Ulys",
      "title": "Abonne",
      "currency": "EUR",
      "subscriptionType": "n/a",
      "subscriptionFeeExclVat": 0
    }
  ]
}
```