API Document for Confluent Cluster 1.0.0 documentation

API Document for Confluent Cluster 1.0.0

Servers

https://pkac-xxxxx.<location>.<cloud-type>.confluent.cloudkafkacluster
Confluent Kafka instance.
Security:
User/Password
security.protocol:SASL_PLAINTEXT
https://psrc-xxxxx.<location>.<cloud-type>.confluent.cloudkafkaschema-registry
Confluent Kafka Schema Registry Server
Security:
User/Password
security.protocol:SASL_PLAINTEXT

Operations

SUB Hoboken-District
Operation IDHobokenDistrictSubscribe
x-partitions
6
x-replicas
3
cleanup.policy
delete
delete.retention.ms
86400000
confluent.value.schema.validation
true
x-messageCompatibility
BACKWARD
bindingVersion
0.3.0
groupId
string
clientId
string
Accepts the following message:
HobokenDistrictMessage
application/json
object
uid: https://github.com/NABSA/gbfs/blob/v2.3/gbfs.md#station_statusjson
Describes the capacity and rental availability of the station

last_updated
required
integer
>= 1450155600
Last time the data in the feed was updated in POSIX time.

required
object
is_installed
required
boolean
Is the station currently on the street?

is_renting
required
boolean
Is the station currently renting vehicles?

is_returning
required
boolean
Is the station accepting vehicle returns?

last_reported
required
integer
>= 1450155600
The last time this station reported its status to the operator's backend in POSIX time.

num_bikes_available
required
integer
>= 0
Number of vehicles of any type physically available for rental at the station.

num_bikes_disabled
integer
>= 0
Number of disabled vehicles of any type at the station.

num_docks_available
integer
>= 0
Number of functional docks physically at the station.

num_docks_disabled
integer
>= 0
Number of empty but disabled docks at the station.

station_id
required
string
Identifier of a station.

array<object>
Object displaying available docks by vehicle type (added in v2.1-RC).

count
required
integer
>= 0
A number representing the total number of available docks for the defined vehicle type (added in v2.1-RC).

required
array<string>
An array of strings where each string represents a vehicle_type_id that is able to use a particular type of dock at the station (added in v2.1-RC).

Items:
string
array<object>
non-empty
Array of objects displaying the total number of each vehicle type at the station (added in v2.1-RC).

count
required
integer
>= 0
A number representing the total amount of this vehicle type at the station (added in v2.1-RC).

vehicle_type_id
required
string
The vehicle_type_id of vehicle at the station (added in v2.1-RC).

Additional properties are allowed.
ttl
required
integer
>= 0
Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).

version
required
string
GBFS version number to which the feed conforms, according to the versioning framework (added in v1.1).

Const:"2.3"
Additional properties are allowed.
bindingVersion
0.3.0
key
string
Examples
{ "last_updated": 1450155600, "station": { "is_installed": true, "is_renting": true, "is_returning": true, "last_reported": 1450155600, "num_bikes_available": 0, "num_bikes_disabled": 0, "num_docks_available": 0, "num_docks_disabled": 0, "station_id": "string", "vehicle_docks_available": [ { "count": 0, "vehicle_type_ids": [ "string" ] } ], "vehicle_types_available": [ { "count": 0, "vehicle_type_id": "string" } ] }, "ttl": 0, "version": "2.3" }

This example has been generated automatically.

Messages

#1HobokenDistrictMessage
- application/json
object
uid: https://github.com/NABSA/gbfs/blob/v2.3/gbfs.md#station_statusjson
Describes the capacity and rental availability of the station

last_updated
required
integer
>= 1450155600
Last time the data in the feed was updated in POSIX time.

required
object
is_installed
required
boolean
Is the station currently on the street?

is_renting
required
boolean
Is the station currently renting vehicles?

is_returning
required
boolean
Is the station accepting vehicle returns?

last_reported
required
integer
>= 1450155600
The last time this station reported its status to the operator's backend in POSIX time.

num_bikes_available
required
integer
>= 0
Number of vehicles of any type physically available for rental at the station.

num_bikes_disabled
integer
>= 0
Number of disabled vehicles of any type at the station.

num_docks_available
integer
>= 0
Number of functional docks physically at the station.

num_docks_disabled
integer
>= 0
Number of empty but disabled docks at the station.

station_id
required
string
Identifier of a station.

array<object>
Object displaying available docks by vehicle type (added in v2.1-RC).

count
required
integer
>= 0
A number representing the total number of available docks for the defined vehicle type (added in v2.1-RC).

required
array<string>
An array of strings where each string represents a vehicle_type_id that is able to use a particular type of dock at the station (added in v2.1-RC).

Items:
string
array<object>
non-empty
Array of objects displaying the total number of each vehicle type at the station (added in v2.1-RC).

count
required
integer
>= 0
A number representing the total amount of this vehicle type at the station (added in v2.1-RC).

vehicle_type_id
required
string
The vehicle_type_id of vehicle at the station (added in v2.1-RC).

Additional properties are allowed.
ttl
required
integer
>= 0
Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).

version
required
string
GBFS version number to which the feed conforms, according to the versioning framework (added in v1.1).

Const:"2.3"
Additional properties are allowed.
bindingVersion
0.3.0
key
string

API Document for Confluent Cluster 1.0.0

Servers

Security:

Security:

Operations

SUB Hoboken-District

Examples

This example has been generated automatically.

Messages