Download OpenAPI specification:Download
Return application store url of the requested app label
app_label required | string The name of the application white label calling the route. |
{- "code": 0,
- "data": [
- {
- "android_store_url": "string",
- "ios_store_url": "string"
}
]
}
Begin the linking process of a new badge.
Info of the new badge to link.
cluster_id required | integer >= 1 Identifier of the cluster on which the user will put his badge to link it to his account. |
name required | string <= 30 The display name for this badge. |
spot_id | integer >= 1 Identifier of the spot on which the user will put his badge to link it to his account. Only for station v6. |
{- "cluster_id": 1,
- "name": "string",
- "spot_id": 1
}
{- "code": 0
}
Update the name of a badge.
Info of the badge.
badge_id required | integer >= 1 The identifier of the badge to edit. |
name required | string <= 30 The new display name of the badge. |
{- "badge_id": 1,
- "name": "string"
}
{- "code": 0
}
Get the list of usable or currently used bank guarantees.
{- "code": 0,
- "data": [
- {
- "id": "string",
- "amount": "350.000",
- "currency": "string",
- "date": "2019-08-24T14:15:22Z",
- "being_used": true,
- "exp_date": "2019-08-24T14:15:22Z",
- "refund_date": "2019-08-24T14:15:22Z"
}
]
}
Create a new bank guarantee for the user.
Info about the bank guarantee to create.
vehicle_id required | integer >= 1 The identifier of the vehicle we want to create a bank guarantee for. |
payment_method_id | integer >= 1 The identifier of the payment method to use for the bank guarantee. |
user_payment_method_id | integer >= 1 The identifier of the user's payment method instance to use for the bank guarantee. |
keep_after_trip | boolean When true, the guarantee will be kept for three days, otherwise its released after the trip ends. |
object (UsePaymentMethodParameters) Info that need to be provided when using a payment method. |
{- "vehicle_id": 1,
- "payment_method_id": 1,
- "user_payment_method_id": 1,
- "keep_after_trip": true,
- "payment_method_parameters": {
- "name": "string",
- "return_url": "string",
- "use_stripe_sdk": "true",
- "networks": "cartes_bancaires",
- "bank": "abn_amro"
}
}
{- "code": 0
}
Return all available payment methods usable by the user to make a bank guarantee for the given vehicle.
vehicle_id required | integer >= 1 Identifier of the vehicle to make a bank guarantee for. |
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
]
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Cancel a bank guarantee before its automatic cancellation. This is for users which are in bank that withdraw the amount of the pre-authorization instead of just blocking it.
id required | string [ 1 .. 128 ] characters The identifier of the bank guarantee to cancel. |
{- "code": 0
}
{- "code": 0,
- "data": [
- {
- "booking_id": "string",
- "serial_number": "string",
- "creation_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "planned_end_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "currency": "EUR",
- "booking_expired_fee": 0,
- "booking_max_duration": 0
}
]
}
Book a vehicle.
Info about the booking.
serial_number required | string The serial number of the vehicle to book. |
context required | string Enum: "auto" "personal" "professional" The context in which the trip will be made. |
{- "serial_number": "string",
- "context": "auto"
}
{- "code": 0,
- "data": {
- "booking_id": "string"
}
}
Return expired bookings the user.
items | integer [ 1 .. 100 ] Default: 10 The number of item to return. |
offset | integer >= 0 Default: 0 The number of item to skip. |
{- "code": 0,
- "data": [
- {
- "booking_id": "string",
- "serial_number": "string",
- "creation_date": "2019-08-24T14:15:22Z",
- "start_date": "2019-08-24T14:15:22Z",
- "planned_end_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "currency": "EUR",
- "expired_cost": 0,
- "billing_detail": [
- {
- "paid_by_organization": true,
- "type": "booking-price",
- "details": {
- "organization_paid_ratio": 1,
- "amount": 0
}
}
]
}
]
}
Return the list of reports, or chat channels, that the user made.
{- "code": 0,
- "data": [
- {
- "report_id": 1,
- "message": "string",
- "sender": "string",
- "date": "2019-08-24T14:15:22Z",
- "report_date": "2019-08-24T14:15:22Z",
- "resolved": true,
- "unread": true,
- "allow_reopen": true
}
]
}
Return a chat channel.
report_id required | integer >= 1 The identifier of the report to get. |
{- "code": 0,
- "data": {
- "report_id": 1,
- "message": "string",
- "sender": "string",
- "date": "2019-08-24T14:15:22Z",
- "report_date": "2019-08-24T14:15:22Z",
- "resolved": true,
- "unread": true,
- "allow_reopen": true
}
}
Upload an image into a new chat message.
report_id required | integer >= 1 The identifier of the report we want to add the image to. |
The picture to upload.
chat_image required | string <binary> The picture file data. |
{- "code": 0,
- "data": {
- "id": "string",
- "date": "string",
- "url": "string"
}
}
Return clusters accessible by the user on a given area.
lat required | number [ -90 .. 90 ] The latitude of the center of the area in which to get clusters. |
lng required | number [ -180 .. 180 ] The longitude of the center of the area in which to get clusters. |
latDeg required | number [ -90 .. 90 ] The number of latitude degree of the area in which to get clusters. Can be compared to the height of the area. |
lngDeg required | number [ -180 .. 180 ] The number of longitude degree of the area in which to get clusters. Can be compared to the width of the area. |
lang | string^[a-z]{2}$ The language (ISO 639-1) to use for the description localization. Defaults to english. |
{- "code": 0,
- "data": [
- {
- "cluster_id": 1,
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "name": "Knot Headquarters",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "soon_to_be_available": true,
- "commissioning_date": "2019-08-24T14:15:22Z",
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "description": "string",
- "cluster_is_accessible": true,
- "has_badge_reader": true,
- "balancing_type": "donor"
}
]
}
Create a new cluster.
Info on the cluster to create.
lat required | number [ -90 .. 90 ] Latitude part of the location. |
lng required | number [ -180 .. 180 ] Longitude part of the location. |
name required | string [ 1 .. 50 ] characters Display name of this cluster. |
network_id required | integer >= 1 Identifier of the network in which this cluster is into. |
{- "lat": 48.5900027,
- "lng": 7.7531998,
- "name": "Knot Headquarters",
- "network_id": 1
}
{- "code": 0
}
Return the 20 closest clusters accessible by logged in users on a given area.
lat required | number [ -90 .. 90 ] The latitude of the center of the area in which to get clusters. |
lng required | number [ -180 .. 180 ] The longitude of the center of the area in which to get clusters. |
{- "code": 0,
- "data": [
- {
- "cluster_id": 1,
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "name": "Knot Headquarters",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "cluster_is_accessible": true,
- "distance": 0,
- "has_badge_reader": true
}
]
}
Return clusters accessible by anyone on a given area.
lat required | number [ -90 .. 90 ] The latitude of the center of the area in which to get clusters. |
lng required | number [ -180 .. 180 ] The longitude of the center of the area in which to get clusters. |
latDeg required | number [ -90 .. 90 ] The number of latitude degree of the area in which to get clusters. Can be compared to the height of the area. |
lngDeg required | number [ -180 .. 180 ] The number of longitude degree of the area in which to get clusters. Can be compared to the width of the area. |
lang | string^[a-z]{2}$ The language (ISO 639-1) to use for the description localization. Defaults to english. |
network_id | integer >= 1 A network identifier of which to get public clusters. |
app_label required | string The name of the application white label calling the route. |
{- "code": 0,
- "data": [
- {
- "cluster_id": 1,
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "name": "Knot Headquarters",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "soon_to_be_available": true,
- "commissioning_date": "2019-08-24T14:15:22Z",
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "description": "string"
}
]
}
Return the details of a cluster.
id required | integer >= 1 The cluster id. |
lang | string^[a-z]{2}$ The language (ISO 639-1) to use for the description localization. Defaults to english. |
{- "code": 0,
- "data": {
- "cluster_id": 1,
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "name": "Knot Headquarters",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "soon_to_be_available": true,
- "commissioning_date": "2019-08-24T14:15:22Z",
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "description": "string",
- "cluster_is_accessible": true,
- "has_badge_reader": true,
- "balancing_type": "donor"
}
}
Update the cluster name.
id required | integer >= 1 The identifier of the cluster we want to update. |
Info on the cluster to update.
name | string [ 1 .. 50 ] characters The new name for the cluster. |
{- "name": "string"
}
{- "code": 0
}
Return list of spot of the given cluster.
id required | integer >= 1 The identifier of the cluster. |
{- "code": 0,
- "data": [
- {
- "spot_id": 1,
- "station_id": 1,
- "displayed_number": 1,
- "in_maintenance": true,
- "is_accessible": true
}
]
}
Return list of vehicle of the given cluster.
id required | integer >= 1 The identifier of the cluster. |
{- "code": 0,
- "data": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "battery_level": 100,
- "avg_max_range": 0,
- "vehicle_type": "kick-scooter",
- "vehicle_online": true,
- "spot_id": 1,
- "station_id": 1,
- "displayed_number": 1,
- "in_maintenance": true,
- "is_accessible": true,
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "allow_booking": true,
- "booked": true,
- "booking_id": "string",
- "network_id": 1,
- "network_name": "string"
}
]
}
Move a cluster to a new location.
id required | integer >= 1 The identifier of the cluster we want to update. |
Info on the cluster to move.
lat required | number [ -90 .. 90 ] Latitude part of the location. |
lng required | number [ -180 .. 180 ] Longitude part of the location. |
{- "lat": 48.5900027,
- "lng": 7.7531998
}
{- "code": 0,
- "data": {
- "parkings": [
- 1
]
}
}
Update the max unlock distance for a specific cluster.
id required | integer >= 1 The identifier of the cluster we want to update. |
Info on the cluster to change unlock distance.
new_distance required | integer or null [ 10 .. 1000 ] New max unlock distance. |
{- "new_distance": 10
}
{- "code": 0
}
Update the user's consents.
New consents values.
required | object |
{- "consents": {
- "emails.networkstatus": true,
- "emails.promotional": true
}
}
{- "code": 0
}
Return all consents types.
lang required | string^[a-z]{2}$ The language (ISO 639-1) to use translating the consents name. |
{- "code": 0,
- "data": [
- {
- "type": "emails.networkstatus",
- "name": "string",
- "value": true
}
]
}
Update the user's consents from unsubscribe token.
New consents values.
required | object |
token required | string or null Unsubscribe token from newsletter email. |
{- "consents": {
- "emails.networkstatus": true,
- "emails.promotional": true
}, - "token": "string"
}
{- "code": 0
}
Return a country from the given position.
lat required | number [ -90 .. 90 ] Latitude of where to search the country. |
lng required | number [ -180 .. 180 ] Longitude of where to search the country. |
{- "code": 0,
- "data": {
- "country_id": 1,
- "name": "string",
- "iso_2": "st",
- "iso_3": "str",
- "phone_prefix": "string"
}
}
{- "code": 0,
- "data": [
- {
- "discount_id": 1,
- "name": "string",
- "discount_type": "add-credit",
- "type": 1,
- "stop_date": "2019-08-24",
- "code": "string",
- "data": 0,
- "currency": "string",
- "network_id": 1,
- "network_name": "string",
- "active": true
}
]
}
Return discounts usable by the user for the shop.
network_id required | integer >= 1 A network identifier of which to get available discounts. |
{- "code": 0,
- "data": [
- {
- "discount_id": 1,
- "name": "string",
- "discount_type": "add-credit",
- "type": 1,
- "stop_date": "2019-08-24",
- "code": "string",
- "data": 0,
- "currency": "string",
- "network_id": 1,
- "network_name": "string"
}
]
}
Use a discount code.
The code of the discount and the position of the user.
network_id required | integer >= 1 The network ID where the user want to use the discount. |
code required | string non-empty Discount code to identify which discount we try to use. |
{- "network_id": 1,
- "code": "string"
}
{- "code": 0,
- "data": {
- "discount_id": 1,
- "name": "string",
- "discount_type": "add-credit",
- "type": 1,
- "stop_date": "2019-08-24",
- "code": "string",
- "data": 0,
- "currency": "string",
- "network_id": 1,
- "network_name": "string"
}
}
Send an email containing a confirmation link to change the user's email address to a new one.
New email.
email required | string <email> The new email address to send a confirmation email to. |
{- "email": "user@example.com"
}
{- "code": 0
}
Check email change token and retrieve email change data.
token required | string The token given in the email change link. |
{- "code": 0,
- "data": {
- "email": "user@example.com",
- "new_email": "user@example.com",
- "current_organization_name": "string",
- "new_organization_name": "string",
- "label_name": "string"
}
}
Change the user's email by the new specified one.
Info to authenticate the email change.
email_token required | string = 10 characters The mail change token. |
email required | string <email> The new email address. |
{- "email_token": "stringstri",
- "email": "user@example.com"
}
{- "code": 0
}
Send again an email containing a confirmation link to confirm the user's email address. The token used for authentication is given by the login route with the code 7 (email not confirmed).
{- "code": 0
}
Confirm the email of the user using the validation token.
Info to authenticate the email conformation.
token required | string = 10 characters The mail change token. |
{- "token": "stringstri"
}
{- "code": 0,
- "android_store_url": "string",
- "ios_store_url": "string",
- "label_name": "string",
- "email": "user@example.com"
}
Get the content of the faq.
lang required | string = 2 characters The lang in which to get the faq localized. |
app_label | string The name of the application white label calling the route. |
{- "code": 0,
- "data": [
- {
- "key": "string",
- "name": "string",
- "translated": true,
- "sort_order": 0,
- "sub_categories": [
- {
- "key": "string",
- "name": "string",
- "translated": true,
- "sort_order": 0,
- "is_spacer": true,
- "replacements": [
- "app-label"
], - "contents": [
- {
- "key": "string",
- "content": "string",
- "translated": true,
- "sort_order": 0,
- "type": "text",
- "bold": true,
- "margin": "string",
- "text_color": "primary",
- "bullet_color": "primary",
- "replacements": [
- "app-label"
]
}
]
}
]
}
]
}
Get the ongoing global announcement in the language requested if available.
lang required | string = 2 characters The lang in which to get the announcement. |
app_label required | string The name of the application white label calling the route. |
{- "code": 0,
- "data": {
- "announcement": "string"
}
}
Log in a user with it's Knot account.
Credentials of the user.
email required | string <email> Email of the user. |
password required | string [ 8 .. 255 ] characters Password of the user. |
scope | string Enum: "app" "dashboard" For what the token will be used. |
object (LoginDevice) Device being used to connect. | |
app_label required | string [ 1 .. 20 ] characters Name of the app label making the request. |
{- "email": "user@example.com",
- "password": "stringst",
- "scope": "app",
- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}, - "app_label": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Check the validity of a token and return the user's permissions.
Information on the device used to login.
object (LoginDevice) Device being used to connect. |
{- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}
}
{- "code": 0,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Request a new access token with the refresh token. You need to use the refresh token instead of the access token in the Authorization header. The given token will be invalidated and you will get a new one.
{- "code": 0,
- "access_token": "string",
- "refresh_token": null
}
Login with an Apple account.
Info to authenticate with an Apple account.
token required | string Apple's idToken. |
scope | string Enum: "app" "dashboard" For what the token will be used. |
object (LoginDevice) Device being used to connect. | |
app_label required | string [ 1 .. 20 ] characters Name of the app label making the request. |
lang | string/^[a-zA-Z]{2}$/ The user's language. Defaults to English. |
{- "token": "string",
- "scope": "app",
- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}, - "app_label": "string",
- "lang": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Login with a Facebook account.
Info to authenticate with a Facebook account.
token required | string Facebook's access token. |
scope | string Enum: "app" "dashboard" For what the token will be used. |
object (LoginDevice) Device being used to connect. | |
app_label required | string [ 1 .. 20 ] characters Name of the app label making the request. |
lang | string/^[a-zA-Z]{2}$/ The user's language. Defaults to English. |
{- "token": "string",
- "scope": "app",
- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}, - "app_label": "string",
- "lang": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Login with a google account.
Info to authenticate with a Google account.
token required | string Google's idToken. |
scope | string Enum: "app" "dashboard" For what the token will be used. |
object (LoginDevice) Device being used to connect. | |
app_label required | string [ 1 .. 20 ] characters Name of the app label making the request. |
lang | string/^[a-zA-Z]{2}$/ The user's language. Defaults to English. |
{- "token": "string",
- "scope": "app",
- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}, - "app_label": "string",
- "lang": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Send an email to reset a user's password.
Info on the user who want to reset its password.
email required | string <email> Account's email which we want to reset the password. |
app_label required | string [ 1 .. 20 ] characters Name of the app label making the request. |
{- "email": "user@example.com",
- "app_label": "string"
}
{- "code": 0
}
Second factor check for users with 2FA, route to call if a login route returns the code 146 (TwoFactorRequired). The authentication token is the one given by the login route that returned the code 146.
Info to complete the authentication's second factor.
mfa_token required | string/^\d{6}$/ A token given by an OTP app for the generated key. |
object (LoginDevice) Device being used to connect. |
{- "mfa_token": "string",
- "device": {
- "id": "string",
- "os": "Android",
- "model": "string",
- "app_version": "string"
}
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1,
- "permissions": [
- {
- "perm_key": "string",
- "write": true,
- "ou": {
- "id": 1,
- "networks": [
- 1
], - "clusters": [
- {
- "id": 1,
- "network": 1
}
], - "app_labels": [
- 1
], - "organizations": [
- 1
]
}
}
]
}
Begin enabling two factors authentication by generating a key and a url for an otp application. User should save the key in its app then call the login/2fa/verify route.
{- "code": 0,
- "key": "KVKGQ32EK5BEKNTUNRTESTDSOU",
- "key_url": "otpauth://totp/Knot%3AArlo_Stehr50%40yahoo.com?secret=KVKGQ32EK5BEKNTUNRTESTDSOU",
- "token": "string"
}
End the two factors authentication setup by verifying one code generated by an OTP app and the token given in the login/2fa/generate route.
Info from the OTP application and given by the begin route.
token required | string Token given in the login/2fa/generate route. |
mfa_token required | string/^\d{6}$/ A token given by an OTP app for the generated key. |
{- "token": "string",
- "mfa_token": "string"
}
{- "code": 0
}
Logout from a device or all device if is are specified.
The device to logout.
device_id | string [ 1 .. 50 ] characters Unique identifier of the device disconnecting. If omitted all user's devices are disconnected and sessions are invalidated. |
{- "device_id": "string"
}
{- "code": 0
}
Returns all available maintenance types.
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "type_key": "string",
- "target_type": "station",
- "severity": "info",
- "type_name": "string",
- "deletion_date": "string",
- "creation_date": "string"
}
]
}
Returns all the ongoing maintenances of a spot.
spot_id required | integer >= 1 The identifier of the spot we want to get the maintenances of. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
]
}
Create a new maintenance for a spot.
Info on the maintenance to add.
maintenance_type required | string [ 1 .. 50 ] characters The type of maintenance to add. |
comment | string [ 1 .. 1024 ] characters An optional comment for the maintenance. |
severity | string Enum: "info" "low" "high" The severity of this maintenance. If not provided we default on the severity of the maintenance type. |
report_id | integer An optional identifier of the report linked. |
spot_id required | integer >= 0 The identifier of the spot on which to add the maintenance. |
{- "maintenance_type": "string",
- "comment": "string",
- "severity": "info",
- "report_id": 0,
- "spot_id": 0
}
{- "code": 0,
- "data": {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
}
Returns all the resolved maintenances of a spot.
spot_id required | integer >= 1 The identifier of the spot we want to get the maintenances of. |
last_maintenance_id | integer >= 1 The identifier of the last maintenance we have, to get the maintenances coming after it. |
direction | string Enum: "ASC" "DESC" The direction in which to sort the maintenances. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0,
- "stop_date": "string",
- "stopped_by": "string",
- "stopped_by_uid": 1
}
]
}
Returns all the ongoing maintenances of a vehicle.
vehicle_id | integer >= 1 The identifier of the vehicle we want to get the maintenances of. You need to specify at least one of the parameters. |
serial_number | string [ 6 .. 10 ] characters The serial number of the vehicle we want to get the maintenances of. You need to specify at least one of the parameters. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
]
}
Create a new maintenance for a vehicle.
Info on the maintenance to add.
maintenance_type required | string [ 1 .. 50 ] characters The type of maintenance to add. |
comment | string [ 1 .. 1024 ] characters An optional comment for the maintenance. |
severity | string Enum: "info" "low" "high" The severity of this maintenance. If not provided we default on the severity of the maintenance type. |
report_id | integer An optional identifier of the report linked. |
vehicle_id | integer >= 1 The identifier of the vehicle on which to add the maintenance. You need to specify at least one of the parameters. |
serial_number | string [ 6 .. 10 ] characters The serial number of the vehicle on which to add the maintenance. You need to specify at least one of the parameters. |
{- "maintenance_type": "string",
- "comment": "string",
- "severity": "info",
- "report_id": 0,
- "vehicle_id": 1,
- "serial_number": "string"
}
{- "code": 0,
- "data": {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
}
Returns all the resolved maintenances of a vehicle.
vehicle_id | integer >= 1 The identifier of the vehicle we want to get the maintenances of. You need to specify at least one of the parameters. |
serial_number | string [ 6 .. 10 ] characters The serial number of the vehicle we want to get the maintenances of. You need to specify at least one of the parameters. |
last_maintenance_id | integer >= 1 The identifier of the last maintenance we have, to get the maintenances coming after it. |
direction | string Enum: "ASC" "DESC" The direction in which to sort the maintenances. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0,
- "stop_date": "string",
- "stopped_by": "string",
- "stopped_by_uid": 1
}
]
}
Returns all the ongoing maintenances of a station. This only returns the maintenances concerning the station as a whole and not its spots or vehicles.
station_id required | integer >= 1 The identifier of the station we want to get the maintenances of. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
]
}
Create a new maintenance for a station.
Info on the maintenance to add.
maintenance_type required | string [ 1 .. 50 ] characters The type of maintenance to add. |
comment | string [ 1 .. 1024 ] characters An optional comment for the maintenance. |
severity | string Enum: "info" "low" "high" The severity of this maintenance. If not provided we default on the severity of the maintenance type. |
report_id | integer An optional identifier of the report linked. |
station_id required | integer >= 0 The identifier of the station on which to add the maintenance. |
{- "maintenance_type": "string",
- "comment": "string",
- "severity": "info",
- "report_id": 0,
- "station_id": 0
}
{- "code": 0,
- "data": {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0
}
}
Returns all the resolved maintenances of a station. This only returns the maintenances concerning the station as a whole and not its spots or vehicles.
station_id required | integer >= 1 The identifier of the station we want to get the maintenances of. |
last_maintenance_id | integer >= 1 The identifier of the last maintenance we have, to get the maintenances coming after it. |
direction | string Enum: "ASC" "DESC" The direction in which to sort the maintenances. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "maintenance_id": 1,
- "spot_id": 1,
- "vehicle_id": 1,
- "station_id": 1,
- "maintenance_type": "string",
- "comment": "string",
- "start_date": "string",
- "started_by": "string",
- "started_by_uid": 1,
- "severity": "info",
- "automatic_code_description": "string",
- "report_id": 0,
- "stop_date": "string",
- "stopped_by": "string",
- "stopped_by_uid": 1
}
]
}
Returns the list of spot of the cluster with the a count of all maintenances on them.
cluster_id required | integer >= 1 The identifier of the cluster we want to get the overview of. |
{- "code": 0,
- "data": {
- "stations": [
- {
- "station_id": 1,
- "mainboard_id": 1,
- "station_maintenances": {
- "info_count": 0,
- "low_count": 0,
- "high_count": 0
}, - "spots": [
- {
- "spot_id": 1,
- "contained_vehicle_id": 1,
- "serial_number": "string",
- "station_id": 1,
- "displayed_number": 0,
- "lock_status": 0,
- "vehicle_maintenances": {
- "info_count": 0,
- "low_count": 0,
- "high_count": 0
}, - "spot_maintenances": {
- "info_count": 0,
- "low_count": 0,
- "high_count": 0
}, - "vehicle_type": "string"
}
]
}
], - "vehicles": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "vehicle_maintenances": {
- "info_count": 0,
- "low_count": 0,
- "high_count": 0
}, - "vehicle_type": "kick-scooter"
}
]
}
}
Returns the list of clusters given with the maintenance count for each cluster.
clusters required | Array of integers[ items >= 1 ] Examples:
Identifier of clusters of which to get the maintenance count. |
{- "code": 0,
- "data": [
- {
- "cluster_id": 1,
- "maintenances": {
- "info_count": 0,
- "low_count": 0,
- "high_count": 0
}
}
]
}
Update of the comment and severity of a maintenance.
id required | integer >= 1 The identifier of the maintenance we want to update. |
Info on the maintenance to update.
comment | string [ 1 .. 1024 ] characters The new comment for the maintenance. |
severity | string Enum: "info" "low" "high" The new severity for the maintenance. |
{- "comment": "string",
- "severity": "info"
}
{- "code": 0
}
Mark a maintenance as resolved or delete it.
id required | integer >= 1 The identifier of the maintenance we want to mark as resolved. |
delete_from_history | boolean When true, delete the maintenance from the history, otherwise it is marked as solved. |
{- "code": 0
}
Upload a picture and link it to a maintenance.
id required | integer >= 1 The identifier of the maintenance we want to attach an image to. |
The picture to upload.
maintenance_picture required | string <binary> The picture file data. |
{- "code": 0,
- "data": {
- "url": "string"
}
}
Return clusters, free floating vehicles, user's rents and passes and virtual parking.
lat required | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get map elements. |
lng required | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get map elements. |
latdeg required | number >= 0 Number of latitude degree of the area of which we want to get map elements. |
lngdeg required | number >= 0 Number of longitude degree of the area of which we want to get map elements. |
lang | string = 2 characters Language in which to get the localization, defaults to 'en'. |
{- "code": 0,
- "clusters": [
- {
- "cluster_id": 1,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "soon_to_be_available": true,
- "commissioning_date": "2019-08-24T14:15:22Z",
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "description": "string",
- "cluster_is_accessible": true,
- "has_badge_reader": true
}
], - "vehicles": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "latitude": -90,
- "longitude": -180,
- "connected": true,
- "network_id": 1,
- "battery_level": 100,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "state": "rented",
- "is_accessible": true,
- "is_available": true,
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "has_freefloat_to_station_reward": true,
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "allow_booking": true,
- "booked": true,
- "booking_id": "string"
}
], - "parkings": [
- {
- "virtual_parking_id": 1,
- "cluster_id": 1,
- "network_id": 1,
- "shape": [
- [
- -180
]
], - "is_accessible": true
}
], - "rents": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "free_floating": true,
- "being_rented": true,
- "displayed_number": 1,
- "lock_status": 0,
- "trip_id": 1,
- "time_start": "2019-08-24T14:15:22Z",
- "billing_time_stop": "2019-08-24T14:15:22Z",
- "on_hold_since": "2019-08-24T14:15:22Z",
- "on_hold_activated": true,
- "network_id": 1,
- "battery_level": 100,
- "min_battery_to_slow_down": 100,
- "min_battery_to_auto_lock": 100,
- "trip_max_pause": 0,
- "trip_auto_lock": 0,
- "trip_vehicle_stolen": 0,
- "avg_max_range": 0,
- "external_locks": [
- {
- "external_lock_id": 1,
- "model": "string",
- "type": "u",
- "code": "string"
}
], - "vehicle_model_id": 1,
- "vehicle_model_name": "string",
- "vehicle_manufacturer": "string",
- "vehicle_type": "string",
- "should_return_to_station": {
- "cluster_id": 1,
- "name": "string"
}
}
], - "passes": [
- {
- "pass_id": 1,
- "end_date": "2019-08-24T14:15:22Z",
- "in_use": true,
- "network_id": 1
}
], - "networks": [
- {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1
}
], - "speed_zones": [
- {
- "speed_zone_id": 1,
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "max_speed": 0
}
]
}
Return clusters, free floating vehicles and virtual parking publicly visible.
lat required | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get map. elements. |
lng required | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get map. elements. |
latDeg required | number >= 0 Number of latitude degree of the area of which we want to get map. elements. |
lngDeg required | number >= 0 Number of longitude degree of the area of which we want to get map. elements. |
network_id | integer >= 1 Network id to filter clusters. |
lang | string = 2 characters Language in which to get the localization, defaults to 'en'. |
app_label required | string The name of the application white label calling the route. |
{- "code": 0,
- "clusters": [
- {
- "cluster_id": 1,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "available_vehicles": 0,
- "total_spots": 0,
- "free_spots": 0,
- "cluster_is_down": true,
- "network_id": 1,
- "soon_to_be_available": true,
- "commissioning_date": "2019-08-24T14:15:22Z",
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "description": "string"
}
], - "vehicle": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "latitude": -90,
- "longitude": -180,
- "connected": true,
- "network_id": 1,
- "battery_level": 100,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string"
}
], - "parkings": [
- {
- "virtual_parking_id": 1,
- "cluster_id": 1,
- "network_id": 1,
- "shape": [
- [
- -180
]
]
}
], - "networks": [
- {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1
}
], - "speed_zones": [
- {
- "speed_zone_id": 1,
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "max_speed": 0
}
]
}
Return a list of networks. If lat, lng, latdeg and lngdeg are given this returns the networks in the defined area otherwise this returns all networks.
lat | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get networks. |
lng | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get networks. |
latdeg | number >= 0 Number of latitude degree of the area of which we want to get networks. |
lngdeg | number >= 0 Number of longitude degree of the area of which we want to get networks. |
{- "code": 0,
- "data": [
- {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1
}
]
}
Return a list of public networks. If lat, lng, latdeg and lngdeg are given this returns the public networks in the defined area otherwise this returns all public networks.
lat | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get public networks. |
lng | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get public networks. |
latdeg | number >= 0 Number of latitude degree of the area of which we want to get public networks. |
lngdeg | number >= 0 Number of longitude degree of the area of which we want to get public networks. |
app_label required | string The name of the application white label calling the route. |
{- "code": 0,
- "data": [
- {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1
}
]
}
Return all networks ordered by distance.
lat required | number [ -90 .. 90 ] Latitude of user's position. |
lng required | number [ -180 .. 180 ] Longitude of user's position. |
lang required | string = 2 characters The lang in which to get the types localized. |
{- "code": 0,
- "data": [
- {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1,
- "min_guarantee": 0,
- "max_guarantee": 0,
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "distance": 0
}
]
}
Return some details about the network.
id required | integer >= 1 The network's identifier. |
{- "code": 0,
- "data": {
- "network_id": 1,
- "name": "string",
- "shape": [
- [
- 10,
- 45
], - [
- -2.8,
- 4
], - [
- 67,
- -45.8
]
], - "center_latitude": -90,
- "center_longitude": -180,
- "currency": "string",
- "max_simultaneous_rented_vehicle": 1,
- "min_guarantee": 0,
- "max_guarantee": 0,
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "allow_trip_on_hold": true,
- "should_return_to_same_station": true,
- "booking_expired_fee": 0,
- "trip_too_long": 3600,
- "trip_auto_pause": 604800,
- "trip_max_pause": 604800,
- "trip_auto_lock": 604800,
- "booking_max_duration": 604800
}
}
Return pricing (price by minute of rent, price to unlock and to free float lock) of the specified network.
id required | integer >= 1 The network's identifier. |
{- "code": 0,
- "data": [
- {
- "network_id": 1,
- "start_dow": 0,
- "start_hod": "00:00:00",
- "end_dow": 6,
- "end_hod": "24:00:00",
- "unlock_price": 0.5,
- "unlock_included_time": 180,
- "freefloat_lock_price": 0.75,
- "use_per_minute_price": 0.15,
- "on_hold_price": 0.05,
- "returned_to_other_station_fee": 0.05,
- "currency": "string",
- "vehicle_model_id": 1,
- "vehicle_model_name": "string",
- "vehicle_manufacturer": "string",
- "vehicle_model_type": "string"
}
]
}
Return all available offers for the nearest network.
network_id required | integer >= 1 A network identifier of which to get available Offer. |
{- "code": 0,
- "data": [
- {
- "offer_id": 1,
- "title": "string",
- "price": 0,
- "vat_percentage": 1,
- "price_w_vat": 0,
- "given": 0,
- "currency": "string"
}
]
}
Return all available payment methods usable by the user to purchase the given offer.
id required | integer >= 1 Identifier of the offer to purchase. |
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
]
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Purchase an offer with the given payment method.
id required | integer >= 1 Identifier of the offer to purchase. |
Info about what to use to purchase the offer.
payment_method_id required | integer >= 1 Identifier of the payment method to use. |
user_payment_method_id | integer >= 1 Identifier of the instance of a payment method of the user. Depending on the payment method used this can be required. |
discount_id | integer >= 1 Identifier of the discount to use to purchase this offer. |
object (UsePaymentMethodParameters) Info that need to be provided when using a payment method. |
{- "payment_method_id": 1,
- "user_payment_method_id": 1,
- "discount_id": 1,
- "payment_method_parameters": {
- "name": "string",
- "return_url": "string",
- "use_stripe_sdk": "true",
- "networks": "cartes_bancaires",
- "bank": "abn_amro"
}
}
{- "code": 0
}
{- "code": 0,
- "data": {
- "paid_outside_rules_ratio": 1,
- "allow_outside_rules": true,
- "description": "string"
}
}
Return usage rules of user's organization.
{- "code": 0,
- "data": [
- {
- "start_dow": 6,
- "start_hod": "string",
- "end_dow": 6,
- "end_hod": "string",
- "paid_by_org_ratio": 1,
- "max_simultaneous_rented_vehicle": 0,
- "network_name": "string",
- "network_id": 1
}
]
}
Get whether or not the user's organization pay for everything for the given network.
network_id required | integer >= 1 Identifier of the network we want to check. |
{- "code": 0,
- "data": {
- "organization_pay_everything_for_network": true
}
}
Return organization information linked to enrolment token.
token required | string <uuid> The enrolment token. |
lang required | string^[a-z]{2}$ The language (ISO 639-1) to use for the terms of use. |
{- "code": 0,
- "data": {
- "name": "string",
- "description": "string",
- "pay_everything": true,
- "enrolment_manual_approbation": true,
- "enrolment_custom_field": "string",
}
}
Request to enrol the specified organization
Organization enrolment params.
token required | string <uuid> The enrolment token. |
custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
{- "token": "b5507016-7da2-4777-a161-1e8042a6a377",
- "custom_field_value": "string"
}
{- "code": 0
}
{- "code": 0,
- "data": [
- {
- "duration": 7200,
- "validity": "day",
- "network_id": 1,
- "network_name": "string",
- "available_time": 7200,
- "user_pass_id": 1,
- "activation_date": "2019-08-24T14:15:22Z"
}
]
}
Return all available Passes to be bought for the nearest or the specified network.
network_id required | integer >= 1 A network identifier of which to get available Pass. If omitted, user position is required to find the nearest network. |
{- "code": 0,
- "data": [
- {
- "duration": 7200,
- "validity": "day",
- "network_id": 1,
- "network_name": "string",
- "pass_id": 1,
- "price": 10.4,
- "currency": "string"
}
]
}
Return all available payment methods usable by the user to purchase the given pass.
id required | integer >= 1 Identifier of the pass to purchase. |
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
]
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Deactivate the specified user Pass. This can only be done if the Pass was activated less than 2 minutes ago and if the Pass was not used at all.
id required | integer >= 1 Identifier of the user pass to deactivate. |
{- "code": 0
}
Buy the specified Pass, paying with the chosen payment method.
id required | integer >= 1 Identifier of the pass to purchase. |
Info about what to use to purchase the pass.
payment_method_id required | integer >= 1 Identifier of the payment method to use. |
user_payment_method_id | integer >= 1 Identifier of the instance of a payment method of the user. Depending on the payment method used this can be required. |
discount_id | integer >= 1 Identifier of the discount to use to purchase this pass. |
object (UsePaymentMethodParameters) Info that need to be provided when using a payment method. |
{- "payment_method_id": 1,
- "user_payment_method_id": 1,
- "discount_id": 1,
- "payment_method_parameters": {
- "name": "string",
- "return_url": "string",
- "use_stripe_sdk": "true",
- "networks": "cartes_bancaires",
- "bank": "abn_amro"
}
}
{- "code": 78,
- "data": {
- "transaction_intent_id": 1,
- "action_data": {
- "client_secret": "string"
}
}
}
Get the list of payment methods of the user.
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
], - "allow_pre_authorizations": true,
- "allow_direct_payments": true,
- "allow_automatic_payments": true,
- "allow_subscriptions": true
}
]
}
Get the list of payment method that the user can configure.
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string"
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Configure an instance of the payment method for the user.
method_id required | integer >= 1 The identifier of payment method to configure. |
Info about the bank guarantee to create.
required | object or object |
{- "data": {
- "card_number": "string",
- "expire_date": "string"
}
}
{- "code": 0,
- "data": {
- "payment_method_setup_intent_id": 1,
- "data": {
- "intent_id": "string",
- "client_secret": "string",
- "public_key": "string"
}
}
}
Get the current state of a payment method setup intent.
intent_id required | integer >= 1 The identifier of payment method setup intent. |
{- "code": 0,
- "data": { }
}
Continue the processing of a payment method setup intent after the user has done some actions on his side.
intent_id required | integer >= 1 The identifier of payment method setup intent. |
Info to continue the processing of a payment method setup intent.
data required | object Data used to process the payment method setup intent (none for now). |
{- "data": { }
}
{- "code": 196
}
Update a payment method. For co-branded cards this allows to select a preferred network, other payment methods are not supported.
user_method_id required | integer >= 1 The identifier of user payment method to update. |
Things to update on the payment method.
preferred_network | string Enum: "cartes_bancaires" "mastercard" "visa" When updating a card, this set the preferred network to use for future or automatic purchases. |
{- "preferred_network": "cartes_bancaires"
}
{- "code": 0
}
Delete an instance of a payment method of the user. If the default payment method is deleted, a new default one is automatically selected.
user_method_id required | integer >= 1 The identifier of user payment method to delete. |
{- "code": 0
}
Set a payment method as the default one for the user.
user_method_id required | integer >= 1 The identifier of user payment method to set as the default one. |
{- "code": 0
}
Request to send a code to a phone number by SMS.
Info for where to send the SMS.
phone_number required | string [ 1 .. 20 ] characters ^\+\d{1,4} ?\d{3,14}$ The phone number in E.164 format to which we want to send the validation code. |
lang required | string = 2 characters ^[a-zA-Z]{2}$ The language to use in the SMS, default to english if not available. |
{- "phone_number": "string",
- "lang": "st"
}
{- "code": 0
}
Verify that the user received the code previously generated and mark the phone number as verified.
The code received by SMS.
sms_code required | string = 6 characters ^\d{6}$ The code received by SMS. |
{- "sms_code": "string"
}
{- "code": 0
}
Return the price for a rent of the specified time on the specified network.
network_id required | integer >= 1 The identifier of the network in which the rent will be done. |
start_date required | string <date-time> When the rent will start. |
end_date required | string <date-time> When the rent will end. |
vehicle_model_id required | integer >= 1 The vehicle model that will be used for the trip. |
{- "code": 0,
- "data": {
- "price": 0,
- "freefloat_lock": 0,
- "currency": "string"
}
}
Create a new report of type app, called by the app when it receive an error code from the backend, used to store it.
Application report data.
code required | integer The error code returned by the backend. |
app_page required | string [ 1 .. 128 ] characters Identifier of the application's page that received the error. |
app_version required | string [ 1 .. 32 ] characters Version of the application that received the error. |
device_os required | string [ 1 .. 32 ] characters Operating system of the device that run the app. |
device | string [ 1 .. 128 ] characters Name of the device that run the app. |
app_label | string [ 1 .. 20 ] characters The white label of the app. |
{- "code": 0,
- "app_page": "string",
- "app_version": "string",
- "device_os": "string",
- "device": "string",
- "app_label": "string"
}
{- "code": 0
}
Create a new report of type app, called by the app when it receive an error code from the backend, used to store it. Do not require authentication.
Anonymous application report data.
code required | integer The error code returned by the backend. |
app_page required | string [ 1 .. 128 ] characters Identifier of the application's page that received the error. |
app_version required | string [ 1 .. 32 ] characters Version of the application that received the error. |
device_os required | string [ 1 .. 32 ] characters Operating system of the device that run the app. |
device | string [ 1 .. 128 ] characters Name of the device that run the app. |
app_label | string [ 1 .. 20 ] characters The white label of the app. |
{- "code": 0,
- "app_page": "string",
- "app_version": "string",
- "device_os": "string",
- "device": "string",
- "app_label": "string"
}
{- "code": 0
}
Create a new damaged vehicle report with a picture.
The picture to upload & some info for the report.
report_photo required | string <binary> The picture file data. |
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
vehicle_lat required | number [ -90 .. 90 ] Latitude of the vehicle given by the user. |
vehicle_lng required | number [ -180 .. 180 ] Longitude of the vehicle given by the user. |
comment required | string A text explaining what is happening. |
serial_number | string^[a-zA-Z0-9]{6,10}$ The serial number of the vehicle. |
{- "code": 0
}
Create a new damaged vehicle report without a picture.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
vehicle_lat required | number [ -90 .. 90 ] Latitude of the vehicle given by the user. |
vehicle_lng required | number [ -180 .. 180 ] Longitude of the vehicle given by the user. |
comment required | string A text explaining what is happening. |
serial_number | string^[a-zA-Z0-9]{6,10}$ The serial number of the vehicle. |
{- "user_lat": -90,
- "user_lng": -180,
- "vehicle_lat": -90,
- "vehicle_lng": -180,
- "comment": "string",
- "serial_number": "string"
}
{- "code": 0
}
Create a new damaged station report with a picture.
The picture to upload & some info for the report.
report_photo required | string <binary> The picture file data. |
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment required | string A text explaining what is happening. |
spots | Array of integers[ items >= 1 ] A list of spot damaged. |
cluster_id required | integer >= 1 The identifier of the damaged cluster. |
{- "code": 0
}
Create a new damaged station report without a picture.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment required | string A text explaining what is happening. |
spots | Array of integers[ items >= 1 ] A list of spot damaged. |
cluster_id required | integer >= 1 The identifier of the damaged cluster. |
{- "user_lat": -90,
- "user_lng": -180,
- "comment": "string",
- "spots": [
- 1
], - "cluster_id": 1
}
{- "code": 0
}
Create a new station full report.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
cluster_id required | integer >= 1 The identifier of the damaged cluster. |
serial_number | string^[a-zA-Z0-9]{6,10}$ The serial number of the vehicle the user is trying to park. |
{- "user_lat": -90,
- "user_lng": -180,
- "cluster_id": 1,
- "serial_number": "string"
}
{- "code": 0,
- "data": {
- "can_park_outside": true
}
}
Create a new text report with a picture.
The picture to upload & some info for the report.
report_photo required | string <binary> The picture file data. |
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment required | string A text explaining what is happening. |
{- "code": 0
}
Create a new text report without a picture.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment required | string A text explaining what is happening. |
{- "user_lat": -90,
- "user_lng": -180,
- "comment": "string"
}
{- "code": 0
}
Create a new report about a payment issue.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment required | string A text explaining what is happening. |
{- "user_lat": -90,
- "user_lng": -180,
- "comment": "string"
}
{- "code": 0
}
Trip not ending designate the case when the user returned the vehicle but the end of the trip was not detected. Calling this route without a comment will try to auto remediate the problem, if it's possible it will automatically create the report. In case of failure to auto remediate, you need to call this route with a comment to just create the report.
Some info for the report.
user_lat required | number [ -90 .. 90 ] Latitude of the user making the report. |
user_lng required | number [ -180 .. 180 ] Longitude of the user making the report. |
comment | string A text explaining what is happening. When not given, the route will try to automatically solve the problem. |
cluster_id required | integer >= 1 The identifier of the cluster in which the vehicle was put. |
serial_number required | string^[a-zA-Z0-9]{6,10}$ The serial number of the vehicle the user locked but its trip did not end. |
spot_id required | integer >= 1 The identifier of the spot in which the vehicle was put. |
{- "user_lat": -90,
- "user_lng": -180,
- "comment": "string",
- "cluster_id": 1,
- "serial_number": "string",
- "spot_id": 1
}
{- "code": 0,
- "data": {
- "auto_remediation": true,
- "billing_time_stop": "2019-08-24T14:15:22Z"
}
}
Mark the specified report as resolved, or reopen it.
report_id required | integer >= 1 Identifier of the report. |
Solve report parameter.
close | boolean Indicate if report should be close. Set to false to reopen report. |
{- "close": true
}
{- "code": 0
}
Edit the displayed number of a spot.
New displayed number for this spot.
spot_id required | integer >= 1 The spot's identifier. |
displayed_number required | integer >= 1 The displayed number of the spot. |
{- "spot_id": 1,
- "displayed_number": 1
}
{- "code": 0
}
Return all information about a spot.
id required | integer >= 1 The spot's identifier. |
{- "code": 0,
- "data": {
- "spot_id": 1,
- "contained_vehicle_id": 1,
- "station_id": 1,
- "displayed_number": 1,
- "in_maintenance": true,
- "lock_status": 0,
- "vehicle_accessible": true,
- "battery_level": 0,
- "avg_max_range": 0,
- "serial_number": "string"
}
}
Unlock the specified spot if the user is close enough.
Spot unlock parameters.
lat required | number [ -90 .. 90 ] Latitude of the user to check that it is not too far away to unlock. |
lng required | number [ -180 .. 180 ] Longitude of the user to check that it is not too far away to unlock. |
cluster_id required | integer >= 1 The identifier of the cluster on which the spot is located. |
displayed_number required | integer >= 1 The number displayed on the spot. |
{- "lat": -90,
- "lng": -180,
- "cluster_id": 1,
- "displayed_number": 1
}
{- "code": 0,
- "data": {
- "external_locks": [
- {
- "external_lock_id": 1,
- "model": "string",
- "type": "u",
- "code": "string"
}
]
}
}
Unlock the specified spot in admin mode.
Spot unlock parameters.
lat required | number [ -90 .. 90 ] Latitude of the user to check that it is not too far away to unlock. |
lng required | number [ -180 .. 180 ] Longitude of the user to check that it is not too far away to unlock. |
spot_id required | integer >= 1 The identifier of the spot to be unlocked. |
force | boolean True when the unlocking is confirmed despite the distance. |
{- "lat": -90,
- "lng": -180,
- "spot_id": 1,
- "force": true
}
{- "code": 0
}
Create a new station with belonging spots on the given cluster.
Station create parameters.
station_id required | integer >= 1 The SVaaS station identifier. |
cluster_id required | integer >= 1 The cluster's identifier. |
{- "station_id": 1,
- "cluster_id": 1
}
{- "code": 0
}
Changes the mainboard id of the specified station.
id required | integer >= 1 The identifier of the station. |
Station mainboard id parameters.
mainboard_id required | integer >= 1 The new mainboard id. |
{- "mainboard_id": 1
}
{- "code": 0
}
Changes the speaker's volume of the specified station.
Station volume parameters.
station_id required | integer >= 1 The station's identifier. |
volume required | integer [ 1 .. 100 ] The new volume in percentage. |
{- "station_id": 1,
- "volume": 1
}
{- "code": 0
}
Changes the alarm threshold of the specified station.
Station alarm threshold parameters.
station_id required | integer >= 1 The station's identifier. |
threshold required | integer [ 1 .. 100 ] The new alarm threshold in percentage. |
{- "station_id": 1,
- "threshold": 1
}
{- "code": 0
}
Return all station's of the specified cluster with some information.
id required | integer >= 1 The identifier of the cluster of which we want to get it's stations. |
{- "code": 0,
- "data": [
- {
- "station_id": 1,
- "min_displayed_number": 1,
- "max_displayed_number": 1,
- "speaker_volume": 100,
- "alarm_threshold": 100
}
]
}
Return all addresses where vehicles can be stored.
{- "code": 0,
- "data": [
- {
- "stock_id": 1,
- "name": "string",
- "country": "string",
- "country_id": 1,
- "city": "string",
- "zipcode": "string",
- "street": "string"
}
]
}
Move a vehicle from missing vehicles to an existing stock.
The vehicle and the identifier of the stock to put in.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle to move. |
stock required | integer >= 1 The identifier of the stock in which we move the vehicle. |
comment | string [ 1 .. 2048 ] characters A comment on why we moved the vehicle to a stock. |
{- "serial_number": "SXB003",
- "stock": 1,
- "comment": "I put this vehicle in stock with an example comment"
}
{- "code": 0
}
Return all available subscriptions for the nearest or the given network.
lat | number [ -90 .. 90 ] Latitude of the user. Required if network_id is not provided. |
lng | number [ -180 .. 180 ] Longitude of the user. Required if network_id is not provided. |
network_id | integer >= 1 Network to fetch subscriptions from. Required if lat and lng are not provided. |
{- "code": 0,
- "data": [
- {
- "subscription_id": 1,
- "name": "string",
- "trip_duration": 1,
- "trip_waiting_period": 1,
- "network_id": 1,
- "vat_percentage": 0,
- "currency": "string",
- "prices": [
- {
- "subscription_price_id": 1,
- "price": 0,
- "interval_type": "day",
- "interval_count": 1,
- "free_credits": 0
}
], - "organization_discount_percent": 1,
- "organization_discount_duration": "once",
- "organization_discount_duration_in_months": 0
}
]
}
{- "code": 0,
- "data": [
- {
- "user_subscription_id": 1,
- "start_date": "string",
- "next_renew_date": "string",
- "cancellation_date": "string",
- "end_date": "string",
- "state": "active",
- "price": 0,
- "interval_type": "day",
- "interval_count": 1,
- "subscription_name": "string",
- "trip_duration": 1,
- "trip_waiting_period": 1,
- "network_id": 1,
- "network_name": "string",
- "currency": "string",
- "payment_method_details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "payment_method_type": "string",
- "provider": "string",
- "last_trip_state": "running",
- "last_trip_end_date": "string",
- "discount_percent": 1,
- "discount_duration": "once",
- "discount_duration_in_months": 0
}
]
}
Return all available payment methods usable by the user to update the payment method used by the user subscription.
user_subscription_id required | integer >= 1 Identifier of the user subscription to update. |
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
]
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Update the payment method used to pay for a user subscription.
user_subscription_id required | integer >= 1 The identifier of user subscription to update. |
Info to continue the processing of a payment method setup intent.
payment_method_id required | integer >= 1 Identifier of the payment method to use. |
user_payment_method_id required | integer >= 1 Identifier of the instance of a payment method of the user. |
{- "payment_method_id": 1,
- "user_payment_method_id": 1
}
{- "code": 0
}
Confirm the payment after 3DSecure was required for a subscription renew payment.
user_subscription_id required | integer >= 1 The identifier of user subscription to update. |
Info to confirm the payment with the payment method.
object (UsePaymentMethodParameters) Info that need to be provided when using a payment method. |
{- "payment_method_parameters": {
- "name": "string",
- "return_url": "string",
- "use_stripe_sdk": "true",
- "networks": "cartes_bancaires",
- "bank": "abn_amro"
}
}
{- "code": 0,
}
Return all available payment methods usable by the user to subscribe to a subscription.
id required | integer >= 1 Identifier of the subscription the user want to subscribe to. |
{- "code": 0,
- "data": [
- {
- "method_id": 1,
- "type": "string",
- "provider": "string",
- "instances": [
- {
- "id": 1,
- "details": {
- "alias": "XXXX XXXX XXXX 1234",
- "expiration_date": "stri",
- "card_provider": "mastercard",
- "networks": {
- "available": [
- "cartes_bancaires"
], - "preferred": "invalid_preference"
}
}, - "default": true
}
]
}
], - "providers_setup_info": {
- "stripe": {
- "public_key": "string"
}
}
}
Subscribe the user to a subscription.
price_id required | integer >= 1 Identifier of the subscription price id to subscribe to. |
Info about what to use to subscribe.
payment_method_id required | integer >= 1 Identifier of the payment method to use. |
user_payment_method_id required | integer or null >= 1 Identifier of the instance of a payment method of the user. Depending on the payment method used this can be required. |
object (UsePaymentMethodParameters) Info that need to be provided when using a payment method. |
{- "payment_method_id": 1,
- "user_payment_method_id": 1,
- "payment_method_parameters": {
- "name": "string",
- "return_url": "string",
- "use_stripe_sdk": "true",
- "networks": "cartes_bancaires",
- "bank": "abn_amro"
}
}
{- "code": 0
}
Get content of the specified terms of use.
lang | string = 2 characters The preferred lang of the terms of use to get. |
app_label | string <= 20 characters The name of the application white label calling the route. Default to knot. |
token | string <= 20 characters Terms of use acceptation token. Use it to show terms of use associated to an approval request. |
term_of_use_id | number >= 1 Identifier of the terms of use to get content. |
{- "code": 0,
}
Returns all transactions of the user.
last_trip_id | integer >= 1 The identifier of the last trip we have, to get the trip coming after it. |
direction | string Enum: "ASC" "DESC" The direction in which to sort the trips. |
items | integer [ 1 .. 100 ] The number of items to return, default to 100 for compatibility. |
{- "code": 0,
- "data": [
- {
- "transaction_id": 1,
- "date": "2019-08-24T14:15:22Z",
- "auto_payment": true,
- "amount": 0,
- "vat": 1,
- "amount_w_vat": 0,
- "currency": "string",
- "offer_id": 1,
- "discount": 0,
- "offer_wallet_amount": "string",
- "pass_id": 1,
- "pass_duration": 0,
- "pass_validity": "day",
- "user_subscription_id": 1,
- "refunds": [
- {
- "id": 1,
- "amount": 0,
- "date": "string"
}
], - "trip_id": 1,
- "trip_cost": 0,
- "trip_started_at": "string",
- "wallets": [
- {
- "wallet_id": 1,
- "original_amount": 0,
- "source": "EUR",
- "creation_date": "string"
}
], - "booking_id": "string",
- "booking_cost": 0,
- "booking_started_at": "string"
}
]
}
Continue the processing of a transaction intent after the user has done some actions on his side.
id required | integer >= 1 The identifier of the transaction intent. |
{- "code": 196
}
Returns all trips made by the user.
last_trip_id | integer >= 1 The identifier of the last trip we have, to get the trip coming after it. |
direction | string Enum: "ASC" "DESC" The direction in which to sort the trips. |
{- "code": 0,
- "data": [
- {
- "trip_id": 1,
- "billing_time_stop": "2019-08-24T14:15:22Z",
- "distance": 0,
- "start_date": "string",
- "has_balancing_discount": true
}
]
}
Returns a trip made by the user.
id required | integer >= 1 The identifier of the trip we want to get. |
{- "code": 0,
- "data": {
- "trip_id": 1,
- "billing_time_stop": "2019-08-24T14:15:22Z",
- "distance": 0,
- "start_date": "string",
- "coords": [
- {
- "lat": -90,
- "lng": -180,
- "date": "2019-08-24T14:15:22Z"
}
], - "on_hold_time": 0,
- "trip_cost": 0,
- "currency": "string",
- "paid_with_pass": true,
- "billing_detail": [
- {
- "type": "subscription",
- "details": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "user_subscription_id": 1
}, - "paid_by_organization": true
}
], - "incomplete_billing_lines": true,
- "booking_id": "string",
- "booked_since": "string"
}
}
{- "code": 0,
- "data": {
- "user_id": 1,
- "email": "user@example.com",
- "lastname": "string",
- "firstname": "string",
- "bank_card": true,
- "demo_mode": true,
- "trip_retention_duration": 3,
- "is_knot_account": true,
- "is_google_account": true,
- "is_facebook_account": true,
- "is_apple_account": true,
- "notifications": 15,
- "phone_number": "string",
- "profile_picture_url": "string",
- "preferred_vehicle_type": "string",
- "two_factor": true,
- "organization_id": 1,
- "organization_name": "string",
- "organization_pay_everything": true,
- "organization_pay_everything_for_any_network": true,
- "trip_count": 0,
- "saved_payment_method_is_optional": true,
- "enrolment_request_date": "2019-08-24T14:15:22Z",
- "enrolment_request_organization_name": "string"
}
}
Register a new user using an email and a password.
Info about the user to create its account.
firstname | string [ 1 .. 50 ] characters The user's firstname. |
lastname | string [ 1 .. 50 ] characters The user's lastname. |
lang required | string/^[a-zA-Z]{2}$/ The user's language. |
phonenumber | string/^\+\d{1,4} ?\d{3,14}$/ The user's phone number in E.164 format. |
phonenumber_token | string The phone number verification token. |
sponsorcode | string/^[A-Z]{8}$/ Another user's sponsor code. |
object The given consents. | |
app_label required | string The name of the application used to sign up. |
trip_retention_in_months | integer or null [ 6 .. 24 ] The duration in months that we will keep the trips of the user. Null means forever. Will default to 24 months if not specified. |
enrolment_token | string <uuid> Optional organization enrolment token. |
enrolment_custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
email required | string <email> The user's email address. |
password required | string [ 8 .. 255 ] characters The user's password. |
{- "firstname": "string",
- "lastname": "string",
- "lang": "string",
- "phonenumber": "string",
- "phonenumber_token": "string",
- "sponsorcode": "string",
- "consents": {
- "property1": true,
- "property2": true
}, - "app_label": "string",
- "trip_retention_in_months": 6,
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634",
- "enrolment_custom_field_value": "string",
- "email": "user@example.com",
- "password": "stringst"
}
{- "code": 0
}
Update the user's information.
User info to update.
firstname | string [ 1 .. 50 ] characters The user's firstname. |
lastname | string [ 1 .. 50 ] characters The user's lastname. |
{- "firstname": "string",
- "lastname": "string"
}
{- "code": 0
}
Update the user's preferred vehicle.
Type of the vehicle.
vehicle_type required | string or null Enum: "kick-scooter" "e-scooter" "bike" "e-bike" "cargo-bike" "e-cargo-bike" The type of the vehicle. |
{- "vehicle_type": "string"
}
{- "code": 0
}
Delete a user and all its personal data.
Deletion data.
password | string [ 8 .. 255 ] characters The user's password, required when the user has one. |
{- "password": "stringst"
}
{- "code": 0,
- "data": {
- "days": 1
}
}
Cancel the deletion of a user while in the pending deletion period.
Cancel deletion data.
cancel_token required | string The token given by a route that returned that the account is pending deletion. |
{- "cancel_token": "string"
}
{- "code": 0
}
{- "code": 0,
- "data": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "free_floating": true,
- "being_rented": true,
- "displayed_number": 1,
- "lock_status": 0,
- "trip_id": 1,
- "time_start": "2019-08-24T14:15:22Z",
- "billing_time_stop": "2019-08-24T14:15:22Z",
- "on_hold_since": "2019-08-24T14:15:22Z",
- "on_hold_activated": true,
- "network_id": 1,
- "battery_level": 100,
- "min_battery_to_slow_down": 100,
- "min_battery_to_auto_lock": 100,
- "trip_max_pause": 0,
- "trip_auto_lock": 0,
- "trip_vehicle_stolen": 0,
- "avg_max_range": 0,
- "external_locks": [
- {
- "external_lock_id": 1,
- "model": "string",
- "type": "u",
- "code": "string"
}
], - "vehicle_model_id": 1,
- "vehicle_model_name": "string",
- "vehicle_manufacturer": "string",
- "vehicle_type": "string",
- "should_return_to_station": {
- "cluster_id": 1,
- "name": "string"
}
}
], - "passes": [
- {
- "pass_id": 1,
- "end_date": "2019-08-24T14:15:22Z",
- "in_use": true,
- "network_id": 1
}
]
}
Return the sum of user's wallets.
currency required | string (Currency) Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL" Example: currency=EUR The requested currency, in which the sum should be converted. |
{- "code": 0,
- "data": {
- "amount": 0
}
}
Update the user's phone number or, when required, send a verification code by SMS and return a token to validate the ownership of the number.
The new phone number.
phone_number required | string [ 1 .. 20 ] characters ^\+\d{1,4} ?\d{3,14}$ The new phone number in E.164 format of the user. |
lang required | string = 2 characters ^[a-zA-Z]{2}$ The language to use in the SMS, default to english if not available. |
{- "phone_number": "string",
- "lang": "st"
}
{- "code": 0
}
End a phone number update that needed a validation by sms.
The token given by the POST route and code received by SMS.
sms_code required | string = 6 characters ^\d{6}$ The 6 digit code received by SMS. |
token required | string The token given by the POST route. |
{- "sms_code": "string",
- "token": "string"
}
{- "code": 0
}
Change the duration for when the trips are kept linked to the requesting user.
The new trip retention duration.
months required | integer or null [ 6 .. 24 ] The number of months to keep the trip linked to the user. null means forever. |
{- "months": 6
}
{- "code": 0
}
Register a user using a Apple account to fetch user's information and allow login with the Apple identity provider.
Info about the user and the data given by Apple.
lang required | string/^[a-zA-Z]{2}$/ The user's language. |
phonenumber | string/^\+\d{1,4} ?\d{3,14}$/ The user's phone number in E.164 format. |
phonenumber_token | string The phone number verification token. |
sponsorcode | string/^[A-Z]{8}$/ Another user's sponsor code. |
object The given consents. | |
app_label required | string The name of the application used to sign up. |
trip_retention_in_months | integer or null [ 6 .. 24 ] The duration in months that we will keep the trips of the user. Null means forever. Will default to 24 months if not specified. |
enrolment_token | string <uuid> Optional organization enrolment token. |
enrolment_custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
token required | string The user's Apple id token. |
firstname required | string [ 1 .. 50 ] characters The user's firstname. |
lastname required | string [ 1 .. 50 ] characters The user's lastname. |
{- "lang": "string",
- "phonenumber": "string",
- "phonenumber_token": "string",
- "sponsorcode": "string",
- "consents": {
- "property1": true,
- "property2": true
}, - "app_label": "string",
- "trip_retention_in_months": 6,
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634",
- "enrolment_custom_field_value": "string",
- "token": "string",
- "firstname": "string",
- "lastname": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1
}
Link an account to an Apple account.
Info on the Apple account to link.
token required | string The Apple id token. |
{- "token": "string"
}
{- "code": 0
}
Register a user using a Facebook account to fetch user's information and allow login with the Facebook identity provider.
Info about the user and the data given by Facebook.
lang required | string/^[a-zA-Z]{2}$/ The user's language. |
phonenumber | string/^\+\d{1,4} ?\d{3,14}$/ The user's phone number in E.164 format. |
phonenumber_token | string The phone number verification token. |
sponsorcode | string/^[A-Z]{8}$/ Another user's sponsor code. |
object The given consents. | |
app_label required | string The name of the application used to sign up. |
trip_retention_in_months | integer or null [ 6 .. 24 ] The duration in months that we will keep the trips of the user. Null means forever. Will default to 24 months if not specified. |
enrolment_token | string <uuid> Optional organization enrolment token. |
enrolment_custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
token required | string The user's Facebook access token. |
firstname required | string [ 1 .. 50 ] characters The user's firstname. |
lastname required | string [ 1 .. 50 ] characters The user's lastname. |
{- "lang": "string",
- "phonenumber": "string",
- "phonenumber_token": "string",
- "sponsorcode": "string",
- "consents": {
- "property1": true,
- "property2": true
}, - "app_label": "string",
- "trip_retention_in_months": 6,
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634",
- "enrolment_custom_field_value": "string",
- "token": "string",
- "firstname": "string",
- "lastname": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1
}
Link an account to a Facebook account.
Info on the Facebook account to link.
token required | string The Facebook access token. |
{- "token": "string"
}
{- "code": 0
}
Register a user using a Google account to fetch user's information and allow login with the Google identity provider.
Info about the user and the data given by Google.
lang required | string/^[a-zA-Z]{2}$/ The user's language. |
phonenumber | string/^\+\d{1,4} ?\d{3,14}$/ The user's phone number in E.164 format. |
phonenumber_token | string The phone number verification token. |
sponsorcode | string/^[A-Z]{8}$/ Another user's sponsor code. |
object The given consents. | |
app_label required | string The name of the application used to sign up. |
trip_retention_in_months | integer or null [ 6 .. 24 ] The duration in months that we will keep the trips of the user. Null means forever. Will default to 24 months if not specified. |
enrolment_token | string <uuid> Optional organization enrolment token. |
enrolment_custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
token required | string The user's Google access token. |
firstname required | string [ 1 .. 50 ] characters The user's firstname. |
lastname required | string [ 1 .. 50 ] characters The user's lastname. |
{- "lang": "string",
- "phonenumber": "string",
- "phonenumber_token": "string",
- "sponsorcode": "string",
- "consents": {
- "property1": true,
- "property2": true
}, - "app_label": "string",
- "trip_retention_in_months": 6,
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634",
- "enrolment_custom_field_value": "string",
- "token": "string",
- "firstname": "string",
- "lastname": "string"
}
{- "code": 0,
- "token": "string",
- "refresh_token": "string",
- "user_id": 1
}
Link an account to a Google account.
Info on the Google account to link.
token required | string The Google access token. |
{- "token": "string"
}
{- "code": 0
}
Register a new user using an email and a password. This is used for registering using the web interface.
Info about the user to create its account.
firstname | string [ 1 .. 50 ] characters The user's firstname. |
lastname | string [ 1 .. 50 ] characters The user's lastname. |
lang required | string/^[a-zA-Z]{2}$/ The user's language. |
phonenumber | string/^\+\d{1,4} ?\d{3,14}$/ The user's phone number in E.164 format. |
phonenumber_token | string The phone number verification token. |
sponsorcode | string/^[A-Z]{8}$/ Another user's sponsor code. |
object The given consents. | |
app_label required | string The name of the application used to sign up. |
trip_retention_in_months | integer or null [ 6 .. 24 ] The duration in months that we will keep the trips of the user. Null means forever. Will default to 24 months if not specified. |
enrolment_token | string <uuid> Optional organization enrolment token. |
enrolment_custom_field_value | string <= 500 characters Optional custom field value for organization enrolment. |
email required | string <email> The user's email address. |
password required | string [ 8 .. 255 ] characters The user's password. |
gcaptcha required | string Google re-captcha code. |
{- "firstname": "string",
- "lastname": "string",
- "lang": "string",
- "phonenumber": "string",
- "phonenumber_token": "string",
- "sponsorcode": "string",
- "consents": {
- "property1": true,
- "property2": true
}, - "app_label": "string",
- "trip_retention_in_months": 6,
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634",
- "enrolment_custom_field_value": "string",
- "email": "user@example.com",
- "password": "stringst",
- "gcaptcha": "string"
}
{- "code": 0
}
Begin a registration by checking if the user's email match an organization.
Email and label of the user.
email required | string <email> The user's email address. |
app_label required | string The name of the application used to sign up. |
lang | string/^[a-zA-Z]{2}$/ The user's language. Defaults to English. |
enrolment_token | string <uuid> Optional organization enrolment token. |
{- "email": "user@example.com",
- "app_label": "string",
- "lang": "string",
- "enrolment_token": "dcfae4cf-f37b-4718-a8ef-ac19f0efd634"
}
{- "code": 0,
- "data": {
- "organization": {
- "name": "string",
- "description": "string",
- "pay_everything": true,
- "enrolment_manual_approbation": true,
- "enrolment_custom_field": "string",
}, - "sms": {
- "validation_token": "string"
}
}
}
{- "code": 0,
- "data": {
- "firstname": "string",
- "lastname": "string",
- "user_id": 1,
- "email": "user@example.com",
- "language": "st",
- "notifications": 15,
- "offers_bought": 0,
- "phone_number": "string",
- "google_id": "string",
- "facebook_id": "string",
- "apple_id": "string",
- "organization_id": 1,
- "app_label_id": 1,
- "use_time": {
- "seconds": 0,
- "minutes": 0,
- "hours": 0,
- "days": 0
}
}
}
Add a password to a Google, Facebook or Apple account.
New password.
password required | string [ 8 .. 255 ] characters The user's password. |
{- "password": "stringst"
}
{- "code": 0
}
Change the user's password.
New and old password.
password required | string [ 8 .. 255 ] characters The user's old password. |
newpassword required | string [ 8 .. 255 ] characters The user's new password. |
{- "password": "stringst",
- "newpassword": "stringst"
}
{- "code": 0
}
Reset the password to the new specified one.
The new password.
password_token required | string = 10 characters The change password token. |
password required | string [ 8 .. 255 ] characters The user's password. |
{- "password_token": "stringstri",
- "password": "stringst"
}
{- "code": 0
}
Change the account demonstration mode state.
New state of the demonstration mode.
activate required | boolean The state of the demonstration mode. |
{- "activate": true
}
{- "code": 0
}
Update the user's notifications settings.
Notification settings.
value required | number [ 0 .. 15 ] Value of the settings. Flags: 1 -> Deprecated, 2 -> Deprecated, 4 -> service status, 8 -> trip notifications. |
{- "value": 15
}
{- "code": 0
}
Update the push notification token.
New push notification token.
token required | string <= 4096 characters The push notification token. |
device_id required | string <= 50 characters Identifier of the device being used. |
{- "token": "string",
- "device_id": "string"
}
{- "code": 0
}
Upload a profile picture to the specified user.
The image to upload.
profile_picture required | string <binary> The picture to upload. |
{- "code": 0
}
Register a vehicle of SVaaS on the given network.
Vehicle create parameters.
network_id required | integer >= 1 Network's identifier for the new vehicle. |
serial_number | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle. |
model_id required | integer >= 1 Identifier of the vehicle model. |
vehicle_service_id required | integer >= 1 SVaaS vehicle identifier. |
free_floating_enabled | boolean If the vehicle is free floating compatible, true if you enable this functionality. |
{- "network_id": 1,
- "serial_number": "string",
- "model_id": 1,
- "vehicle_service_id": 1,
- "free_floating_enabled": true
}
{- "code": 0
}
Fetch some info on the vehicle.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
{- "code": 0,
- "data": {
- "vehicle_id": 1,
- "network_id": 1,
- "battery_level": 100,
- "svaas_id": 1,
- "network_name": "string",
- "connected": true,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "home_cluster_id": 1,
- "home_cluster_name": "string"
}
}
Change the current serial number of a vehicle.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle. |
New serial number.
new_serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The new serial number of the vehicle. |
{- "new_serial_number": "string"
}
{- "code": 0
}
Fetch some admin info on the vehicle. This is reserved for operators.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
{- "code": 0,
- "data": {
- "vehicle_id": 1,
- "network_id": 1,
- "battery_level": 100,
- "svaas_id": 1,
- "network_name": "string",
- "connected": true,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "external_locks": [
- {
- "external_lock_id": 0,
- "model": "string",
- "type": "u",
- "serial_number": "string",
- "code": "string",
- "register_date": "string",
- "last_code_update": "string"
}
]
}
}
Fetch some admin info on the vehicle after getting it from the vehicle itself. This is reserved for operators.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
{- "code": 0,
- "data": {
- "vehicle_id": 1,
- "network_id": 1,
- "battery_level": 100,
- "svaas_id": 1,
- "network_name": "string",
- "connected": true,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "external_locks": [
- {
- "external_lock_id": 0,
- "model": "string",
- "type": "u",
- "serial_number": "string",
- "code": "string",
- "register_date": "string",
- "last_code_update": "string"
}
]
}
}
Change the current network of a vehicle.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
Info about the network.
network_id required | integer >= 1 Identifier of the new network for the vehicle. |
{- "network_id": 1
}
{- "code": 0
}
Unlock the specified vehicle if the user is close enough.
Vehicle unlock parameters.
lat required | number [ -90 .. 90 ] Latitude of the user to check the distance to the vehicle. |
lng required | number [ -180 .. 180 ] Longitude of the user to check the distance to the vehicle. |
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle to unlock. |
{- "lat": -90,
- "lng": -180,
- "serial_number": "string"
}
{- "code": 0,
- "data": {
- "external_locks": [
- {
- "external_lock_id": 1,
- "model": "string",
- "type": "u",
- "code": "string"
}
]
}
}
Unlock the specified vehicle in admin mode.
Vehicle unlock parameters.
lat required | number [ -90 .. 90 ] Latitude of the user to check the distance to the vehicle. |
lng required | number [ -180 .. 180 ] Longitude of the user to check the distance to the vehicle. |
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle to unlock. |
force | boolean True when the distance check is bypassed. |
{- "lat": -90,
- "lng": -180,
- "serial_number": "string",
- "force": true
}
{- "code": 0
}
Send command for open the vehicle battery cover.
Vehicle open battery cover parameters.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle. |
{- "serial_number": "string"
}
{- "code": 0
}
Return all free floating vehicles in a given area.
lat required | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get free floating vehicles. |
lng required | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get free floating vehicles. |
latDeg required | number >= 0 Number of latitude degree of the area of which we want to get free floating vehicles. |
lngDeg required | number >= 0 Number of longitude degree of the area of which we want to get free floating vehicles. |
lang | string = 2 characters Language in which to get the localization, defaults to 'en'. |
{- "code": 0,
- "data": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "latitude": -90,
- "longitude": -180,
- "connected": true,
- "network_id": 1,
- "battery_level": 100,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "state": "rented",
- "is_accessible": true,
- "is_available": true,
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "has_freefloat_to_station_reward": true,
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "allow_booking": true,
- "booked": true,
- "booking_id": "string"
}
]
}
Return all free floating vehicles in the given area visible without being logged in.
lat required | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get free floating vehicles. |
lng required | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get free floating vehicles. |
latDeg required | number >= 0 Number of latitude degree of the area of which we want to get free floating vehicles. |
lngDeg required | number >= 0 Number of longitude degree of the area of which we want to get free floating vehicles. |
network_id | integer >= 1 Network id to filter free floating vehicles. |
app_label | string non-empty Name of the app label making the request. |
{- "code": 0,
- "data": [
- {
- "vehicle_id": 1,
- "serial_number": "string",
- "latitude": -90,
- "longitude": -180,
- "connected": true,
- "network_id": 1,
- "battery_level": 100,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string"
}
]
}
Return a free floating vehicle.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
lang | string = 2 characters Language in which to get the localization, defaults to 'en'. |
{- "code": 0,
- "data": {
- "vehicle_id": 1,
- "serial_number": "string",
- "latitude": -90,
- "longitude": -180,
- "connected": true,
- "network_id": 1,
- "battery_level": 100,
- "vehicle_type": "kick-scooter",
- "model_id": 1,
- "model_name": "string",
- "manufacturer": "string",
- "state": "rented",
- "is_accessible": true,
- "is_available": true,
- "exceptional_out_of_order": {
- "exceptional_out_of_order_id": 1,
- "type": "other",
- "reason": "string",
- "custom_reason": "string"
}, - "has_freefloat_to_station_reward": true,
- "home_cluster_id": 1,
- "home_cluster_name": "string",
- "allow_booking": true,
- "booked": true,
- "booking_id": "string"
}
}
Return the reward that the user can have if it returns the vehicle to a station.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The vehicle's serial number. |
{- "code": 0,
- "data": {
- "cluster_id": 0,
- "cluster_name": "string",
- "currency": "EUR",
- "distance_reward": 0,
- "free_credits": 0
}
}
Identify a free-floating vehicle by blinking it's light and emitting a sound.
Vehicle identify parameters.
lat required | number [ -90 .. 90 ] Latitude of the user to check the distance to the vehicle. |
lng required | number [ -180 .. 180 ] Longitude of the user to check the distance to the vehicle. |
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle to unlock. |
{- "lat": -90,
- "lng": -180,
- "serial_number": "string"
}
{- "code": 0
}
Identify a free-floating vehicle by blinking it's light and emitting a sound.
Vehicle identify parameters.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle. |
{- "serial_number": "string"
}
{- "code": 0
}
Lock in free floating the specified vehicle and ends the rent.
Vehicle lock parameters.
vehicle_id required | integer >= 1 The vehicle's identifier. |
force | boolean When true, if the network force lock is in manual mode and the vehicle fails to lock because it produces an error, we will try to lock the vehicle as soon as possible. |
{- "vehicle_id": 1,
- "force": true
}
{- "code": 0
}
Temporary lock a free-floating vehicle, put the trip on hold.
Vehicle lock params.
vehicle_id required | integer >= 1 The vehicle's identifier. |
force | boolean When true, if the network force lock is in manual mode and the vehicle fails to lock because it produces an error, we will try to lock the vehicle as soon as possible. |
{- "vehicle_id": 1,
- "force": true
}
{- "code": 0
}
Lock in free floating the specified vehicle in admin.
Vehicle lock parameters.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle to lock. |
force | boolean When true, if the network force lock is in manual mode and the vehicle fails to lock due to it moving, we will try to lock the vehicle as soon as possible. |
{- "serial_number": "string",
- "force": true
}
{- "code": 0
}
Shutdown the vehicle and the IoT (e.g. for transport).
Vehicle shutdown parameters.
serial_number required | string/^[a-zA-Z0-9]{6,10}$/ The serial number of the vehicle. |
{- "serial_number": "string"
}
{- "code": 0
}
Return nearest clusters and parking where the given vehicle can be parked.
lat required | number [ -90 .. 90 ] The latitude of where the user is. |
lng required | number [ -180 .. 180 ] The longitude of where the user is. |
vehicle_id required | integer >= 1 The identifier of the vehicle we want to park. |
{- "code": 0,
- "data": {
- "clusters": [
- {
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "distance": 0,
- "cluster_id": 1
}
], - "parkings": [
- {
- "latitude": 48.5900027,
- "longitude": 7.7531998,
- "distance": 0,
- "virtual_parking_id": 1
}
]
}
}
Experimental PoC: Request a vehicle to come at user position.
Vehicle request parameters.
lat required | number [ -90 .. 90 ] Latitude of the center of the area of which we want to get free floating vehicles. |
lng required | number [ -180 .. 180 ] Longitude of the center of the area of which we want to get free floating vehicles. |
{- "lat": -90,
- "lng": -180
}
{- "code": 0,
- "data": {
- "report_id": 1
}
}
Change the vehicle svaas id.
id required | integer >= 1 The identifier of the vehicle. |
New svaas id.
svaas_id required | integer >= 1 The new svaas id of the vehicle. |
{- "svaas_id": 1
}
{- "code": 0
}
Get the latest and minimal application's version.
app_label required | string [ 1 .. 20 ] characters The app label name. |
platform required | string Enum: "android" "ios" The platform name. |
{- "code": 0,
- "data": {
- "current": 0,
- "minimal": 0
}
}