Ledig Parkering

Getting started
Security
Authorization
Endpoints
/freespaces
/freespaces/chargers
/freespaces/single/:id
/notifications
/notifications/:id

Security

The API requires HTTP basic auth. You can obtain keys by requesting access

As the user ID and password are passed over the network as clear text (it is base64 encoded, but base64 is a reversible encoding), the basic authentication scheme is not secure.
HTTPS/TLS should be used with basic authentication.

Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

Authorization

The "Basic" HTTP authentication scheme is defined in RFC 7617, which transmits credentials as user ID/password pairs, encoded using base64.

The username and the password are combined with a colon (aladdin:opensesame).
The resulting string is base64 encoded (YWxhZGRpbjpvcGVuc2VzYW1l).

/freespaces

GET

Will fetch overview data for all parkinghouses

Endpoint

/api/v3/freespaces

Response

  {
    "updated": timestamp,
    "status": string,
    "data": {
      string: {
        "Name": string,
        "NumFreeSpaces": string,
        "NumAvailableChargepoints": int,
        "NumOccupiedChargepoints": int,
        "CurrentPrice": int,
        "CurrentPriceElectric": int,
        "MaxPricePer24Hours": int,
        "StatusMessage": string
      }
    }
  }

/freespaces/chargers

GET

Fetches chargers for all parkinghouses

Endpoint

/api/v3/freespaces/chargers

Response

{
  "updated": timestamp,
  "status": string,
  "data": {
    string: {
      "Name": string,
      "NumAvailableChargepoints": int,
      "NumOccupiedChargepoints": int,
      "CurrentPriceElectric": int,
      "StatusMessage": string
    }
  }
}

/freespaces/single/:id/

GET

Fetches chargers and parkingspaces for a specific parkinghouse

Endpoint

/api/v3/freespaces/single/:id

bygarasjen, klostergarasjen, nordnes, solheimsviken

Response

{
  "updated": timestamp,
  "status": string,
  "data": {
    "Name": string
    "Location": string,
    "Floors": int,
    "MaxHeight": string,
    "NumTotalSpaces": string,
    "NumFreeSpaces": string,
    "NumAvailableChargepoints": int,
    "NumOccupiedChargepoints": int,
    "CurrentPrice": int,
    "CurrentPriceElectric": int,
    "MaxPricePer24Hours": int,
    "StatusMessage": string
  }
}

/notifications

GET

Fetches notifications for all parkinghouses

Endpoint

/api/v3/notifications

Response

{
  "updated": timestamp,
  "status": string,
  "data": {
    string: {
      "Name": string,
      "Status": int,
      "StatusMessage": string
    }
  }
}

/notifications/:id

POST

Fetch notification from a specific parkinghouse

Endpoint

/api/v3/notifications/:id

Response

{
  "updated": timestamp,
  "status": string,
  "data": {
    "Name": string,
    "Status": int,
    "StatusMessage": string
  }
}