API docs by Redocly

Dashboard API definition (1.0.0)

Download OpenAPI specification:Download

AccessLogs

Get access logs

Return dashboard access logs.

Authorizations:
(AuthenticatedPermissions)
query Parameters
page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last access log record on the current page, used to request the next page.

date_min
string <datetime>

The minimum date of access logs to show.

date_max
string <datetime>

The maximum date of access logs to show.

user_id
integer >= 1

The user id to show.

target_path
string [ 1 .. 2048 ] characters

The path that was requested by the user.

verb
string [ 1 .. 10 ] characters

The request http method.

user_agent
string [ 1 .. 2048 ] characters

The user agent used for the request.

ip
string [ 1 .. 128 ] characters

The ip address used for the request.

http_code_min
integer >= 0

The minimum value of the http response status to show.

http_code_max
integer >= 0

The maximum value of the http response status to show.

knot_code_min
integer

The minimum value of the response code to show.

knot_code_max
integer

The maximum value of the response code to show.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

AppLabel

Get app labels

Return the list of all application white labels.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create app label

Create a new app label.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

App label parameters.

name
required
string/^[a-z]{1,20}$/

The unique label name.

display_name
required
string [ 1 .. 32 ] characters

The label name that will be displayed.

required
object (AppLabelBillingParams)

Billing information for invoicing.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "string",
  • "billing_info": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get app label

Return detail of the application white label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Put app label

Update parameters of the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: application/json
required

App label parameters.

require_sms_validation
required
boolean

Indicate if new user require a phone number with sms validation.

phone_sms_provider_id
required
integer or null >= 1

Configured provider id to send SMS.

require_terms_of_use
required
boolean

Indicate if new user should accept the term of use.

auto_delete_users
required
boolean

Indicate if inactive users should be deleted.

android_store_url
required
string or null <uri> [ 1 .. 100 ] characters

Url of the Android application on Google play store.

ios_store_url
required
string or null <uri> [ 1 .. 100 ] characters

Url of the iOS application on Apple app store.

saved_payment_method_is_optional
required
boolean

Indicate if users can rent without saved payment method.

website
required
string or null <uri> <= 100 characters

Url of the website of the white label.

contact_email
required
string or null <email> <= 100 characters

Contact email of the white label, for end user.

contact_phone_number
required
string or null <= 100 characters

Contact phone number of the white label, for end user.

Responses

Request samples

