ELSP REST API (v1)

Download OpenAPI specification:Download

Authentication

bearerAuth

All requests must be authenticated using a bearer token. The token is provided by the system administrator and is used to track API usage.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Bikes

List all bikes

Authorizations:

bearerAuth

Responses

200

An array of bikes

get /bikes

Local dev environment

http://localhost:4000/rest/v1/bikes

Example live environment

https://elsp.example.com/rest/v1/bikes

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": "YWGL5",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitude": "55.904213",
"longitude": "12.712783",
"battery": 49,
"speed": 8,
"disabled": false
}
]
}

Get single bike

Authorizations:

bearerAuth

path Parameters

required

string

ID of the bike

Responses

200

A bike object

get /bikes/{id}

Local dev environment

http://localhost:4000/rest/v1/bikes/{id}

Example live environment

https://elsp.example.com/rest/v1/bikes/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"id": "YWGL5",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitude": "55.904213",
"longitude": "12.712783",
"battery": 49,
"speed": 8,
"disabled": false
}
}

Charging stations

List all charging stations

Authorizations:

bearerAuth

Responses

200

An array of charging stations

get /charging-stations

Local dev environment

http://localhost:4000/rest/v1/charging-stations

Example live environment

https://elsp.example.com/rest/v1/charging-stations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": "cky4ih7rt0253o1zfofbs1jkm",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitudeStart": "55.904014",
"longitudeStart": "12.717577",
"latitudeEnd": "55.90314",
"longitudeEnd": "12.719198"
}
]
}

Get single charging station

Authorizations:

bearerAuth

path Parameters

required

string

ID of the charging station

Responses

200

A charging station object

get /charging-stations/{id}

Local dev environment

http://localhost:4000/rest/v1/charging-stations/{id}

Example live environment

https://elsp.example.com/rest/v1/charging-stations/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"id": "cky4ih7rt0253o1zfofbs1jkm",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitudeStart": "55.904014",
"longitudeStart": "12.717577",
"latitudeEnd": "55.90314",
"longitudeEnd": "12.719198"
}
}

Parking zones

List all parking zones

Authorizations:

bearerAuth

Responses

200

An array of parking zones

get /parking-zones

Local dev environment

http://localhost:4000/rest/v1/parking-zones

Example live environment

https://elsp.example.com/rest/v1/parking-zones

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": "cky4inhkh0737o1zf003nl4ap",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitudeStart": "55.906771",
"longitudeStart": "12.701981",
"latitudeEnd": "55.906635",
"longitudeEnd": "12.702277"
}
]
}

Get single parking zone

Authorizations:

bearerAuth

path Parameters

required

string

ID of the parking zone

Responses

200

A parking zone object

get /parking-zones/{id}

Local dev environment

http://localhost:4000/rest/v1/parking-zones/{id}

Example live environment

https://elsp.example.com/rest/v1/parking-zones/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"id": "cky4inhkh0737o1zf003nl4ap",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"latitudeStart": "55.906771",
"longitudeStart": "12.701981",
"latitudeEnd": "55.906635",
"longitudeEnd": "12.702277"
}
}

Driving zones

List all driving zones

Authorizations:

bearerAuth

Responses

200

An array of driving zones

get /driving-zones

Local dev environment

http://localhost:4000/rest/v1/driving-zones

Example live environment

https://elsp.example.com/rest/v1/driving-zones

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": "cky4irunl0006alzfw7ood24w",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"name": "Ven",
"latitudeStart": "55.923404",
"longitudeStart": "12.663078",
"latitudeEnd": "55.889129",
"longitudeEnd": "12.729762"
}
]
}

Get single driving zone

Authorizations:

bearerAuth

path Parameters

required

string

ID of the driving zone

Responses

200

A driving zone object

get /driving-zones/{id}

Local dev environment

http://localhost:4000/rest/v1/driving-zones/{id}

Example live environment

https://elsp.example.com/rest/v1/driving-zones/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"id": "cky4irunl0006alzfw7ood24w",
"createdAt": "2022-01-02T14:54:38.577Z",
"updatedAt": "2022-01-02T14:54:38.577Z",
"name": "Ven",
"latitudeStart": "55.923404",
"longitudeStart": "12.663078",
"latitudeEnd": "55.889129",
"longitudeEnd": "12.729762"
}
}