Schemas

Download schema

ApiError

type

string · required

status

integer · int32 · required

title

string · required

detail

string · required

instance

string · required

timestamp

string · date-time · required

exception

string · required

error

string · required

message

string · required

path

string · required

ContactInformation

email

string | null

phone

string | null

Coordinates

longitude

number · float · required

latitude

number · float · required

altitude

number | null · float

Place

Coordinates · required

name

string | null

SupportRequest

supportType

string · enum · required

Enum values:

BROKEN_DOWN

NOT_AT_LOCATION

MISSING_AFTER_PAUSE

NOT_CLEAN

NOT_AVAILABLE

UNABLE_TO_OPEN

UNABLE_TO_CLOSE

API_TECHNICAL

ContactInformation · required

bookingId

string | null · uuid

assetId

string | null

comment

string | null

stationId

string | null

SupportStatus

status

string | null

timeToResolution

integer | null · int32

Notification

originOperator

string · required

message

string | null

OneStopBookingEvent

event

string · enum · required

Enum values:

PREPARE

START

PAUSE

RESUME

START_FINISHING

FINISH

CANCEL

fileName

string | null

fileType

string | null

fileData

string | null · byte

Asset

Operator · required

id

string | null

systemId

string | null

stationId

string | null

formFactor

string | null · enum

Enum values:

BICYCLE

CARGO_BICYCLE

CAR

MOPED

SCOOTER

SCOOTER_STANDING

SCOOTER_SEATED

OTHER

licensePlate

string | null

stateOfCharge

integer | null · int32

currentRangeKm

integer | null · int32

vehicleMaxRangeInMeters

integer | null · int32

vehicleCode

string | null

vehicleTypeId

string | null

propulsionType

string | null · enum

Enum values:

HUMAN

ELECTRIC_ASSIST

ELECTRIC

COMBUSTION

COMBUSTION_DIESEL

HYBRID

PLUG_IN_HYBRID

HYDROGEN_FUEL_CELL

stationSlotName

string | null

BookingResponse

bookingId

string · uuid · required

state

string · enum · required

Enum values:

NOT_STARTED

IN_USE

PAUSED

FINISHING

FINISHED

CANCELLED

PREPARING

orderId

string · required

PricingPlanDto · required

PricingDto · required

Asset · required

departureTime

string | null · date-time

arrivalTime

string | null · date-time

comment

string | null

Operator

id

string · required

name

string · required

PriceAdjustmentDto

amount

number · double · required

description

string · required

PricingDto

currentAmount

number · double · required

originalAmount

number · double · required

PriceAdjustmentDto[] · required

paymentStatus

string · enum · required

Enum values:

UNPAID

PAID

PAYMENT_FAILED

finalAmount

number | null · double

surcharge

string | null

PricingPlanDto

currency

string · required

price

number · double · required

array | null

PricingSegmentDto

start

integer · int32 · required

interval

integer · int32 · required

rate

number · double · required

end

integer | null · int32

OneStopBooking

customerNumber

integer · int64 · required

recurringPaymentId

integer · int64 · required

Coordinates · required

PriceAdjustmentDto[] · required

assetId

string | null

stationId

string | null

vehicleTypeId

string | null

autoStart

boolean | null

pricingPlan

string | null

OperatorAvailabilityResponse

operatorIds

string[] · required

Did you find what you were looking for?

ApiError

type

string · required

status

integer · int32 · required

title

string · required

detail

string · required

instance

string · required

timestamp

string · date-time · required

exception

string · required

error

string · required

message

string · required

path

string · required

SupportRequest

supportType

string · enum · required

Enum values:

BROKEN_DOWN

NOT_AT_LOCATION

MISSING_AFTER_PAUSE

NOT_CLEAN

NOT_AVAILABLE

UNABLE_TO_OPEN

UNABLE_TO_CLOSE

API_TECHNICAL

ContactInformation · required

bookingId

string | null · uuid

assetId

string | null

comment

string | null

stationId

string | null

Asset

Operator · required

id

string | null

systemId

string | null

stationId

string | null

formFactor

string | null · enum

Enum values:

BICYCLE

CARGO_BICYCLE

CAR

MOPED

SCOOTER

SCOOTER_STANDING

SCOOTER_SEATED

OTHER

licensePlate

string | null

stateOfCharge

integer | null · int32

currentRangeKm

integer | null · int32

vehicleMaxRangeInMeters

integer | null · int32

vehicleCode

string | null

vehicleTypeId

string | null

propulsionType

string | null · enum

Enum values:

HUMAN

ELECTRIC_ASSIST

ELECTRIC

COMBUSTION

COMBUSTION_DIESEL

HYBRID

PLUG_IN_HYBRID

HYDROGEN_FUEL_CELL

stationSlotName

string | null

BookingResponse

bookingId

string · uuid · required

state

string · enum · required

Enum values:

NOT_STARTED

IN_USE

PAUSED

FINISHING

FINISHED

CANCELLED

PREPARING

orderId

string · required

PricingPlanDto · required

PricingDto · required

Asset · required

departureTime

string | null · date-time

arrivalTime

string | null · date-time

comment

string | null

OneStopBooking

customerNumber

integer · int64 · required

recurringPaymentId

integer · int64 · required

Coordinates · required

PriceAdjustmentDto[] · required

assetId

string | null

stationId

string | null

vehicleTypeId

string | null

autoStart

boolean | null

pricingPlan

string | null

Schemas

ApiError

ContactInformation

Coordinates

Place

SupportRequest

SupportStatus

Notification

OneStopBookingEvent

Asset

BookingResponse

Operator

PriceAdjustmentDto

PricingDto

PricingPlanDto

PricingSegmentDto

OneStopBooking

OperatorAvailabilityResponse

Build with Entur

Contribute

Terms & Policies

Schemas

ApiError

ContactInformation

Coordinates

Place

SupportRequest

SupportStatus

Notification

OneStopBookingEvent

Asset

BookingResponse

Operator

PriceAdjustmentDto

PricingDto

PricingPlanDto

PricingSegmentDto

OneStopBooking

OperatorAvailabilityResponse