Content type
application/json
{
  • "require_sms_validation": true,
  • "phone_sms_provider_id": 1,
  • "require_terms_of_use": true,
  • "auto_delete_users": true,
  • "android_store_url": "http://example.com",
  • "ios_store_url": "http://example.com",
  • "saved_payment_method_is_optional": true,
  • "website": "http://example.com",
  • "contact_email": "user@example.com",
  • "contact_phone_number": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get mail setting

Get the mail setting of the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Set mail setting

Set the mail setting of the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: application/json
required

App label mail parameters.

send_mails
required
boolean

Indicate if mail are enabled.

sender_address
required
string <email> <= 255 characters

Email used to send the mail. Needs to be validated on AWS SES, and DNS should be configured according to it.

sender_name
required
string <= 32 characters

The name of sender.

reply_to
required
string or null <email> <= 255 characters

Email in reply-to header.

notification_email
required
string <email> <= 255 characters

Reference email for notifications.

Responses

Request samples

Content type
application/json
{
  • "send_mails": true,
  • "sender_address": "user@example.com",
  • "sender_name": "string",
  • "reply_to": "user@example.com",
  • "notification_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update app label billing

Update billing information of the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: application/json
required

App label billing parameters.

name
string [ 1 .. 100 ] characters

Name of the company.

legal_form
string or null [ 1 .. 50 ] characters

Legal form of the company.

vat_number
string or null [ 1 .. 50 ] characters

International VAT number.

registration_number
string or null [ 1 .. 50 ] characters

Registration number of the company (for example, SIRET in France).

capital
string or null [ 1 .. 50 ] characters

Capital of the company.

street
required
string [ 1 .. 200 ] characters

Number and street name of the legal address of the company.

zip_code
required
string [ 1 .. 20 ] characters

Zip code of the legal address of the company.

city
required
string [ 1 .. 150 ] characters

City of the legal address of the company.

country
required
string [ 1 .. 100 ] characters

Country of the legal address of the company.

issuer
string or null [ 1 .. 100 ] characters

Issuer of the invoice (i.e brand of the app).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "legal_form": "SAS",
  • "vat_number": "string",
  • "registration_number": "string",
  • "capital": "string",
  • "street": "string",
  • "zip_code": "string",
  • "city": "string",
  • "country": "string",
  • "issuer": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get payment methods

Get the payment methods and which are enabled on the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Enable payment method

Enable a payment method on the app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

method_id
required
integer >= 1

Identifier of the payment method.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Disable payment method

Disable the payment method on the app label. Warning, all user who have saved the payment method won't be able to use it.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

method_id
required
integer >= 1

Identifier of the payment method.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Clusters

Get clusters

Return clusters of the specified networks with availability, spot count info, dates, etc.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the vehicles.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Search cluster

Search for cluster with a given name in specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
name
required
string non-empty

Search value.

networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get clusters.

badge_reader
boolean

Search only for station with a badge reader.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get cluster details

Return the details of the specified cluster.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

query Parameters
lang
required
string = 2 characters

The lang in which to get the cluster description localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete cluster

Mark the cluster has decommissioned.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Add cluster picture

Upload a picture to the specified cluster.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster of which we want to add a picture.

Request Body schema: multipart/form-data
required

The picture to upload & some info on the cluster.

cluster_picture
required
string <binary>

The picture file data.

Responses

Response samples

Content type
application/json
{}

Delete cluster picture

Delete a cluster picture.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster of which we want to delete a picture.

query Parameters
picture
required
string non-empty
Example: picture=clusterpictures/96361409-5115-e583-9c6f-2ee87903ce76.jpg

Key of the picture that we want to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get stations

Return station's details of the specified cluster with all spots and contained vehicle if present.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get station outages

Return outages history of all physical station linked to the specified cluster.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get cluster parkings

Return virtual parkings of the specified cluster with contained vehicle if present.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create cluster parking

Create a virtual parking attached to this cluster.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Request Body schema: application/json
required

Parking parameters

shape
required
Array of numbers[ items >= 3 items [ items = 2 items [ -180 .. 180 ] ] ]

Shape of virtual parking as a list of points making a polygon.

capacity
required
integer >= 0

How many vehicle can be parked.

Responses

Request samples

Content type
application/json
{
  • "shape": [
    ],
  • "capacity": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Set commissioning date

Set cluster's commissioning date.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Request Body schema: application/json
required

The commissioning date.

date
required
string <date-time>

The date at which the cluster should be commissioned.

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get maintenances

Return the history of all maintenances on spot for the specified cluster.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update cluster location

Update the location (text) of the cluster. This address is for informational purposes only, it does not move the pin of the station.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster of which we want to change location.

Request Body schema: application/json
required

The new location.

location
required
string [ 5 .. 100 ] characters

The new location of the cluster.

Responses

Request samples

Content type
application/json
{
  • "location": "6 Rue des Boeufs, 67000 Strasbourg"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update cluster settings

Update the max unlock distance, the internal comment and allow to force the cluster to be down.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster of which we want to change settings.

Request Body schema: application/json
required

New settings.

max_unlock_distance
required
integer [ 25 .. 500 ]

The maximum distance between user position and the cluster to allow vehicle unlocking.

comment
required
string [ 1 .. 500 ] characters

Internal comment, only displayed on the dashboard. Can be used to set contact information, etc.

Responses

Request samples

Content type
application/json
{
  • "max_unlock_distance": 25,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update cluster description

Update the description of the cluster. This description is visible by end users, it allow to specify information to end users.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster of which we want to change description.

Request Body schema: application/json
required

The new description.

lang
required
string = 2 characters

The language of the description.

description
required
string or null [ 1 .. 500 ] characters

The text of the description.

Responses

Request samples

Content type
application/json
{
  • "lang": "st",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get out of order details

Return the details of the specified out of order.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the cluster.

query Parameters
lang
required
string = 2 characters

The lang in which to get the cluster description localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Devices

Get users using given device

Get the users that logged in with the same device as the given one.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
string <= 50 characters

The identifier of the device to look for.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Devtools

Get app reports

Return reports made by the app when it encountered an unknown error.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Resolve app reports

Mark the specified app reports as resolved.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Reports to resolve.

reports
required
Array of integers[ items >= 1 ]

Responses

Request samples

Content type
application/json
{
  • "reports": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get app versions

Return current and minimal version for all platform of the application white label.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update app version

Update the current and minimal xamarin application version.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

New app versions.

current
required
integer >= 0

The current available application version.

minimal
required
integer >= 0

The minimal application version required to use the service.

app_label_id
required
integer >= 1

The identifier of the app label.

platform
required
string
Enum: "android" "ios" "legacy"

The platform of the new version.

Responses

Request samples

Content type
application/json
{
  • "current": 0,
  • "minimal": 0,
  • "app_label_id": 1,
  • "platform": "android"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Discounts

Get discounts

Get the list of available discounts with discounts codes.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create a discount

Create a new discount.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Parameters for the new discount to create.

network_id
required
integer >= 1

The network's identifier.

name
required
string

The new discount's name.

type
required
integer
Enum: 1 2 3 5 6

The new discount's type.

1: Add credits to the user;

2: Discount on the price of the next trip;

3: Percentage discount on all future purchases until the stop date of the discount;

5: Discount on the price of the next purchase;

6: Percentage discount on all future trips until the stop date of the discount.

data
required
number >= 0

The value of the discount (in percentage or in credit according to the type).

start_date
required
string <date>

The date from which the discount can be registered and used by the user.

request_end_date
required
string or null <date>

The date from which the discount can no longer be registered by the user.

stop_date
required
string or null <date>

The date from which the discount can no longer be used by the user.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1,
  • "name": "string",
  • "type": 1,
  • "data": 0,
  • "start_date": "2019-08-24",
  • "request_end_date": "2019-08-24",
  • "stop_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Update a discount

Update a discount.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the discount.

Request Body schema: application/json
required

Parameters for the new discount to create.

name
string

The new discount's name.

data
number >= 0

The value of the discount (in percentage or in credit according to the type).

start_date
string <date>

The date from which the discount can be registered and used by the user.

request_end_date
string or null <date>

The date from which the discount can no longer be registered by the user.

stop_date
string or null <date>

The date from which the discount can no longer be used by the user.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "data": 0,
  • "start_date": "2019-08-24",
  • "request_end_date": "2019-08-24",
  • "stop_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Delete or disable a discount

Delete an unused discount or disable it if the discount has already been used.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the discount.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Create a discount code

Create a new discount code.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the discount to which the code should be linked.

Request Body schema: application/json
required

Parameters for the new discount code to create.

code
required
string [ 1 .. 50 ] characters /^[A-Z0-9-@_#]{1,50}$/

The discount code.

remaining
required
integer >= -1

Number of uses of the remaining code. -1 for unlimited.

email_access_pattern
required
string non-empty /^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

Pattern of the user's email that can use the code. Using '%' makes the code available to all users.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "remaining": -1,
  • "email_access_pattern": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Update a discount code

Update a discount code.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the discount code.

Request Body schema: application/json
required

Parameters for update the discount code.

code
string [ 1 .. 50 ] characters /^[A-Z0-9-@_#]{1,50}$/

The discount code.

remaining
integer >= -1

Number of uses of the remaining code. -1 for unlimited.

email_access_pattern
string non-empty /^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

Pattern of the user's email that can use the code. Using '%' makes the code available to all users.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "remaining": -1,
  • "email_access_pattern": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Delete a discount code

Delete an unused discount code.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the discount code to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

FAQ

Create category

Create a new FAQ category.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Category parameters.

key
required
string^faq\.[0-9]+\.categories\.[a-z0-9-]+$

The unique key of this category.

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update category

Update a FAQ category.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Category parameters.

key
required
string^faq\.[0-9]+\.categories\.[a-z0-9-]+$

The unique key of this category.

sort_order
required
integer [ 0 .. 32767 ]

The order in which the elements should be displayed.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "sort_order": 32767
}

Response samples

Content type
application/json
Example
{
  • "code": 0
}

Delete category

Delete a FAQ category. It should not have any sub-categories.

Authorizations:
(AuthenticatedPermissions)
query Parameters
key
required
string^faq\.[0-9]+\.categories\.[a-z0-9-]+$

Key of the category to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update category name

Update a FAQ category name.

Authorizations:
(AuthenticatedPermissions)
path Parameters
lang
required
string^[a-zA-Z]{2}$

The lang in which to update the name.

Request Body schema: application/json
required

Category name parameters.

key
required
string^faq\.[0-9]+\.categories\.[a-z0-9-]+$

The unique key of this category.

name
required
string [ 1 .. 100 ] characters

The name of the category.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Create sub-category

Create a new FAQ sub-category.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Sub-category parameters.

key
required
string^faq\.[0-9]+\.sub_categories\.[a-z0-9-]+\.[a-...

The unique key of this sub-category.

replacements
Array of strings unique
Items Enum: "app-label" "support-email" "support-phone"

The variables to use in the text as replacements.

category
required
string^faq\.[0-9]+\.categories\.[a-z0-9-]+$

The key of the category in which to put this sub-category.

is_spacer
boolean

Set to true to set this as a spacer.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "replacements": [
    ],
  • "category": "string",
  • "is_spacer": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update sub-category

Update a FAQ sub-category.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Sub-category parameters.

key
required
string^faq\.[0-9]+\.sub_categories\.[a-z0-9-]+\.[a-...

The unique key of this sub-category.

sort_order
required
integer [ 0 .. 32767 ]

The order in which the elements should be displayed.

replacements
Array of strings unique
Items Enum: "app-label" "support-email" "support-phone"

The variables to use in the text as replacements.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "sort_order": 32767,
  • "replacements": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete sub-category

Delete a FAQ sub-category. It should not have any content.

Authorizations:
(AuthenticatedPermissions)
query Parameters
key
required
string^faq\.[0-9]+\.sub_categories\.[a-z0-9-]+\.[a-...

Key of the sub-category to delete.

Responses

Response samples

Content type
application/json
Example
{
  • "code": -39999999,
  • "message": {
    }
}

Update sub-category name

Update a FAQ sub-category name.

Authorizations:
(AuthenticatedPermissions)
path Parameters
lang
required
string^[a-zA-Z]{2}$

The lang in which to update the name.

Request Body schema: application/json
required

Sub-category name parameters.

key
required
string^faq\.[0-9]+\.sub_categories\.[a-z0-9-]+\.[a-...

The unique key of this sub-category.

name
required
string [ 1 .. 100 ] characters

The name of the category.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Create content

Create a new FAQ content.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Content parameters.

key
required
string^faq\.[0-9]+\.contents\.[a-z0-9-]+\.[a-z0-9-]...

The unique key of this content.

replacements
Array of strings unique
Items Enum: "app-label" "support-email" "support-phone"

The variables to use in the text as replacements.

bold
required
boolean

Whether or not to display the text in bold.

margin
string^\d{1-3},\d{1-3},\d{1-3},\d{1-3}$

The margin to apply around the content.

text_color
string
Enum: "primary" "secondary" "tertiary" "quaternary" "success" "warn" "danger" "white"

The color of the text if different than the default one.

bullet_color
string
Enum: "primary" "secondary" "tertiary" "quaternary" "success" "warn" "danger" "white"

The color of the bullet point. Required for content of type bullet-point, ignored otherwise.

sub_category
required
string^faq\.[0-9]+\.sub_categories\.[a-z0-9-]+\.[a-...

The sub-category for this content.

type
required
string
Enum: "text" "formatted-text" "bullet-point"

The type of content.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "replacements": [
    ],
  • "bold": true,
  • "margin": "string",
  • "text_color": "primary",
  • "bullet_color": "primary",
  • "sub_category": "string",
  • "type": "text"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update content

Update a FAQ content.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Content parameters.

key
required
string^faq\.[0-9]+\.contents\.[a-z0-9-]+\.[a-z0-9-]...

The unique key of this content.

sort_order
required
integer [ 0 .. 32767 ]

The order in which the elements should be displayed.

replacements
Array of strings unique
Items Enum: "app-label" "support-email" "support-phone"

The variables to use in the text as replacements.

bold
required
boolean

Whether or not to display the text in bold.

margin
string^\d{1-3},\d{1-3},\d{1-3},\d{1-3}$

The margin to apply around the content.

text_color
string
Enum: "primary" "secondary" "tertiary" "quaternary" "success" "warn" "danger" "white"

The color of the text if different than the default one.

bullet_color
string
Enum: "primary" "secondary" "tertiary" "quaternary" "success" "warn" "danger" "white"

The color of the bullet point. Required for content of type bullet-point, ignored otherwise.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "sort_order": 32767,
  • "replacements": [
    ],
  • "bold": true,
  • "margin": "string",
  • "text_color": "primary",
  • "bullet_color": "primary"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete content

Delete a FAQ content.

Authorizations:
(AuthenticatedPermissions)
query Parameters
key
required
string^faq\.[0-9]+\.contents\.[a-z0-9-]+\.[a-z0-9-]...

Key of the content to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update content text

Update a FAQ content text.

Authorizations:
(AuthenticatedPermissions)
path Parameters
lang
required
string^[a-zA-Z]{2}$

The lang in which to update the content.

Request Body schema: application/json
required

Content text parameters.

key
required
string^faq\.[0-9]+\.contents\.[a-z0-9-]+\.[a-z0-9-]...

The unique key of this content.

content
required
string >= 1

The new text of the content.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get faq languages

Get languages of the faq of the specified app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

FleetAlerts

Get fleet alerts

Returns current fleet alerts of the specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the fleet alerts.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get fleet alerts history

Returns old fleet alerts of the specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the fleet alerts.

primary_key_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the transaction identifier.

page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last transaction on the current page, used to request the next page.

sort_by
string
Enum: "creation_date" "alert_severity" "resolved_at"

Custom sort key.

sort_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the custom sort key.

alert_type
string (AlertType)
Enum: "unexpected-unlock" "spot-identify-fail" "spot-high-temperature" "station-power-cut" "station-alarm-triggered" "vehicle-illegal-moving" "vehicle-dismantling" "vehicle-lifted" "vehicle-fallen" "vehicle-out-of-network-area"

Filter by alert type.

alert_severity
string (AlertSeverity)
Enum: "low" "high" "critical"

Filter by alert severity.

creation_date_min
string <date>

Filter the minimum alert creation date.

creation_date_max
string <date>

Filter the maximum alert creation date.

user_id
integer >= 1

Filter by the user's identifier who made the transaction.

email
string non-empty

Filter by the user's email who made the transaction (partial match search).

resolved_at_min
string <date>

Filter by minimum resolution date.

resolved_at_max
string <date>

Filter by maximum resolution date.

cluster_name
string [ 1 .. 50 ] characters

What the name of the cluster concerned by the alert should contains.

cluster_id
integer >= 1

Filter by the id of the cluster concerned by the alert.

vehicle_id
integer >= 1

Filter by the id of the vehicle concerned by the alert.

serial_number
string [ 6 .. 10 ] characters

Filter by serial number of a vehicle concerned by the alert.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Resolve alerts

Mark the specified alerts as resolved.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Ids of alerts to solve.

alert_ids
required
Array of integers non-empty [ items >= 1 ]

Array of identifier to resolve.

Responses

Request samples

Content type
application/json
{
  • "alert_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Heatmap

Get heatmap

Return the list of points to make a heatmap.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the offers.

lat
required
number [ -90 .. 90 ]

The latitude of the center of the area in which to get points.

lng
required
number [ -180 .. 180 ]

The longitude of the center of the area in which to get points.

latDeg
required
number [ -90 .. 90 ]

The number of latitude degree of the area in which to get points. 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 points. Can be compared to the width of the area.

date_min
required
string <datetime>

The minimum start date of points to show. Rounded by month, every points made in a month are given the first day of the month as a date.

date_max
required
string <datetime>

The maximum start date of points to show. Rounded by month, every points made in a month are given the first day of the month as a date.

zoom
required
integer
Enum: 0 1 2

The zoom level, change the points precision. 0 -> x.xxx, 1 -> x.xxx(0|5), 2 -> x.xxxx

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Invoices

Get invoices

Get the list of invoices linked to the user.

Authorizations:
(AuthenticatedPermissions)
query Parameters
page
required
integer

The page number of the invoices.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Download invoices

Download an invoice in PDF format.

Authorizations:
(AuthenticatedPermissions)
path Parameters
ref
required
string

The invoice's reference.

Responses

Response samples

Content type
application/json
{
  • "code": -39999999,
  • "message": {
    }
}

Localizations

Get localizations

Get the list of localizations for the specified language.

Authorizations:
(AuthenticatedPermissions)
query Parameters
lang
required
string = 2 characters

The lang in which to get localizations.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create or update localization

Create a new localization for the specified type and lang, update if already exist.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info on the localization to create or update.

key
required
string [ 1 .. 100 ] characters

The key of the localization.

value
required
string

The value of the localization.

lang
required
string/^[a-zA-Z]{2}$/

The language of the localization.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "lang": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get languages

Get the list of available languages.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create language

Create a new language for the specified ISO639-1 lang code and name.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info on the language to create.

iso_639_1
required
string/^[a-zA-Z]{2}$/

ISO639-1 key of the language.

name
required
string <= 50 characters

The name of the language.

Responses

Request samples

Content type
application/json
{
  • "iso_639_1": "fr",
  • "name": "Français"
}

Response samples

Content type
application/json
{
  • "code": 0
}

MailTemplates

Get mail template names

Get the list of transactional mail templates name.

Authorizations:
Authenticated

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get mail template base

Get mail template base for the given app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update template base

Update the template base draft.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: application/json
required

Template base parameters.

design
required
string

The json produced by the unlayer editor.

html
required
string

The html produced by the unlayer editor.

Responses

Request samples

Content type
application/json
{
  • "design": "string",
  • "html": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get mail template content

Get the mail template content.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update template content

Update the template content draft.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Request Body schema: application/json
required

Template content parameters.

lang
required
string^[a-zA-Z]{2}$

The language of the content.

required
Array of objects

The updated contents.

Responses

Request samples

Content type
application/json
{
  • "lang": "string",
  • "contents": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get mail template content lang

Get the mail template content languages and their translation completion status.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Delete mail template content lang

Delete the mail template content language by deleting all of its translations.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

lang
required
string^[a-z]{2}$

Lang to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Send test mail

Send a test mail of the given mail template to the requesting user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Request Body schema: application/json
required

Test mail parameters.

lang
required
string:^[a-zA-Z]{2}$

The language of the content.

draft
required
boolean

Whether or not to send the draft or production version of the template.

required
object

And object containing all replacements variables and their values.

Responses

Request samples

Content type
application/json
{
  • "lang": "string",
  • "draft": true,
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get app label template images

Get the list of images usable for mail template for the given app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Upload template image

Upload a new image to be used in mail templates.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: multipart/form-data
required

The image to upload.

image
required
string <binary>

The image file data.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Promote base draft

Promote the current mail template base draft to production.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Request Body schema: multipart/form-data
required

The promote parameters.

force
boolean

Whether or not to force the promotion.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Delete base draft

Delete the current mail template base draft.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Promote content draft

Promote the current mail template content draft to production.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Request Body schema: multipart/form-data
required

The promote parameters.

force
boolean

Whether or not to force the promotion.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Delete content draft

Delete the current mail template content draft.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

template_name
required
string [ 1 .. 32 ] characters

Name of the mail template.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

MailingLists

Get mailing list

Get mailing lists for the given app label.

Authorizations:
(AuthenticatedPermissions)
path Parameters
app_label_id
required
integer >= 1

Identifier of the app label.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Maintenances

Get current maintenances

Route to get all current maintenances of the active fleet (vehicle on station or virtual parked, spots, stations).

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get fleet maintenance.

lang
required
string = 2 characters

The lang in which to get the maintenance types localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create maintenance type

Create a new maintenance type.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info on the maintenance type to create.

key
required
string [ 1 .. 50 ] characters

Unique key of maintenance type.

target_type
required
string (MaintenanceTargetType)
Enum: "station" "spot" "vehicle"

The type of object on which this type applies.

severity
required
string (MaintenanceSeverity)
Enum: "info" "low" "high"

The severity of the problem.

  • info: this does not impact the service but still need to be known
  • low: this reduce the quality of the service
  • high: this make the service unusable

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "target_type": "station",
  • "severity": "info"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete maintenance type

Remove the maintenance type, avoiding it from being used to create new maintenances.

Authorizations:
(AuthenticatedPermissions)
query Parameters
key
required
string [ 1 .. 50 ] characters

The key of the maintenance type to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Networks

Get networks

Return all networks with some indicators (network's owner, creation date, total stations, vehicles and trips).

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create a network

Create a new network.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Parameters for the new network to create.

name
required
string [ 1 .. 200 ] characters

The new network's name.

default_vat
required
number [ 0 .. 1 ]

The default vat percentage of the network.

country_id
required
integer >= 1

The identifier of the country where the network is situated.

currency
required
string
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"

The currency of the network. Used for default_vehicle_guarantee, offers, and network pricing.

default_vehicle_guarantee
required
number >= 0

The amount of the pre-authorization to rent a vehicle on the network.

trip_to_skip_pre_auth_guarantee
required
integer >= -1

Number of trips to be finished in order not to have the pre-authorization (-1: pre-authorization is mandatory, 0: pre-authorization never performed).

timezone
required
string
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone where the network is situated.

third_party_id
integer >= 1

The identifier of the third party that own the network (if any).

app_label_id
required
integer >= 1

The identifier of default app label of the network.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_vat": 1,
  • "country_id": 1,
  • "currency": "string",
  • "default_vehicle_guarantee": 0,
  • "trip_to_skip_pre_auth_guarantee": -1,
  • "timezone": "Africa/Abidjan",
  • "third_party_id": 1,
  • "app_label_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Get short networks list

Get the list of authorized networks in activity for the user. The main purpose is the dashboard network selector.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get network detail

Return details of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete a network

Mark a network as definitively closed.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get access rules

Return access rules of a given network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network of which to get access rules.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create access rule

Create a new access rule for a given network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network on which to create the access rule.

Request Body schema: application/json
required

Info on the new access rule to create, at least one property is required.

email_pattern
string/^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

A pgsql pattern that specifies which email can access this network.

organization
integer >= 1

The identifier of an organization that can access this network.

app_label
integer >= 1

The identifier of the app white label that can access this network.

Responses

Request samples

Content type
application/json
{
  • "email_pattern": "string",
  • "organization": 1,
  • "app_label": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 1
}

Update access rule

Update the given network access rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network on which the access rule is.

rid
required
integer >= 1

Identifier of the network access rule to edit.

Request Body schema: application/json
required

Info on the new access rule to update, at least one property is required.

email_pattern
required
string or null/^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

A pgsql pattern that specifies which email can access this network.

organization
required
integer or null >= 1

The identifier of an organization that can access this network.

app_label
required
integer or null >= 1

The identifier of the app white label that can access this network.

Responses

Request samples

Content type
application/json
{
  • "email_pattern": "string",
  • "organization": 1,
  • "app_label": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete access rule

Delete the given network access rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network on which the access rule is.

rid
required
integer >= 1

Identifier of the network access rule to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update network sponsorship

Update network the amount of sponsorship rewards.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

The new reward amount for sponsorship.

sponsoring_reward
required
number >= 0

The amount given to the wallet of the user that sponsored another user.

sponsored_reward
required
number >= 0

The amount given to the wallet of the sponsored user, when he made his first trip.

Responses

Request samples

Content type
application/json
{
  • "sponsoring_reward": 0,
  • "sponsored_reward": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get networks vehicle models settings

Get the list of vehicle models with a specific settings on the network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get networks vehicle models guarantees

Get the list of vehicle models with a specific guarantee on the network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update vehicle settings

Update vehicle settings for a specific network and vehicle model.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

model_id
required
integer >= 1

The vehicle model identifier.

Request Body schema: multipart/form-data
required

The new settings.

auto_light
required
boolean

True to automatically turn on the vehicle light when unlocking.

speed_mode
required
integer or null
Enum: 1 2 3

If not null, block the vehicle speed mode in the specified mode and disable the speed button (1 = ECO, 2 = NORMAL, 3 = SPORT).

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update vehicle guarantees

Update vehicle guarantees for a specific network and vehicle model.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

model_id
required
integer >= 1

The vehicle model identifier.

Request Body schema: multipart/form-data
required

The new guarantee.

guarantee
required
number <float> >= 0

The amount that will be billed to the user if it does not return the vehicle.

pre_auth
required
number <float> >= 0

The amount that will be asked for the vehicle model for a pre auth before starting a trip.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get networks vehicle speed settings

Get the speed settings for vehicles of the network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update networks vehicle speed settings

Update the speed settings for vehicles of the network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: multipart/form-data
required

The new settings.

default_low_speed
required
integer

The default low speed of vehicles.

default_medium_speed
required
integer

The default medium speed of vehicles.

default_high_speed
required
integer

The default high speed of vehicles.

min_battery_to_slow_down
required
integer or null

The battery level at which the vehicle will slow down.

battery_slow_down_speed
required
integer or null

The speed at which the vehicle will be maxed out when the battery reach the min battery level.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Reset vehicles settings

Reset all vehicles settings with IoT for a specific network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Set out of order

Add an out of order for a specific network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Info on the out of order to create.

type
required
string
Enum: "other" "winter"

Type of the out of order.

reason
string [ 1 .. 100 ] characters

Reason of the out of order.

start_date
required
string <date-time>

Start date of the out of order.

end_date
string or null <date-time>

End date of the out of order.

Responses

Request samples

Content type
application/json
{
  • "type": "other",
  • "reason": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get rent settings

Return rent settings and timings of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update rent settings

Update rent settings of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Rent settings.

default_vehicle_guarantee
required
number >= 0

The amount of the vehicle guarantee.

trip_to_skip_pre_auth_guarantee
required
integer >= -1

Number of trips to be finished in order not to skip the pre-authorization (-1: mandatory pre-authorization, 0: never pre-authorization).

first_purchase_required
required
boolean

Force user to do a purchase before renting for the first time.

min_battery_to_rent
required
integer [ 10 .. 95 ]

The minimum battery level of a vehicle to be able to rent it.

max_simultaneous_rented_vehicle
required
integer [ 1 .. 10 ]

Maximum number of vehicle that can be rented at the same time by one user.

trip_on_hold
required
boolean

Indicate if user can put trip on hold (temporary lock).

credit_depletion_auto_lock
required
boolean

Force to lock the vehicle if user doesn't has enough credit on it's account.

min_battery_to_auto_lock
required
integer or null [ 1 .. 50 ]

Force to lock the vehicle if the battery is lower than the indicated level .

Responses

Request samples

Content type
application/json
{
  • "default_vehicle_guarantee": 0,
  • "trip_to_skip_pre_auth_guarantee": -1,
  • "first_purchase_required": true,
  • "min_battery_to_rent": 10,
  • "max_simultaneous_rented_vehicle": 1,
  • "trip_on_hold": true,
  • "credit_depletion_auto_lock": true,
  • "min_battery_to_auto_lock": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update rent timings

Update rent timings of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Rent timings. All values are in seconds.

trip_too_long_notifications
required
number [ 3600 .. 604800 ]

Time after which the user will receive notifications that his trip is too long and he should return the vehicle.

trip_too_long_notifications_frequency
required
integer [ 900 .. 604800 ]

Frequency in seconds of sending return vehicle notifications.

vehicle_stolen
required
integer [ 43200 .. 2592000 ]

Time after which a vehicle is considered stolen if it is still not returned.

trip_auto_pause
required
integer [ 0 .. 604800 ]

Time after which the trip will be on-hold (temporarily lock) if the vehicle doesn't move anymore.

trip_max_pause
required
integer [ 0 .. 604800 ]

Maximum duration of a pause. If the user doesn't unlock the vehicle after this delay, the trip will be stopped and the vehicle will be available to everyone.

trip_auto_lock
required
integer [ 0 .. 604800 ]

Maximum duration of a trip. The vehicle will be lock and the trip stopped if it exceed this value.

Responses

Request samples

Content type
application/json
{
  • "trip_too_long_notifications": 3600,
  • "trip_too_long_notifications_frequency": 900,
  • "vehicle_stolen": 43200,
  • "trip_auto_pause": 604800,
  • "trip_max_pause": 604800,
  • "trip_auto_lock": 604800
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get freefloat to station reward

Return freefloat to station reward of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update freefloat to station reward

Update freefloat to station reward of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Freefloat to station rewards.

freefloat_to_station_discount_per_km
number or null <float> [ 0 .. 99999999 ]

The amount given to the user per km made on a trip from freefloat to a station.

freefloat_to_station_free_credits
number or null <float> [ 0 .. 99999999 ]

The amount given for a vehicle that returns to a station.

freefloat_to_receiver_station_free_credits
number or null <float> [ 0 .. 99999999 ]

The amount given for a vehicle that returns to a station that is a receiver.

freefloat_to_station_min_battery
integer or null [ 0 .. 100 ]

The minimum battery level of the vehicle. If the vehicle has a greater battery level the rewards won't be granted.

Responses

Request samples

Content type
application/json
{
  • "freefloat_to_station_discount_per_km": 99999999,
  • "freefloat_to_station_free_credits": 99999999,
  • "freefloat_to_receiver_station_free_credits": 99999999,
  • "freefloat_to_station_min_battery": 100
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get notification settings

Get notifications settings of the specified network.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create notification settings

Add a notifications settings.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Info on the notification settings to create.

notification_type
required
string
Enum: "fleet-alert" "vehicle-fault" "station-down" "support-report" "support-message"

The type of notification

alert_types
required
Array of strings (AlertType) non-empty
Items Enum: "unexpected-unlock" "spot-identify-fail" "spot-high-temperature" "station-power-cut" "station-alarm-triggered" "vehicle-illegal-moving" "vehicle-dismantling" "vehicle-lifted" "vehicle-fallen" "vehicle-out-of-network-area"

Type of alerts sent.

alert_severities
required
Array of strings (AlertSeverity) non-empty
Items Enum: "low" "high" "critical"

Severity level of alerts sent.

check_interval
integer >= 0

The interval in seconds in which the system will check for new alerts to sent.

check_delay
integer >= 0

The delay to wait before sending a notifications. Only notifications older than the specified delay will be sent.

Responses

Request samples

Content type
application/json
{
  • "notification_type": "fleet-alert",
  • "alert_types": [
    ],
  • "alert_severities": [
    ],
  • "check_interval": 0,
  • "check_delay": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update notification settings

Edit a notifications settings.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

notification_id
required
integer >= 1

The notification setting's identifier.

Request Body schema: application/json
required

News values for the notification settings.

notification_type
required
string
Enum: "fleet-alert" "vehicle-fault" "station-down" "support-report" "support-message"

The type of notification

alert_types
required
Array of strings (AlertType) non-empty
Items Enum: "unexpected-unlock" "spot-identify-fail" "spot-high-temperature" "station-power-cut" "station-alarm-triggered" "vehicle-illegal-moving" "vehicle-dismantling" "vehicle-lifted" "vehicle-fallen" "vehicle-out-of-network-area"

Type of alerts sent.

alert_severities
required
Array of strings (AlertSeverity) non-empty
Items Enum: "low" "high" "critical"

Severity level of alerts sent.

check_interval
integer >= 0

The interval in seconds in which the system will check for new alerts to sent.

check_delay
integer >= 0

The delay to wait before sending a notifications. Only notifications older than the specified delay will be sent.

Responses

Request samples

Content type
application/json
{
  • "notification_type": "fleet-alert",
  • "alert_types": [
    ],
  • "alert_severities": [
    ],
  • "check_interval": 0,
  • "check_delay": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete notification settings

Remove a notifications settings.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

notification_id
required
integer >= 1

The notification setting's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Add notification target

Add a notifications target.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

notification_id
required
integer >= 1

The notification setting's identifier.

Request Body schema: application/json
required

Target email or user data.

One of
user_id
required
integer >= 1

Identifier of the user.

Responses

Request samples

Content type
application/json
Example
{
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete notification target

Remove a notifications target.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

notification_id
required
integer >= 1

The notification setting's identifier.

query Parameters
user_id
integer >= 1

The identifier of the user to remove from targets. Required if email is absent.

email
string <email>

The external email to remove from targets. Required if user_id is absent.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get clusters balancing

Get the list of cluster that beneficiate from balancing.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create cluster balancing

Add a cluster to the list of clusters that beneficiate from balancing.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Info on the cluster balancing to create.

cluster_id
required
integer >= 0

The identifier of the cluster.

target_count
required
integer

The number of vehicle that we target (to be less than for donor clusters and greater than for receiver clusters).

balancing_type
required
string (BalancingType)
Enum: "donor" "receiver"

The type of the station for the balancing discounts. Renting a vehicle from a donor station to a receiver station will grant the user a discount on its trip.

Responses

Request samples

Content type
application/json
{
  • "cluster_id": 0,
  • "target_count": 0,
  • "balancing_type": "donor"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update cluster balancing

Update the target count of a cluster balancing.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Info on the cluster balancing to update.

cluster_id
required
integer >= 0

The identifier of the cluster.

target_count
required
integer

The number of vehicle that we target (to be less than for donor clusters and greater than for receiver clusters).

Responses

Request samples

Content type
application/json
{
  • "cluster_id": 0,
  • "target_count": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete cluster balancing

Remove a cluster from the list of clusters that beneficiate from balancing.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

query Parameters
cluster_id
required
integer >= 1

The cluster's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get clusters balancing discounts

Get the discount amount of a clusters balancing discount.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update cluster balancing discount

Update the discount of a cluster balancing route.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

Request Body schema: application/json
required

Info on the balancing discount to update.

donor_cluster_id
required
integer >= 1

The identifier of the cluster on which the trip need to start.

receiver_cluster_id
required
integer >= 1

The identifier of the cluster on which the trip need to finish.

discount_amount
required
number

The amount of the discount applied to the trip.

Responses

Request samples

Content type
application/json
{
  • "donor_cluster_id": 1,
  • "receiver_cluster_id": 1,
  • "discount_amount": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get estimate

Get the average duration of the x percent of the fastest trips between two clusters.

Authorizations:
(AuthenticatedPermissions)
path Parameters
network_id
required
integer >= 1

The network's identifier.

query Parameters
donor_cluster_id
required
integer >= 1

The cluster id on which the trip start.

receiver_cluster_id
required
integer >= 1

The cluster id on which the trip finish.

fastest_trip_percentage
required
integer [ 1 .. 50 ]

The size of the sample of trips to use.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Newsletters

Get newsletters

Get the list of newsletters.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create newsletter

Create a new newsletter for the given app label.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Newsletter parameters.

name
required
string [ 1 .. 255 ] characters

The name of the newsletter.

type
required
string
Enum: "legal" "network-status" "marketing" "custom-list"

The type of the newsletter.

transport
required
string
Enum: "mails" "push"

The way the newsletter will be sent.

target_type
required
string
Enum: "app-label" "network" "organization" "mailing-list"

The type of the target of the newsletter (a newsletter should have a least one target).

target_id
required
integer >= 1

The identifier of the target (app label id, network id, organization id or mailing list id).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "legal",
  • "transport": "mails",
  • "target_type": "app-label",
  • "target_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get newsletter details

Get the details of a newsletter.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter to get details of.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Send newsletter

Send the given newsletter to all the matching users.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Request Body schema: application/json
required

Send parameters.

planned_send_date
string <datetime>

The date at which you want the newsletter to be sent. Should be rounded to a whole hour in the future.

Responses

Request samples

Content type
application/json
{
  • "planned_send_date": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Send newsletter test

Send the given newsletter to the requesting user for testing purposes.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Request Body schema: application/json
required

Send parameters.

lang
string^[a-zA-Z]{2}$

The language of the user that the newsletter will be sent to.

Responses

Request samples

Content type
application/json
{
  • "lang": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Add newsletter target

Add a target to the given newsletter.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Request Body schema: application/json
required

Target object.

target_type
required
string
Enum: "app-label" "network" "organization" "mailing-list"

The type of the new target.

target_id
required
integer >= 1

The identifier of the target (app label id, network id, organization id or mailing list id).

Responses

Request samples

Content type
application/json
{
  • "target_type": "app-label",
  • "target_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete newsletter target

Delete a target of the given newsletter.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

target_id
required
integer >= 1

Identifier of the newsletter target.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Add newsletter target filter

Add a filter to the given newsletter target.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

target_id
required
integer >= 1

Identifier of the newsletter target.

Request Body schema: application/json
required

Target object.

filter_type
required
string
Enum: "trip_count" "visited_station" "register_duration" "last_activity" "traveled_distance" "usage_frequency"

The type of the new target filter.

filter_value
required
integer

The used in the comparison. Can be a whole number, seconds or a cluster_id according the to filter type.

operator
required
string
Enum: "<" "=" ">"

How to compare the value.

Responses

Request samples

Content type
application/json
{
  • "filter_type": "trip_count",
  • "filter_value": 0,
  • "operator": "<"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete newsletter target filter

Delete a filter of the given newsletter target.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

target_id
required
integer >= 1

Identifier of the newsletter target.

filter_id
required
integer >= 1

Identifier of the newsletter target filter.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get newsletter template

Get the template of a newsletter (mails).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the template to get.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update newsletter template

Create or update a newsletter template (mails).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the template.

Request Body schema: application/json
required

Target object.

subject
required
string [ 1 .. 255 ] characters

The subject of the mail.

design
required
string

The unlayer design for the template.

html
required
string

The html rendered for the mail.

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "design": "string",
  • "html": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete newsletter template

Delete a template of a newsletter (mails).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the template to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get newsletter text

Get the text of a newsletter (push notification).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the text to get.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update newsletter text

Create or update a newsletter text (push notification).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the text.

Request Body schema: application/json
required

Text object.

title
required
string [ 1 .. 65 ] characters

The title of the push notification.

message
required
string [ 1 .. 240 ] characters

The message of the push notification.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete newsletter text

Delete a text of a newsletter (push notification).

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

lang
required
string^[a-zA-Z]{2}$

The language of the text to delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get app label template images

Get the list of images usable for newsletter templates.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Upload template image

Upload a new image to be used in newsletters template.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Request Body schema: multipart/form-data
required

The image to upload.

image
required
string <binary>

The image file data.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get statistics of a newsletter

Get the statistics of a published newsletter.

Authorizations:
(AuthenticatedPermissions)
path Parameters
newsletter_id
required
integer >= 1

Identifier of the newsletter.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Offers

Get offers.

Returns offers of the specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the offers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create an offer.

Create a new offer.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info of the offer to create.

title
required
string [ 1 .. 50 ] characters

Title of the offer.

available
required
boolean

True when the offer is available.

network_id
required
integer >= 1

The identifier of the offer's network.

price
required
number

Price of the offer.

given_amount
required
number

Amount given in the wallet.

Responses

Request samples

Content type
application/json
{
  • "title": "Strasbourg2 5€",
  • "available": true,
  • "network_id": 1,
  • "price": 0,
  • "given_amount": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update an offer

Update an offer. Only availability can be changed on an offer that was already bought at least one time.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the offer.

Request Body schema: application/json
required

Offer info to update.

title
string [ 1 .. 50 ] characters

Title of the offer.

available
boolean

True when the offer is available.

price
number

Price of the offer.

given_amount
number

Amount given in the wallet.

Responses

Request samples

Content type
application/json
{
  • "title": "Strasbourg2 5€",
  • "available": true,
  • "price": 0,
  • "given_amount": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete an offer

Delete an offer, this can only be done if the offer wasn't bought by someone.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the offer.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Organizations

Get organizations

Return the list of organizations.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create organization

Create a new organization.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info about the organization.

third_party_id
required
integer >= 1

The identifier of the third party this organization will be linked to.

name
required
string [ 1 .. 255 ] characters

The name of the organization.

administrator_id
required
integer >= 1

The identifier of the user who will administer the organization.

is_guarantor
required
boolean

Whether or not the organization will pay for stolen vehicles.

allow_outside_rules
required
boolean

Whether or not the organization allow trips to start outside of the given rules.

paid_outside_rules_ratio
required
number [ 0 .. 1 ]

The ratio of trip cost which is paid by the organization. This only applies to the duration of trips that run outside of the defined rules.

only_show_matching_clusters
required
boolean

Whether of not users of the organization will see all clusters or only those that they have the right to use.

email_pattern
string/^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

A Postgresql pattern to determine which email are selected to join the organization.

pays_rule_overrun
required
boolean

Whether or not the organization pays for the parts of trips that started in a rules but overran its duration and finished outside of one.

reenrolment_frequency_in_days
number >= 1

The frequency in days at which the users of the organization needs to confirm their emails again.

description
string

A description for this organization.

Responses

Request samples

Content type
application/json
{
  • "third_party_id": 1,
  • "name": "string",
  • "administrator_id": 1,
  • "is_guarantor": true,
  • "allow_outside_rules": true,
  • "paid_outside_rules_ratio": 1,
  • "only_show_matching_clusters": true,
  • "email_pattern": "%@knot.city",
  • "pays_rule_overrun": true,
  • "reenrolment_frequency_in_days": 1,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get organization details

Return the details of an organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update organization

Update organization info.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Request Body schema: application/json
required

Info about the organization.

name
required
string [ 1 .. 255 ] characters

The name of the organization.

description
string

A description for this organization.

only_show_matching_clusters
required
boolean

Whether of not users of the organization will see all clusters or only those that they have the right to use.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "only_show_matching_clusters": true
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get organization rules

Return the list of rules of an organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get transactions.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create organization rule

Create a new organization rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Request Body schema: application/json
required

Info about the organization rule.

network_id
required
integer >= 1

The identifier of the network on which the rule applies.

start_dow
required
integer [ 0 .. 6 ]

The day of the week at which the rule starts.

start_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The hour of the day at which the rule starts.

end_dow
required
integer [ 0 .. 6 ]

The day of the week at which the rule ends.

end_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The hour of the day at which the rule ends.

max_vehicles
integer >= 1

The maximum number of vehicle the user can rent at the same time. If null or undefined, the default 3 is used.

paid_by_org_ratio
required
number [ 0 .. 1 ]

The ratio of the bill that will be paid by the organization for the duration of trips that span the period of the rule.

rule_name
required
string [ 1 .. 128 ] characters

The display name of the rule.

network_name
required
string [ 1 .. 128 ] characters

The name of the network on which the rule applies.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1,
  • "start_dow": 6,
  • "start_hod": "string",
  • "end_dow": 6,
  • "end_hod": "string",
  • "max_vehicles": 1,
  • "paid_by_org_ratio": 1,
  • "rule_name": "string",
  • "network_name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update organization rule

Update organization rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

rid
required
integer >= 1

The identifier of the rule.

Request Body schema: application/json
required

Info about the organization rule.

network_id
required
integer >= 1

The identifier of the network on which the rule applies.

start_dow
required
integer [ 0 .. 6 ]

The day of the week at which the rule starts.

start_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The hour of the day at which the rule starts.

end_dow
required
integer [ 0 .. 6 ]

The day of the week at which the rule ends.

end_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The hour of the day at which the rule ends.

max_vehicles
integer >= 1

The maximum number of vehicle the user can rent at the same time. If null or undefined, the default 3 is used.

paid_by_org_ratio
required
number [ 0 .. 1 ]

The ratio of the bill that will be paid by the organization for the duration of trips that span the period of the rule.

rule_name
required
string [ 1 .. 128 ] characters

The display name of the rule.

network_name
required
string [ 1 .. 128 ] characters

The name of the network on which the rule applies.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1,
  • "start_dow": 6,
  • "start_hod": "string",
  • "end_dow": 6,
  • "end_hod": "string",
  • "max_vehicles": 1,
  • "paid_by_org_ratio": 1,
  • "rule_name": "string",
  • "network_name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete organization rule

Delete an organization rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

rid
required
integer >= 1

The identifier of the rule.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update organization enrolment

Update organization enrolment conditions.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Request Body schema: application/json
required

The organization enrolment conditions.

email_pattern
required
string/^[a-zA-Z0-9@._(){}[\]|*+?%#\\-]+$/

A Postgresql pattern to determine which email are selected to join the organization.

reenrolment_frequency_in_days
required
number >= 1

The frequency in days at which the users of the organization needs to confirm their emails again.

manual_approbation
required
boolean

Enable manual approbation of organization enrolment.

enable_enrolment_token
required
boolean

Enable enrolment using link / qr code for users without corporation email.

enrolment_custom_field
required
string or null

Custom field in user registration / organization enrolment. The value entered by the user will be reported in the approval list.

Responses

Request samples

Content type
application/json
{
  • "email_pattern": "%@knot.city",
  • "reenrolment_frequency_in_days": 1,
  • "manual_approbation": true,
  • "enable_enrolment_token": true,
  • "enrolment_custom_field": "string"
}

Response samples

Content type
application/json
{}

Update organization administrator

Update organization administrator. The user should have the organization permission (write) for the organization it will be the administrator.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Request Body schema: application/json
required

The organization new administrator.

administrator_id
required
integer >= 1

The user identifier of the new administrator.

Responses

Request samples

Content type
application/json
{
  • "administrator_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update organization payments

Update organization payments conditions & settings.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Request Body schema: application/json
required

The organization payments conditions & settings.

is_guarantor
required
boolean

Whether or not the organization will pay for stolen vehicles.

allow_outside_rules
required
boolean

Whether or not the organization allow trips to start outside of the given rules.

paid_outside_rules_ratio
required
number [ 0 .. 1 ]

The ratio of trip cost which is paid by the organization. This only applies to the duration of trips that run outside of the defined rules.

pays_rule_overrun
required
boolean

Whether or not the organization pays for the parts of trips that started in a rules but overran its duration and finished outside of one.

Responses

Request samples

Content type
application/json
{
  • "is_guarantor": true,
  • "allow_outside_rules": true,
  • "paid_outside_rules_ratio": 1,
  • "pays_rule_overrun": true
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get organization enrolment requests

Return the list of enrolment requests of an organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Put enrolment request

Accept or reject an enrolment request.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the organization.

enrolment_id
required
integer >= 1

The identifier of the enrolment request.

Request Body schema: application/json
required

Reject or accept data.

accept
required
boolean

Whether the enrolment is accepted or refused.

reject_reason
string [ 1 .. 500 ] characters

Optional reason if rejected.

revoke_at
string <date>

Optional auto revoke user from organization at the specified date.

Responses

Request samples

Content type
application/json
{
  • "accept": true,
  • "reject_reason": "string",
  • "revoke_at": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "code": 0
}

OrganizationalUnits

Get organizational units

Get the list of organizational units.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create organizational unit

Create a new organizational unit.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Organizational unit data.

name
required
string [ 3 .. 50 ] characters

The name of the organizational unit.

app_labels
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of application labels included in this organizational unit.

organizations
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of organization included in this organizational unit.

networks
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of networks included in this organizational unit.

clusters
required
Array of integers >= 0 items unique [ items >= 1 ]

A restricted list of cluster included in this organizational unit. Allow to restrict given permission to only some clusters.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "app_labels": [
    ],
  • "organizations": [
    ],
  • "networks": [
    ],
  • "clusters": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update organizational unit

Update name and/or linked objects of an organizational unit.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Updated organizational unit data.

name
required
string [ 3 .. 50 ] characters

The name of the organizational unit.

app_labels
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of application labels included in this organizational unit.

organizations
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of organization included in this organizational unit.

networks
required
Array of integers >= 0 items unique [ items >= 1 ]

The list of networks included in this organizational unit.

clusters
required
Array of integers >= 0 items unique [ items >= 1 ]

A restricted list of cluster included in this organizational unit. Allow to restrict given permission to only some clusters.

ou_id
required
integer >= 1

The identifier of the organizational unit.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "app_labels": [
    ],
  • "organizations": [
    ],
  • "networks": [
    ],
  • "clusters": [
    ],
  • "ou_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete organizational unit

Delete the specified organizational unit if there is no longer user with permissions linked to it.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The organizational unit's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get organizational unit users

Get the list of users with their permissions for the given organizational unit.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The organizational unit's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get global user count

Get the count of user that have a permission globally.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 0
}

Out of order

Update out of order

Update an out of order.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the out of order.

Request Body schema: application/json
required

The out of order date.

reason
string or null [ 1 .. 100 ] characters

The out of order reason.

end_date
string or null <date-time>

The out of order end date.

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Overview

Get stations info

Return stats on the stations of specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get vehicles info

Return stats on the vehicles of specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get trips info

Return stats on the trips of specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get users info

Return stats on the users of specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get users.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get map info

Return info of the stations of specified networks to display on the map.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Passes

Get Passes

Return the list of all Passes of the specified network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the offers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create a Pass

Add new Pass on the specified network.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Parameters of the new Pass.

available
required
boolean

If the Pass is available.

title
required
string [ 1 .. 50 ] characters

The title of the Pass.

network_id
required
integer >= 1

Network identifier on which the Pass applies.

price
required
number <double> >= 0.001

The Pass's price, subtract from user wallet.

duration
required
integer >= 0

The duration of the Pass, in seconds.

validity
required
string or null
Enum: "day" "week" "month" "unlimited"

The pass's validity.

Responses

Request samples

Content type
application/json
{
  • "available": true,
  • "title": "string",
  • "network_id": 1,
  • "price": 0.001,
  • "duration": 0,
  • "validity": "day"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update a Pass

Update an Pass. Only the availability can be changed on a Pass that was already bought at least one time.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The Pass's identifier.

Request Body schema: application/json
required

Pass identifier and new value parameters.

available
required
boolean

If the Pass is available.

title
string [ 1 .. 50 ] characters

The title of the Pass.

price
number >= 0

The Pass's price, subtract from user wallet.

duration
integer >= 0

The duration of the Pass, in seconds.

validity
string or null
Enum: "day" "week" "month" "unlimited"

The pass's validity.

Responses

Request samples

Content type
application/json
{
  • "available": true,
  • "title": "string",
  • "price": 0,
  • "duration": 0,
  • "validity": "day"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete a Pass

Delete a Pass if it was never used.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The Pass's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Payment methods

Get by fingerprint

Get the payment methods with the same fingerprint as the given one.

Authorizations:
(AuthenticatedPermissions)
query Parameters
fingerprint
required
string

The fingerprint to look for.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Permissions

Get permissions

Get the list of available permissions.

Authorizations:
(AuthenticatedPermissions)
query Parameters
lang
required
string = 2 characters

The lang in which to get the permission localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Phone

Get phone provider

Return the list of phone SMS provider.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Pricing

Get pricing

Return pricing (price by minute of rent, price to unlock and to free float lock) of the specified network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the pricing.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Add pricing

Add a pricing rule for the specified network.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Pricing parameters.

start_dow
required
integer [ 0 .. 6 ]

The start day of week. 0 is Sunday.

start_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The time when the rule start (Network local time).

end_dow
required
integer [ 0 .. 6 ]

The end day of week. 0 is Sunday.

end_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The time when the rule end (Network local time).

unlock_price
required
number <float> >= 0

The price to unlock a vehicle on the network.

unlock_included_time
required
number >= 0

Use time in second included in the unlock price. Once this time has elapsed, the use price per minute applies.

freefloat_lock_price
required
number <float> >= 0

The price to lock a vehicle in freefloat mode on the network.

use_per_minute_price
required
number <float> >= 0

The price by minute to rent a vehicle on the network.

on_hold_price
required
number <float> >= 0

The price by minute to keep a vehicle on-hold (rented but locked). Usually lower than use_per_minute_price.

network_id
required
integer >= 1

Network identifier on which this price applies.

Responses

Request samples

Content type
application/json
{
  • "start_dow": 6,
  • "start_hod": "string",
  • "end_dow": 6,
  • "end_hod": "string",
  • "unlock_price": 0.1,
  • "unlock_included_time": 0,
  • "freefloat_lock_price": 0.1,
  • "use_per_minute_price": 0.1,
  • "on_hold_price": 0.1,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update pricing

Update the specified pricing rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The pricing's identifier.

Request Body schema: application/json
required

Pricing parameters.

start_dow
required
integer [ 0 .. 6 ]

The start day of week. 0 is Sunday.

start_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The time when the rule start (Network local time).

end_dow
required
integer [ 0 .. 6 ]

The end day of week. 0 is Sunday.

end_hod
required
string^((([0-1]?\d|2[0-3]):[0-5]\d:[0-5]\d)|24:00:0...

The time when the rule end (Network local time).

unlock_price
required
number <float> >= 0

The price to unlock a vehicle on the network.

unlock_included_time
required
number >= 0

Use time in second included in the unlock price. Once this time has elapsed, the use price per minute applies.

freefloat_lock_price
required
number <float> >= 0

The price to lock a vehicle in freefloat mode on the network.

use_per_minute_price
required
number <float> >= 0

The price by minute to rent a vehicle on the network.

on_hold_price
required
number <float> >= 0

The price by minute to keep a vehicle on-hold (rented but locked). Usually lower than use_per_minute_price.

network_id
required
integer >= 1

Network identifier on which this price applies.

Responses

Request samples

Content type
application/json
{
  • "start_dow": 6,
  • "start_hod": "string",
  • "end_dow": 6,
  • "end_hod": "string",
  • "unlock_price": 0.1,
  • "unlock_included_time": 0,
  • "freefloat_lock_price": 0.1,
  • "use_per_minute_price": 0.1,
  • "on_hold_price": 0.1,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete pricing

Delete the specified pricing rule.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The pricing's identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Reports

Get reports

Return reports of specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get users.

primary_key_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the user identifier.

page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last user on the current page, used to request the next page.

sort_by
string
Value: "date"

Custom sort key.

email
string >= 1

Filter by email.

archived
boolean

Filter by current reports (false) or archived reports (true)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ],
  • "total": 0
}

Get a report

Return details of a report.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Resolve report

Mark the specified report as resolved.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Send message

Send a chat message to the specified report's chat.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report to which send the message.

Request Body schema: application/json
required

Chat message parameter.

message
required
string [ 1 .. 2000 ] characters

The network to link to the report.

page
string [ 1 .. 256 ] characters

The name of app page or the url linked to this message (the app will show a button if present).

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "page": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Edit message

Update the specified chat message.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report in which the message is.

message_id
required
string <bigint>

Identifier of the message to edit.

Request Body schema: application/json
required

Chat message parameter.

message
required
string [ 1 .. 2000 ] characters

The network to link to the report.

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete message

Delete the specified chat message.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report in which the message is.

message_id
required
string <bigint>

Identifier of the message to edit.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get chat messages

Return paginated messages of the specified report's chat ordered by newest.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report of which to get messages.

query Parameters
last_message_date
string <date-time>

Offset to apply on the query to retrieve older message.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Send image

Send an image to the specified report's chat.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report to which send the message.

Request Body schema: multipart/form-data
required

The picture to upload.

chat_image
required
string <binary>

The picture file data.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Link to a network

Link the specified network to the report.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report.

Request Body schema: application/json
required

Network parameter.

network_id
required
integer >= 1

The network to link to the report.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Unlink to a network

Unlink the specified network from the report.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the report.

network_id
required
integer >= 1

Identifier of the network to unlink.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Roles

Get roles

Get the list of available roles.

Authorizations:
(AuthenticatedPermissions)
query Parameters
lang
required
string = 2 characters

The lang in which to get the permission localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create role

Create a new permission role.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Role key and its permissions.

key
required
string [ 3 .. 50 ] characters

The key of the new role.

perms
required
Array of strings (Permission) unique
Items Enum: "networks.manage" "vehicles.register" "maintenances" "unlock.admin" "networks.show.private" "dashboard.access" "users.list" "demonstration" "stations" "stations.advanced" "users.permissions" "users.block" "users.credits" "transactions" "developer" "emails.newsletters" "emails.transactional" "emails.templates" "users.support" "trips" "stocks.vehicles" "stocks.manage" "vehicles.manage" "notifications" "offers" "long.term.rentals" "vehicles.alerts" "terms.of.use" "organizations" "users.badges" "virtual.parking" "app.debug" "roles" "feature.beta" "faq" "app.label"

The list of permissions to add to the role.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "perms": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update role

Update the permissions associated to a role.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Role key and permissions to change.

key
required
string [ 3 .. 50 ] characters

The key of the role to update.

perms_to_add
required
Array of strings (Permission) unique
Items Enum: "networks.manage" "vehicles.register" "maintenances" "unlock.admin" "networks.show.private" "dashboard.access" "users.list" "demonstration" "stations" "stations.advanced" "users.permissions" "users.block" "users.credits" "transactions" "developer" "emails.newsletters" "emails.transactional" "emails.templates" "users.support" "trips" "stocks.vehicles" "stocks.manage" "vehicles.manage" "notifications" "offers" "long.term.rentals" "vehicles.alerts" "terms.of.use" "organizations" "users.badges" "virtual.parking" "app.debug" "roles" "feature.beta" "faq" "app.label"

The list of permissions to add to the role.

perms_to_remove
required
Array of strings (Permission) unique
Items Enum: "networks.manage" "vehicles.register" "maintenances" "unlock.admin" "networks.show.private" "dashboard.access" "users.list" "demonstration" "stations" "stations.advanced" "users.permissions" "users.block" "users.credits" "transactions" "developer" "emails.newsletters" "emails.transactional" "emails.templates" "users.support" "trips" "stocks.vehicles" "stocks.manage" "vehicles.manage" "notifications" "offers" "long.term.rentals" "vehicles.alerts" "terms.of.use" "organizations" "users.badges" "virtual.parking" "app.debug" "roles" "feature.beta" "faq" "app.label"

The list of permissions to remove from the role.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "perms_to_add": [
    ],
  • "perms_to_remove": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Geofencing

Get network border

Get the border of the specified network and the setting of the border

Authorizations:
(AuthenticatedPermissions)
query Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update border shape

Define a new shape for the border of the specified network.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Border shape parameters.

network_id
required
number >= 1

Identifier of the network

shape
required
Array of numbers >= 3 items [ items = 2 items [ items [ -180 .. 180 ] ] ]

New shape of the network's border which is a list of GPS coordinates.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1,
  • "shape": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update border settings

Update border's settings (action when a vehicle leave the limit) of the specified network.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Border setting parameters.

trigger_alert
required
boolean

Indicate if an alert should be created when a vehicle leave the limit of the network.

notify_user
required
boolean

Indicate if the user should receive a push notification when he leave the limit of the network while renting a vehicle.

reduce_vehicle_speed
required
boolean

Indicate if the speed of the vehicle should be reduce to minimum when it leave the limit of the network.

play_vehicle_sound
required
boolean

Indicate if the vehicle should play the geofencing sound when it leave the limit of the network.

lock_vehicle
required
boolean

Indicate if the vehicle should be locked when it leave the limit of the network.

network_id
required
number >= 1

Identifier of the network

Responses

Request samples

Content type
application/json
{
  • "trigger_alert": true,
  • "notify_user": true,
  • "reduce_vehicle_speed": true,
  • "play_vehicle_sound": true,
  • "lock_vehicle": true,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get speed zones

Get the list of available speed zone for the specified network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create speed zone

Create a new speed zone.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Speed zone create parameters.

network_id
required
integer >= 1

Identifier of the network.

shape
required
Array of numbers[ items[ items [ -180 .. 180 ] ] ]

Shape of this speed zone as a list of points making a polygon.

max_speed
required
integer [ 6 .. 25 ]

Max speed authorized.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1,
  • "shape": [
    ],
  • "max_speed": 6
}

Response samples

Content type
application/json
{
  • "code": 0
}

Update speed zone

Update the speed zone.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Speed zone update parameters.

speed_zone_id
required
integer >= 1

Identifier of the speed zone.

shape
Array of numbers[ items[ items [ -180 .. 180 ] ] ]

Shape of this speed zone as a list of points making a polygon.

max_speed
integer [ 6 .. 25 ]

Max speed authorized.

Responses

Request samples

Content type
application/json
{
  • "speed_zone_id": 1,
  • "shape": [
    ],
  • "max_speed": 6
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete speed zone

Add a deletion date to the speed zone.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the speed zone.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get virtual parking

Get the list of virtual parking for the specified network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
network_id
required
integer >= 1

Identifier of the network.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create virtual parking

Create a new virtual parking (not attached to a cluster).

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Parking create parameters.

shape
required
Array of numbers[ items >= 3 items [ items = 2 items [ -180 .. 180 ] ] ]

Shape of virtual parking as a list of points making a polygon.

capacity
required
integer >= 0

How many vehicle can be parked.

network_id
required
integer or null >= 1

Identifier of the network to whom the parking lot will belong.

Responses

Request samples

Content type
application/json
{
  • "shape": [
    ],
  • "capacity": 0,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update virtual parking

Update the virtual parking.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the virtual parking.

Request Body schema: application/json
required

Parking update parameters.

shape
required
Array of numbers[ items >= 3 items [ items = 2 items [ -180 .. 180 ] ] ]

Shape of virtual parking as a list of points making a polygon.

capacity
required
integer >= 0

How many vehicle can be parked.

Responses

Request samples

Content type
application/json
{
  • "shape": [
    ],
  • "capacity": 0
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete virtual parking

Delete the specified virtual parking.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the virtual parking.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Stations

Decommission station

Decommission a station.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the station.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get energy consumption

Return the energy consumption of the station in the specified range.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the station.

query Parameters
start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Stocks

Get stocks

Fetch the list of stocks address for the specific network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the stocks.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create stock

Create a new stock address where vehicles can be stored.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

New address data.

name
required
string [ 4 .. 128 ] characters

The name of the new address.

country
required
integer >= 1

The identifier of the country of the new address.

city
required
string [ 1 .. 128 ]

The name of the city of the new address.

zipcode
required
string [ 1 .. 16 ]

The zipcode of the new address.

street
required
string [ 1 .. 128 ]

The street number and name of the new address.

Responses

Request samples

Content type
application/json
{
  • "name": "My super stock",
  • "country": 1,
  • "city": "Strasbourg",
  • "zipcode": "67000",
  • "street": "45 example street"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete stock

Remove the specified stock address.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the stock address.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get stocks vehicles

Fetch the list of vehicles stored in the specified stock address.

Authorizations:
(AuthenticatedPermissions)
query Parameters
stocks
required
Array of integers[ items >= 1 ]
Examples:
  • stocks=5 - With one stocks id.
  • stocks=1,5,7 - With multiple stocks id.

Identifier of stocks of which to get the content.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Update stock shape

Define a new shape for the auto stock feature for the specified stock.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Auto stock shape parameters.

stock_id
required
number >= 1

Identifier of the stock.

shape
required
Array of numbers >= 3 items [ items = 2 items [ items [ -180 .. 180 ] ] ]

New shape of the network's border which is a list of GPS coordinates.

Responses

Request samples

Content type
application/json
{
  • "stock_id": 1,
  • "shape": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0
}

Subscriptions

Get subscriptions

Returns subscriptions of the specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the subscriptions.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create a subscription

Create a new subscription.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info of the subscription to create.

name
required
string [ 1 .. 50 ] characters

Display name for this subscription.

trip_duration
required
integer >= 1

The duration in seconds that the subscription cover for each trip that it applies to.

trip_waiting_period
required
integer or null >= 1

The duration in seconds that the user needs to wait after having finished a trip that the subscription was used for, if a trip is started before the duration elapsed the new trip will be fully charged.

organization_only
required
boolean

Whether or not this subscription can only be used by organization members.

network_id
required
integer >= 1

Identifier of the network on which the subscription can be used.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "trip_duration": 1,
  • "trip_waiting_period": 1,
  • "organization_only": true,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get subscriptions discounts

Returns subscription discounts of the specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the subscriptions discounts.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create a subscription discount

Create a new subscription discount.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info of the subscription discount to create.

percent_off
required
number [ 1 .. 100 ]

The percentage of the discount.

duration
required
string
Enum: "once" "repeating" "forever"

The duration during which the discount is applied on a subscription.

  • once: the discount is applied on the first bill of the subscription.
  • repeating: the discount is applied until the number of months given in the duration_in_months variable is reached.
  • forever: the discount is applied on every bill of the subscription.
duration_in_months
required
integer or null >= 0

The duration of the discount in months. This is not null only when the property duration is repeating.

network_id
required
integer >= 1

The identifier of the network on which this discount is usable.

Responses

Request samples

Content type
application/json
{
  • "percent_off": 1,
  • "duration": "once",
  • "duration_in_months": 0,
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete subscription discount

Delete a subscription discount.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription discount.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update subscription

Update a subscription.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

Request Body schema: application/json
required

Info of the subscription to create.

name
string [ 1 .. 50 ] characters

Display name for this subscription.

trip_duration
integer >= 1

The duration in seconds that the subscription cover for each trip that it applies to.

trip_waiting_period
integer or null >= 1

The duration in seconds that the user needs to wait after having finished a trip that the subscription was used for, if a trip is started before the duration elapsed the new trip will be fully charged.

organization_only
boolean

Whether or not this subscription can only be used by organization members.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "trip_duration": 1,
  • "trip_waiting_period": 1,
  • "organization_only": true
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete subscription

Delete a subscription.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get subscription prices

Get the different price of a subscription.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create subscription price

Create a new price for a subscription.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

Request Body schema: application/json
required

Info of the subscription price to create.

price
required
number >= 0

The amount of the subscription price.

interval_type
required
string
Enum: "day" "week" "month" "year"

The type of interval used for this price.

interval_count
required
integer [ 1 .. 365 ]

How many interval_type are between each renewal.

free_credits
required
number or null >= 0.001

The amount given as a gift to the user on his wallet.

available
required
boolean

Whether or not this price is available for the end users.

Responses

Request samples

Content type
application/json
{
  • "price": 0,
  • "interval_type": "day",
  • "interval_count": 1,
  • "free_credits": 0.001,
  • "available": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Update subscription price

Update a subscription price.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

price_id
required
integer >= 1

The identifier of the subscription price.

Request Body schema: application/json
required

Info of the subscription price to update.

available
boolean

Whether or not this price is visible to user.

free_credits
number or null >= 0.001

The amount given as a gift to the user on his wallet.

Responses

Request samples

Content type
application/json
{
  • "available": true,
  • "free_credits": 0.001
}

Response samples

Content type
application/json
{
  • "code": 0
}

Delete subscription price

Delete a subscription price.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the subscription.

price_id
required
integer >= 1

The identifier of the subscription price.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

TermsOfUse

Get terms of use

Get the terms of use for the given app label, network or organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
type
required
string
Enum: "app_label" "network" "organization"

The type of object targeted by the terms of use.

type_id
required
integer >= 1

The identifier of the object of the type given by the type parameter, targeted by the terms of use.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create terms of use

Create a new terms of use for the given app label, network or organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
type
required
string
Enum: "app_label" "network" "organization"

The type of object targeted by the terms of use.

type_id
required
integer >= 1

The identifier of the object of the type given by the type parameter, targeted by the terms of use.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Publish terms of use

Publish the terms of use by generating all pdfs and sending them to all concerned users.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get terms of use content

Get the terms of use content in the given language.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

lang
required
string^[a-zA-Z]{2}$

The language of the terms of use content.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Edit terms of use content

Create or update the terms of use content in the given language.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

lang
required
string^[a-zA-Z]{2}$

The language of the terms of use content.

Request Body schema: application/json
required

Info on the new terms of use content.

content
required
string

The text of the terms of use, formatted using markdown.

file_name
required
string [ 1 .. 64 ] characters

The name of the pdf file that will be sent to the users with the content given in the content property.

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "file_name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get terms of use attachments

Get the terms of use attachments of the given language.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

lang
required
string^[a-zA-Z]{2}$

The language of the terms of use attachment.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Add terms of use attachment

Upload an attachment for the terms of use of the given language.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

lang
required
string^[a-zA-Z]{2}$

The language of the terms of use attachment.

Request Body schema: application/json
required

Info on the new terms of use attachment.

attachment_name
required
string [ 1 .. 128 ] characters

The name of the attachment to create or delete.

attachment
required
string <binary>

Attachment file content.

Responses

Request samples

Content type
application/json
{
  • "attachment_name": "string",
  • "attachment": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete terms of use attachment

Delete an attachment of the terms of use of the given language.

Authorizations:
(AuthenticatedPermissions)
path Parameters
terms_of_use_id
required
integer >= 1

The identifier of the terms of use.

lang
required
string^[a-zA-Z]{2}$

The language of the terms of use attachment.

query Parameters
attachment_name
required
string [ 1 .. 128 ] characters

The name of the attachment to create or delete.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

ThirdParties

Get third-parties

Get the list of the third-parties already imported.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Create third-party

Create a third-party not linked to the ERP.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info about the third-party.

name
required
string [ 1 .. 255 ] characters

The third-party's name.

address
required
string [ 1 .. 512 ] characters

The third-party's address number and street.

zipcode
required
string [ 1 .. 10 ] characters

The third-party's address zip code.

city
required
string [ 1 .. 128 ] characters

The third-party's address city.

country_id
required
integer >= 1

The identifier of the country in which the third party is located.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "zipcode": "string",
  • "city": "string",
  • "country_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get third-parties from the ERP

Get the list of not imported third-parties from the ERP.

Authorizations:
(AuthenticatedPermissions)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Import third-party

Import a third-party from the ERP.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

Info about the third-party.

erp_id
required
integer >= 1

The ERP third-party's identifier.

Responses

Request samples

Content type
application/json
{
  • "erp_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Transactions

Get transactions

Return transactions made on specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get transactions.

primary_key_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the transaction identifier.

page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last transaction on the current page, used to request the next page.

sort_by
string
Enum: "date" "amount_w_vat" "amount" "product_title" "refund_amount" "auto_payment" "payment_provider_fee" "network_id"

Custom sort key.

sort_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the custom sort key.

transaction_id_min
integer >= 1

Filter the minimum transaction's identifier.

transaction_id_max
integer >= 1

Filter the maximum transaction's identifier.

date_min
string <date>

Filter the minimum transaction's date.

date_max
string <date>

Filter the maximum transaction's date.

amount_w_vat_min
number >= 0

Filter the minimum transaction's amount with VAT.

amount_w_vat_max
number >= 0

Filter the maximum transaction's amount with VAT.

amount_min
number >= 0

Filter the minimum transaction's amount without VAT.

amount_max
number >= 0

Filter the maximum transaction's amount without VAT.

user_id
integer >= 1

Filter by the user's identifier who made the transaction.

email
string non-empty

Filter by the user's email who made the transaction (partial match search).

product_title
string [ 1 .. 100 ] characters

Filter by the transaction's product title (partial match search).

refunded
boolean

Filter refunded state.

refund_date_min
string <date>

Filter the minimum transaction's refund date.

refund_date_max
string <date>

Filter the maximum transaction's refund date.

auto_payment
boolean

Filter auto-payment.

payment_provider_fee_min
number >= 0

Filter by the minimum transaction's provider fee amount.

payment_provider_fee_max
integer >= 0

Filter by the maximum transaction's provider fee amount.

payment_provider
string [ 1 .. 20 ] characters

Filter by the transaction's payment method provider (partial match search).

payment_method_type
string [ 1 .. 20 ] characters

Filter by the transaction's payment method type (partial match search).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ],
  • "total": 0
}

Get transaction detail

Return details of the specified transaction.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the transaction.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get transaction invoice

Returns the invoice for a transaction.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The transaction's identifier.

Responses

Response samples

Content type
application/json
Example
{
  • "code": 3
}

Refund transaction

Refund the specified transaction.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the transaction.

Request Body schema: application/json
required

Data of the refund.

reason
required
string [ 10 .. 2048 ] characters

The reason to refund this transaction.

amount
required
number >= 0

The amount to refund. Cannot be greater than the amount of the transaction.

Responses

Request samples

Content type
application/json
{
  • "reason": "stringstri",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get income summary

Return income summary of the requested period, in the requested currency.

Authorizations:
(AuthenticatedPermissions)
query Parameters
start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

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 currency in which to convert the amounts.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

provider
string (PaymentProvider)
Enum: "stripe" "uzcard" "braintree" "hdcpay"

The name of the payment provider to use as a filter. Not giving this parameters returns stats for all providers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get income sources

Return income sources of the requested period, in the requested currency.

Authorizations:
(AuthenticatedPermissions)
query Parameters
start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

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 currency in which to convert the amounts.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

provider
string (PaymentProvider)
Enum: "stripe" "uzcard" "braintree" "hdcpay"

The name of the payment provider to use as a filter. Not giving this parameters returns stats for all providers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get income distribution by dow

Return income distribution by day of the week of the requested period, in the requested currency.

Authorizations:
(AuthenticatedPermissions)
query Parameters
start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

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 currency in which to convert the amounts.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

provider
string (PaymentProvider)
Enum: "stripe" "uzcard" "braintree" "hdcpay"

The name of the payment provider to use as a filter. Not giving this parameters returns stats for all providers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get income details by day

Return income details by day of the requested period, in the requested currency.

Authorizations:
(AuthenticatedPermissions)
query Parameters
start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

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 currency in which to convert the amounts.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

provider
string (PaymentProvider)
Enum: "stripe" "uzcard" "braintree" "hdcpay"

The name of the payment provider to use as a filter. Not giving this parameters returns stats for all providers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Trips

Get trips

Return trips made on specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

primary_key_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the trip identifier.

page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last trip on the current page, used to request the next page.

sort_by
string
Enum: "start_date" "end_date" "duration" "distance"

Custom sort key.

sort_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the custom sort key.

state
Array of strings
Items Enum: "finished" "running" "on-hold" "cancelled"
Examples:
  • state=finished - With one state
  • state=running,on-hold - With multiple state

States of the trip to show.

start_date_min
string <datetime>

The minimum start date of trips to show.

start_date_max
string <datetime>

The maximum start date of trips to show.

end_date_min
string <datetime>

The minimum end date of trips to show.

end_date_max
string <datetime>

The maximum end date of trips to show.

trip_id_min
integer >= 1

The minimum trip id to show.

trip_id_max
integer >= 1

The maximum trip id to show.

serial_number
string [ 1 .. 10 ] characters

Filter by serial number of the rented vehicle.

model_name
string [ 1 .. 20 ] characters

Filter by model of the rented vehicle.

demo
boolean

Whether to show only demonstration or non-demonstration trips.

email
string

What the user email should contains.

user_id
integer >= 1

The identifier of the user to get trips of.

cluster_start_name
string [ 1 .. 50 ] characters

What the name of the starting cluster should contains.

cluster_start_id
integer >= 1

The identifier of the starting cluster of trips to get.

cluster_end_name
string [ 1 .. 50 ] characters

What the name of the ending cluster should contains.

cluster_end_id
integer >= 1

The identifier of the ending cluster of trips to get.

duration_min
integer >= 0

Minimum duration of trips to get (in seconds).

duration_max
integer >= 0

Maximum duration of trips to get (in seconds).

distance_min
integer >= 0

Minimum traveled distance of trips to get (in meters).

distance_max
integer >= 0

Maximum traveled distance of trips to get (in meters).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ],
  • "total": 0
}

Get trip detail

Return the detail of a trip.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of trip to get the detail of.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Stop trip billing

Set the trip billing stop date, do not set a date to erase a previous stop date.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of trip to get the detail of.

Request Body schema: application/json
required

Date to set.

date
required
string or null <date-time>

The date at which to stop the billing.

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0
}

UsageStats

Get usage stats

Return number of trips and unique users grouped by day, week, month or quarter (depending on the period between the requested dates).

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get usage stats summary

Return usage stats (total trips, unique users, rented vehicle ; total, average, median and max distance of trips ; total, average median and max duration of trips) in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get trips by dow

Return number of trips by day of the week in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get trips by time of day

Return number of trips by time of day in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get trip distance distribution

Return number of trips by range of distance and payment mode in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get trip duration distribution

Return number of trips by range of duration and payment mode in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get station distribution

Return number of started / ended for each station in the requested period.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

start_date
required
string <date>

The start date of the period.

end_date
required
string <date>

The end date of the period. Should be after the start_date.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

organizations
Array of integers[ items >= 1 ]
Examples:
  • organizations=5 - With one organization id
  • organizations=1,5,7 - With multiple organizations ids
  • organizations=null - Without organization only

Filter by identifier of organizations of which to get trips. Set to 'null' to get trips from user without organization. Ignore to get trips from all users.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get usage stats organizations

Return the list of organizations present on the requested networks for which the user has permission.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get trips.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Users

Get users

Return users of specified networks. A user belongs to a network from the moment he interacts with (consult offers, make a trip).

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id
  • networks=1,5,7 - With multiple networks ids

Identifier of networks of which to get users.

primary_key_dir
string
Default: "DESC"
Enum: "ASC" "DESC"

Sort direction of the user identifier.

page_size
integer [ 10 .. 500 ]
Default: 20

The maximum items to return.

last_primary_key
integer >= 1

Identifier of the last user on the current page, used to request the next page.

sort_by
string
Enum: "register_at" "last_activity" "trip_count"

Custom sort key.

user_id_min
integer >= 1

Filter the minimum user's identifier.

user_id_max
integer >= 1

Filter the maximum user's identifier.

email
string >= 1

Filter by email.

lastname
string [ 1 .. 50 ]

Filter by last name.

firstname
string [ 1 .. 50 ]

Filter by first name

register_at_min
string <datetime>

Filter the minimum register date.

register_at_max
string <datetime>

Filter the maximum register date.

last_activity_min
string <datetime>

Filter the minimum last activity date.

last_activity_max
string <datetime>

Filter the maximum last activity date.

organization_name
string [ 1 .. 255 ]

Filter by organization name

blocked
boolean

Filter by user's blocked

trip_count_min
number >= 0

Filter the minimum trip .

trip_count_max
number >= 0

Filter the maximum trip.

label_name
string [ 1 .. 20 ]

Filter by label name.

phone_number
string [ 1 .. 20 ]

Filter by phone number.

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 currency in which to convert the amounts.

timezone
required
string (Timezone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Choibalsan" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

The timezone of the user making the request.

without_network
required
boolean

Show users that hasn't interact with any networks for the moment.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ],
  • "total": 0
}

Get user badges

Get the badges of the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get blocked information

Return the user who has block given user and since when he is blocked.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Block user

Block the specified user with the given reason.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Block user parameters.

reason
required
string [ 3 .. 1000 ] characters

Reason to block the user.

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Unblock user

Unblock the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get user devices

Get the devices of the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Send message to user

Send a message to the specified user

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json

Message data.

message
required
string [ 3 .. 1000 ] characters

Content of the message to send to the user.

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get user passes

Return all passes assigned to a user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get user payment methods.

Get payment providers and associated payment methods of the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Delete user payment method.

Delete the specified payment method of the user. If the default payment method is deleted, a new default payment method is selected automatically.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

user_method_id
required
integer >= 1

Identifier of the user payment method.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get user permission.

Get the list of permissions granted to the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Add user permission

Grant a permission to the specified user. If the user already has the permission but with a different end date, it will be overwritten. Granter needs to have the permission he want to grant.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Permission data.

start_date
required
string <date-time>

Start date of the permission / role.

end_date
required
string or null <date-time>

When the permission / role will expire. Null to grant forever.

organizational_unit
required
integer or null >= 1

The identifier of the organizational unit to which to give the permission. Can be null for global permission.

write
required
boolean

Grant the permission with write modifier.

perm_key
required
string
Enum: "networks.manage" "vehicles.register" "maintenances" "unlock.admin" "networks.show.private" "dashboard.access" "users.list" "demonstration" "stations" "stations.advanced" "users.permissions" "users.block" "users.credits" "transactions" "developer" "emails.newsletters" "emails.transactional" "emails.templates" "users.support" "trips" "stocks.vehicles" "stocks.manage" "vehicles.manage" "notifications" "offers" "long.term.rentals" "vehicles.alerts" "terms.of.use" "organizations" "users.badges" "virtual.parking" "app.debug" "roles" "feature.beta" "faq" "app.label"

The key of the permission to give.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "organizational_unit": 1,
  • "write": true,
  • "perm_key": "networks.manage"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Remove user permission

Revoke a permission from the specified user. The user needs to have the permission he want to revoke.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
perm_key
required
string (Permission)
Enum: "networks.manage" "vehicles.register" "maintenances" "unlock.admin" "networks.show.private" "dashboard.access" "users.list" "demonstration" "stations" "stations.advanced" "users.permissions" "users.block" "users.credits" "transactions" "developer" "emails.newsletters" "emails.transactional" "emails.templates" "users.support" "trips" "stocks.vehicles" "stocks.manage" "vehicles.manage" "notifications" "offers" "long.term.rentals" "vehicles.alerts" "terms.of.use" "organizations" "users.badges" "virtual.parking" "app.debug" "roles" "feature.beta" "faq" "app.label"

The key of the permission to revoke.

organizational_unit
integer >= 1

The identifier of the organizational unit. Omit to revoke a global permission.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get user profile

Get the profile of the specified user

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get the user report

Get the user report of a specific user

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Add user role

Grant a role to the specified user. If the user already has the role but with a different end date, it will be overwritten. Granter needs to have the role he want to grant, or all permission of the role.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Role data.

start_date
required
string <date-time>

Start date of the permission / role.

end_date
required
string or null <date-time>

When the permission / role will expire. Null to grant forever.

organizational_unit
required
integer or null >= 1

The identifier of the organizational unit to which to give the permission. Can be null for global permission.

write
required
boolean

Grant the permission with write modifier.

role_key
required
string [ 3 .. 50 ] characters

The key of the role.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "organizational_unit": 1,
  • "write": true,
  • "role_key": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}

Remove user role

Revoke a role from the specified user. The user needs to have the role he want to revoke, or all permission of the role.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
role_key
required
string [ 3 .. 50 ] characters

The key of the role to revoke.

organizational_unit
integer >= 1

The identifier of the organizational unit. Omit to revoke a global permission.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get user wallets

Return non-empty wallets for the specified user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The user's identifier of which to get wallets.

query Parameters
get_empty
boolean

Whether to get full or empty wallets.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Create user wallet

Create a wallet for the user given.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Informations to create a wallet.

amount
required
number >= 0.01

The amount to add.

currency
required
string
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"

The currency of the wallet amount.

reason
required
string [ 5 .. 1000 ] characters

Why this amount is added to the user wallet.

Responses

Request samples

Content type
application/json
{
  • "amount": 0.01,
  • "currency": "string",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Delete user wallet

Delete the specified wallet of a user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
wallet
required
integer >= 1

Identifier of the wallet.

reason
required
string [ 3 .. 1000 ] characters

Reason to delete the wallet.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get wallet sum.

Get the sum of all wallet of the specified user, converted to given currency.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The identifier of the wallet.

query Parameters
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

Currency code of the wallet money to convert to.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": 0.1
}

Get user bank guarantees

Get the list of usable or currently used bank guarantees of a user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

The user's identifier of which to get bank guarantees.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Toggle pre auth bank guarantee

Enable or disable pre auth bank guarantee for the user. He still need to have a valid payment method to start trips.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Toggle state.

disabled
required
boolean

Wether or not the pre auth guarantee are disabled for this user.

Responses

Request samples

Content type
application/json
{
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get user last actions

Get the last 10 actions (unlock request, trips, transactions) done by the user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
before_date
string <date-time>

The date of the oldest element that the client has, to get the elements coming before it.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Link to organization

Link a user to an organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Request Body schema: application/json
required

Informations to create a wallet.

organization
required
integer >= 1

The identifier of the organization to which the user will be linked.

force
boolean

True to unlink the current user's organization.

Responses

Request samples

Content type
application/json
{
  • "organization": 1,
  • "force": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Unlink user from organization

Unlink a user from its organization.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Search user

Search for user with a given email.

Authorizations:
(AuthenticatedPermissions)
query Parameters
email
required
string [ 3 .. 200 ] characters

Search value.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get user mails sent

Get the last 10 mails sent to the user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
before_date
string <date-time>

The date of the oldest element that the client has, to get the elements coming before it.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get user sent push notifications

Get the last 10 push notifications sent to the user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
before_date
string <date-time>

The date of the oldest element that the client has, to get the elements coming before it.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get user api requests

Get the api requests that the user made.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user.

query Parameters
offset
integer >= 0

The page number. Defaults to 0.

items
integer >= 1

The number of items to returns. Defaults to 20.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

UsersPasses

Delete user pass

Remove a pass from a user.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user pass.

query Parameters
refund
boolean

True if the pass is to be refunded to the user.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Disable user pass

Disable a Pass so that it can be activated again. Optionally reset its available time.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the user pass.

Request Body schema: application/json
optional

Reset user pass.

reset
boolean

True if the pass needs to be reset.

Responses

Request samples

Content type
application/json
{
  • "reset": true
}

Response samples

Content type
application/json
{
  • "code": 0
}

Vehicles

Get vehicles

Fetch the list of vehicles for the specific network.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the vehicles.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Generate vehicle QR code

Generate a QR code for the given vehicle serial number.

Authorizations:
Authenticated
query Parameters
serial
required
string/^[a-zA-Z0-9]{6,10}$/

Serial number to print on the QR code.

Responses

Response samples

Content type
application/json
{
  • "code": -39999999,
  • "message": {
    }
}

Get decommissioned vehicles

Fetch the list of decommissioned vehicles for specified networks.

Authorizations:
(AuthenticatedPermissions)
query Parameters
networks
required
Array of integers[ items >= 1 ]
Examples:
  • networks=5 - With one network id.
  • networks=1,5,7 - With multiple networks id.

Identifier of networks of which to get the decommissioned vehicles.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Generate vehicle QR code sheet

Generate sheet with QR codes for vehicles generated for the given parameters.

Authorizations:
Authenticated
query Parameters
prefix
required
string/^[A-Z][A-Z0-9]{0,6}$/

Prefix of the QR codes.

begin_id
required
integer >= 0

First id of the vehicle to generate, will be incremented for every QR code.

width_in_cm
required
number >= 0

Width of the sheet in centimeters.

height_in_cm
required
number >= 0

Height of the sheet in centimeters.

Responses

Response samples

Content type
application/json
{
  • "code": -39999999,
  • "message": {
    }
}

Get used serials

Return the list of used serial number from the given list.

Authorizations:
Authenticated
query Parameters
serials
required
Array of strings[ items >= 1 ]
Examples:
  • serials=SXB123 - With one serial number.
  • serials=SXB123,SXB234,SXB345 - With multiple serial numbers.

List of serial number to check.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get vehicle detail

Fetch the detail of the specified vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Decommission vehicle

Decommission a vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

query Parameters
reason
required
string
Enum: "lost-or-stolen" "sold" "irreparable" "economical"

Why the vehicle is decommissioned.

comment
string [ 1 .. 200 ] characters

Optional comment on decommission.

amount
number <float>

Optional amount when the vehicle is sold, or the cost (negative amount) when the vehicle is recycled. Currency is the currency of the last vehicle's network.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Get vehicle QR code

Generate the QR code for the given vehicle.

Authorizations:
Authenticated
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Responses

Response samples

Content type
application/json
Example
{
  • "code": -39999999,
  • "message": {
    }
}

Change vehicle network

Change the current network of a vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Request Body schema: application/json
required

Info about the network.

network_id
required
integer >= 1

Identifier of the new network for the vehicle.

Responses

Request samples

Content type
application/json
{
  • "network_id": 1
}

Response samples

Content type
application/json
{
  • "code": 0
}

Get vehicle statistic

Fetch the statistic of the specified vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Get vehicle timeline

Fetch the timeline (trip, parking, maintenance move) of the specified vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

query Parameters
before_date
string <date-time>

The date of the oldest element that the client has, to get the elements coming before it.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get vehicle maintenances

Route to get all maintenances (current and old one) of a vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

query Parameters
lang
required
string = 2 characters

The lang in which to get the maintenance types localized.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

Get vehicle alerts

Route to get current alerts of a vehicle.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": [
    ]
}

VehiclesExternalLocks

Register external lock

Register an external lock on the given vehicle.

Authorizations:
(AuthenticatedPermissions)
Request Body schema: application/json
required

The lock information.

vehicle_id
required
integer >= 1

The identifier of the vehicle on which the lock is installed.

model
required
string [ 1 .. 64 ] characters

The model of the lock.

type
required
string (VehicleExternalLockType)
Enum: "u" "foldable" "flexible" "chain" "frame"

The type of the lock

serial_number
required
string [ 1 .. 64 ] characters

The unique serial number of the lock.

code
required
string [ 1 .. 16 ] characters

The code to open the lock.

Responses

Request samples

Content type
application/json
{
  • "vehicle_id": 1,
  • "model": "string",
  • "type": "u",
  • "serial_number": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    }
}

Decommission lock

Decommission a vehicle external lock.

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Responses

Response samples

Content type
application/json
{
  • "code": 0
}

Update lock code

Change the access code of an external lock (still require a physical operation on the lock, this only change the displayed code in the application).

Authorizations:
(AuthenticatedPermissions)
path Parameters
id
required
integer >= 1

Identifier of the vehicle.

Request Body schema: application/json
required

The new code.

code
required
string [ 1 .. 16 ] characters

The new code.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": 0
}