VRt.Account
VEEROUTE 2024

VRt.Account [AC] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary Terms of Service
Main site

Description

Veeroute Account Panel.

Entity relationship diagram

erd

Auth

Authorization.

Obtaining a token

Obtaining a token using the login and password.

Request Body schema: application/json
required

Token request.

username
required
string (user_name) [ 2 .. 256 ] characters \w+

Login, unique identifier.

password
required
string [ 1 .. 1000 ] characters

Password.

ttl_seconds
integer<int32> [ 60 .. 31556926 ]
Default: 86400

Token validity time, in seconds.

Responses

Response Schema: application/json
string (token) [ 1 .. 1000 ] characters

Token.

Request samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "password": "password",
  • "ttl_seconds": 86400
}

Response samples

Content type
application/json
"jwt"

Validating a token

Validating a token.

Request Body schema: application/json
required

Token validate request.

string (token) [ 1 .. 1000 ] characters

Token.

Responses

Response Schema: application/json
valid
required
boolean
Default: false

Token status.

roles
Array of strings (user_roles) [ 0 .. 2 ] items unique
Items Enum: "ADMIN" "PARTNER" "USER" … 1 more

List of user roles.

Request samples

Content type
application/json
"jwt"

Response samples

Content type
application/json
{
  • "valid": true,
  • "roles": [ ]
}

Change password

Change password and get new token.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional

Password change request data.

current_password
required
string [ 1 .. 1000 ] characters

Current Password.

new_password
required
string [ 1 .. 1000 ] characters

New Password.

Responses

Response Schema: application/json
string (token) [ 1 .. 1000 ] characters

Token.

Request samples

Content type
application/json
{
  • "current_password": "password",
  • "new_password": "password"
}

Response samples

Content type
application/json
"jwt"

Info

Account information.

Account information

Getting a account information.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
username
required
string (user_name) [ 2 .. 256 ] characters \w+

Login, unique identifier.

name
string or null [ 2 .. 256 ] characters
Default: null

Full name of user.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

User mail address.

phone
string or null [ 5 .. 32 ] characters
Default: null

User phone.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+

Company key.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Basic time zone used for statistics.

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "timezone": 3
}

Account update

Updating the account information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Account update request.

username
required
string (user_name) [ 2 .. 256 ] characters \w+

Login, unique identifier.

name
string or null [ 2 .. 256 ] characters
Default: null

Full name of user.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

User mail address.

phone
string or null [ 5 .. 32 ] characters
Default: null

User phone.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+

Company key.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Basic time zone used for statistics.

Responses

Response Schema: application/json
username
required
string (user_name) [ 2 .. 256 ] characters \w+

Login, unique identifier.

name
string or null [ 2 .. 256 ] characters
Default: null

Full name of user.

email
string or null<email> [ 5 .. 256 ] characters
Default: null

User mail address.

phone
string or null [ 5 .. 32 ] characters
Default: null

User phone.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+

Company key.

timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Basic time zone used for statistics.

Request samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "timezone": 3
}

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "name": "my_visible_name",
  • "email": "admin@company.com",
  • "phone": "+71112223333",
  • "company_key": "my_company",
  • "timezone": 3
}

Statistics

Statistics.

Statistics for the period

User statistics for the period. If the period is not specified, the statistics for the current month returns (from the beginning of the month to the present day). If no 'from' datetime is specified, data are returned from the beginning of the month. If no 'to' datetime is specified, data are returned be to the present day (excluding).

Authorizations:
ApiKeyAuth
query Parameters
from
string<date>
Example: from=2024-02-22

Date 'from' in the YYYY-MM-DD format.

to
string<date>
Example: to=2024-02-22

Date 'to' in the YYYY-MM-DD format.

Responses

Response Schema: application/json
username
required
string (user_name) [ 2 .. 256 ] characters \w+

Login, unique identifier.

required
Array of objects (date_statistics) [ 0 .. 3653 ] items

Statistics list for each day for the specified user.

Response samples

Content type
application/json
{
  • "username": "my_username_for_login",
  • "dates": [
    ]
}

Report creating

Creating report with usage statistics. If the period is not specified, records are returned from the beginning of the month to the present day (excluding). If no 'from' datetime is specified, data are returned from the beginning of the month. If no 'to' datetime is specified, data are returned be the the present day (excluding).

Authorizations:
ApiKeyAuth
query Parameters
from
string<date>
Example: from=2024-02-22

Date 'from' in the YYYY-MM-DD format.

to
string<date>
Example: to=2024-02-22

Date 'to' in the YYYY-MM-DD format.

Responses

Response Schema: application/octet-stream
string<byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Audit

User actions.

Actions for the period

User actions for the period. If the period is not specified, records for the current day are returned from the beginning of the day to the current time. If no 'from' datetime is specified, audit data are returned from the beginning of the day. If no 'to' datetime is specified, audit data are returned be the end of the current day.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

The number of items to return.

from
string<date-time>
Example: from=2024-02-21T09:30:00+03:00

Date and time in the ISO 8601 format. If no datetime is specified, audit data are returned from the beginning of the day.

to
string<date-time>
Example: to=2024-02-21T18:00:00+03:00

Date and time in the ISO 8601 format. If not specified, data up to the current time is returned.

service_name
string (service_name)
Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 9 more
Example: service_name=UNIVERSAL

Service name.

operation_id
string (operation_id) [ 3 .. 256 ] characters
Example: operation_id=run_plan_calculation

Operation identifier.

method_group
string (method_group)
Enum: "NOTRACE" "TRACE" "PLAN" … 9 more
Example: method_group=PLAN

Method group name.

sort_field
string [ 1 .. 64 ] characters
Example: sort_field=name

Field to sort by.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
Array of objects (audit_action) [ 0 .. 10000000 ] items

User actions list.

required
object (audit_stats)

Statistics by records list.

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "statistics": {
    }
}

Data

User data.

Reading input data

Receiving an incoming request by tracecode.

Authorizations:
ApiKeyAuth
path Parameters
tracecode
required
string<uuid>
Example: 11111111-2222-3333-4444-555555555555

Unique process identifier.

query Parameters
data_flow_type
string (flow_type)
Default: "INPUT"
Enum: "INPUT" "OUTPUT"
Example: data_flow_type=OUTPUT

Data flow type.

data_flow_stage
integer<int32> [ 0 .. 3 ]
Default: 0
Example: data_flow_stage=1

Data flow stage.

data_flow_convert
string (flow_convert)
Deprecated
Default: "ORIGIN"
Enum: "ORIGIN" "JSON" "XLSX"
Example: data_flow_convert=JSON

Data result convert.

Responses

Response Schema: application/octet-stream
string<byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "Bad Request"
}

Quotas

Quotas.

Obtaining the quotas

Obtaining the quotas for the user.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
required
object (quota_base)

All services quota.

Response samples

Content type
application/json
{
  • "base": {
    }
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json
health
required
number<double> [ 0 .. 1 ]

Current health.

Response samples

Content type
application/json
{
  • "health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json
major
required
integer<int32> [ 1 .. 100 ]

Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).

minor
required
integer<int32> [ 0 .. 111 ]

Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.

build
required
string [ 1 .. 64 ] characters

Build version.
Contains backwards compatible bug fixes and docs update.

Response samples

Content type
application/json
{
  • "major": 4,
  • "minor": 4,
  • "build": "1754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters
filename
required
string [ 6 .. 128 ] characters
Example: file_en.html

File name.

Responses

Response Schema:
string (file_html)

File with data in HTML format.

Response samples

Content type
application/json
{
  • "resource_id": "resource_id",
  • "detail": {
    }
}