ParkingDriveWeb
by ParkingDrive

ParkingDriveWeb

Получить клиента приложения по номеру телефона
POST /control/api/v1/clients/phone

Request body

Object
phone
string

номер телефона

Example:
79991234567

Responses

200 OK
Body
Object
data
Object
person
Object nullable
id
string

идентификатор

Example:
sdfvservs-ervewrvwe
name
string

Имя

Example:
Иванов Иван
phone
string

Номер телефона

Example:
79991234567
message
string nullable

сообщение

Example:
Клиент с данным номером телефона не найден
Авторизация

Authentication/Authorization routes for the admin panel

Вход в админ панель
POST /control/api/v1/auth
Обновление токена доступа
POST /control/api/v1/auth/refresh
Выход из профиля
DELETE /control/api/v1/auth/logout
Вход в админ панель
POST /control/api/v1/auth

Вход в аккаунт сотрудника

Request body

Object
login
string required

Логин пользователя

Min length: 6
Example:
admin
password
string password required

Пароль пользователя

Min length: 6
Pattern: (?=.*[0-9])(?=.*[!@#$%^&*])(?=.*[a-z])(?=.*[A-Z])[0-9a-zA-Z!@#$%^&*]{6,}
Example:
admin

Responses

200 OK
Body
Object
data
Object
accessToken
string
refreshToken
string
accessTokenExpiresAt
number
refreshTokenExpiresAt
string
profile
Employee
Обновление токена доступа
POST /control/api/v1/auth/refresh

Request headers

Authorization
string optional

JWT Token

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHByIjoxNzA3NzM5NjMzLCJzdWIiOiJlNTBkMmU5OC1lMTlmLTQ1NjktODM5Mi01ZGQ0ZGJiM2FjYTYifQ.N4emfZzh9p6NaI-D0n_XZrdi3R2irVu51sd4CC70sKg

Responses

200 OK
Body
Object
data
Object
accessToken
string
refreshToken
string
accessTokenExpiresAt
number
refreshTokenExpiresAt
string
Выход из профиля
DELETE /control/api/v1/auth/logout

Request headers

Authorization
string optional

JWT Token

Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHByIjoxNzA3NzM5NjMzLCJzdWIiOiJlNTBkMmU5OC1lMTlmLTQ1NjktODM5Mi01ZGQ0ZGJiM2FjYTYifQ.N4emfZzh9p6NaI-D0n_XZrdi3R2irVu51sd4CC70sKg

Responses

204 No Content
Парковки
Добавить / изменить идентификатор устройства в шлагбаум
POST /control/api/v1/parkings/{parkingId}/transits/{transitId}
Добавить парковку
POST /control/v1/api/parking
Получить список парковок
POST /control/api/v1/parkings
Получить детальную информацию по парковке
GET /control/api/v1/parkings/{id}
Изменить статус парковки
PATCH /control/api/v1/parkings/{id}/status
Проверить JOG устройства
POST /control/api/v1/barriers/check
Добавить / изменить идентификатор устройства в шлагбаум
POST /control/api/v1/parkings/{parkingId}/transits/{transitId}

Path variables

parkingId
string required
transitId
string required

Request body

Object
deviceIds
Array of string

идентификаторы устройства

barrierId
string

Responses

200 OK
Body
Object
data
Parking
Добавить парковку
POST /control/v1/api/parking

Request body

ParkingPayload

Responses

200 OK
Body
Object
data
ParkingListItem
Example 1
POST /path HTTP/1.1 

Content-Type: application/json

{
    "cityId": "dfdtrretber",
    "name": "",
    "address": "",
    "location": {
        "lat": 34.234234,
        "long": 52.12323
    },
    "polygonPoints": [
        {
            "lat": 34.234234,
            "long": 52.12323
        }
    ],
    "info": "",
    "schedule": [
        {
            "id": 1,
            "workingHours": {
                "openingTime": "24:00",
                "closingTime": "24:00"
            }
        }
    ],
    "rates": {
        "freeTimeInMins": "10",
        "freeExitTimeInMins": 15,
        "conditions": [
            {
                "timeInMins": "60",
                "price": 200
            }
        ]
    },
    "transits": [
        {
            "name": "Северный",
            "location": {
                "lat": 34.234234,
                "long": 52.12323
            },
            "arrowDegree": 270,
            "type": "EXIT",
            "barriers": [
                {
                    "number": 1
                }
            ]
        }
    ],
    "rent": {
        "price": "5000",
        "info": "парковка не несет отвестенности за ТС оставленное ....."
    }
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "sdfvwer-vwervwer",
        "name": "Моремолл",
        "address": "ул. Новая Заря 3",
        "status": "ACTIVE",
        "clientName": "ООО Рога и Копыта"
    }
}
show more
Получить список парковок
POST /control/api/v1/parkings

Request body

Object
limit
string

лимит

Example:
50
offset
string

смещение

Example:
50
query
string nullable

поисковой запрос

cityId
string nullable

идентификатор города

Example:
sdfvwerv

Responses

200 OK
Body
Object
data
Object
list
Array of ParkingListItem
Example 1
POST /path HTTP/1.1 

Content-Type: application/json

{
    "limit": "50",
    "offset": "50",
    "query": "",
    "cityId": "sdfvwerv"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "list": [
            {
                "id": "sdfvwer-vwervwer",
                "name": "Моремолл",
                "address": "ул. Новая Заря 3",
                "status": "ACTIVE",
                "clientName": "ООО Рога и Копыта"
            }
        ]
    }
}
Получить детальную информацию по парковке
GET /control/api/v1/parkings/{id}

Path variables

id
string required

id парковки

Responses

200 OK
Body
Object
data
Object
parking
Parking

парковка

client
Client

клиент

city
City
Example 1
GET /control/api/v1/parkings/{id} HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "parking": {
            "id": "",
            "creatingDate": "",
            "name": "",
            "address": "",
            "schedule": [
                {
                    "id": 1,
                    "workingHours": {
                        "openingTime": "24:00",
                        "closingTime": "24:00"
                    }
                }
            ],
            "location": {
                "lat": 34.234234,
                "lon": 52.12323
            },
            "polygonPoints": [
                {
                    "lat": 34.234234,
                    "lon": 52.12323
                }
            ],
            "info": "",
            "rates": {
                "freeTimeInMins": "10",
                "freeExitTimeInMins": "15",
                "conditions": [
                    {
                        "timeInMins": "",
                        "price": ""
                    }
                ]
            },
            "rent": {
                "price": "5000",
                "info": "",
                "isAvailable": "false"
            },
            "transits": [
                {
                    "name": "Северный",
                    "location": {
                        "lat": 34.234234,
                        "lon": 52.12323
                    },
                    "arrowDegree": 270,
                    "type": "ONE",
                    "barriers": [
                        {
                            "id": "",
                            "number": 1,
                            "deviceId": ""
                        }
                    ]
                }
            ],
            "status": "WIP_BARRIERS",
            "city": {
                "id": "sdfvser-wervw",
                "name": "Москва",
                "countryId": "v4wervwer-v23rv23rwevr"
            }
        },
        "client": {
            "id": "servwervwer-23vr23rverv",
            "fullName": "ООО \"Рога и Копыта\"",
            "shortName": "ООО \"\"РиК\"",
            "legalAddress": "354000 г. Сочи, ул. Воровского 35",
            "actualAddress": "354000 г. Сочи, ул. Воровского 35",
            "phone": "89999999999",
            "email": "roga@kopita.pro",
            "inn": "12312312312",
            "kpp": "12312314324",
            "ogrn": "123123123",
            "requisites": {
                "clientName": "ООО \"Рога и Копыта\"",
                "inn": "123123123",
                "accountNumber": "234234234",
                "bankName": "Банк номер 1",
                "bik": "1231241325",
                "kpp": "234234234",
                "correspondentAccount": "235345345345"
            },
            "parkings": [
                {
                    "id": "sdfvwerv023rv23vr-wervwerv",
                    "name": "Моремолл",
                    "address": "ул. Воровского 45"
                }
            ]
        },
        "city": {
            "id": "sdfvser-wervw",
            "name": "Москва",
            "countryId": "v4wervwer-v23rv23rwevr"
        }
    }
}
show more
Изменить статус парковки
PATCH /control/api/v1/parkings/{id}/status

Менеджер - может перевести в статус NEW / WAITING_DEVICES Технический инженер может переводить в статус WAITING_DEVICES / WIP_DEVICES / RDY_DEVICES Администратор может перевести в любой статус, но по факту основное - в статус INACTIVE / ACTIVE

Path variables

id
string required

Request body

Object
status
ParkingStatus

Responses

200 OK
Body
Object
data
Parking
Example 1
POST /path HTTP/1.1 

Content-Type: application/json

{
    "status": "WAITING_BARRIES"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "",
        "creatingDate": "",
        "name": "",
        "address": "",
        "schedule": [
            {
                "id": 1,
                "workingHours": {
                    "openingTime": "24:00",
                    "closingTime": "24:00"
                }
            }
        ],
        "location": {
            "lat": 34.234234,
            "lon": 52.12323
        },
        "polygonPoints": [
            {
                "lat": 34.234234,
                "lon": 52.12323
            }
        ],
        "info": "",
        "rates": {
            "freeTimeInMins": "10",
            "freeExitTimeInMins": "15",
            "conditions": [
                {
                    "timeInMins": "",
                    "price": ""
                }
            ]
        },
        "rent": {
            "price": "5000",
            "info": ""
        },
        "transits": [
            {
                "name": "Северный",
                "location": {
                    "lat": 34.234234,
                    "lon": 52.12323
                },
                "arrowDegree": 270,
                "type": "EXIT",
                "barriers": [
                    {
                        "number": 1,
                        "id": "",
                        "deviceId": ""
                    }
                ]
            }
        ],
        "status": "WAITING_BARRIES"
    }
}
show more
Проверить JOG устройства
POST /control/api/v1/barriers/check

Request body

Object
deviceId
string

идентификатор устройства

Example:
rdu-231234

Responses

204 No Content
Сотрудники
Получить сотрудников
GET /control/api/v1/employees
Получить сотрудника по id
GET /control/api/v1/employees/{id}
Удалить сотрудника
DELETE /control/api/v1/employees/{id}
Обновить сотрудника
PUT /control/api/v1/employees/{id}
Добавить сотрудника
POST /control/api/v1/employees
Получить сотрудников
GET /control/api/v1/employees

Authentication

Request parameters

limit
number optional

Limit of datas

offset
number optional

Offset of datas

query
string optional

Query by for login,phone_number, email, address, firstname, lastname, patronymic filter

cityId
string optional

идентификатор города

Example:
sdfvserv

Responses

200 OK
Body
Object
data
Object
list
Array of Employee
limit
string
offset
string
total
string
Получить сотрудника по id
GET /control/api/v1/employees/{id}

Authentication

Path variables

id
string required

ID of employee

Responses

200 OK
Body
Object
data
Employee
Удалить сотрудника
DELETE /control/api/v1/employees/{id}

Path variables

id
string required

ID of employee

Responses

204 No Content
Обновить сотрудника
PUT /control/api/v1/employees/{id}

Нужно передавать все поля, данные из реквеста полностью перезаписывают данные в бд

Path variables

id
string required

ID of employee

Request body

Employee

Responses

200 OK
Body
Object
data
Employee
Добавить сотрудника
POST /control/api/v1/employees

Request body

Employee

Responses

200 OK
Body
Object
data
Employee
База клиентов
Получить список клиентов
POST /control/api/v1/clients
Получить детальную информацию по клиенту
GET /control/api/v1/clients/{id}
Добавить клиента
POST /control/api/v1/client
Отредактировать клиента
PUT /control/api/v1/clients/{id}
Получить список клиентов
POST /control/api/v1/clients

Authentication

Request body

Object
limit
number

50

offset
number

0

cityId
string nullable

идентификатор города, если null - всех клиентов показываем

Example:
wervwervwr-23vr3sver
query
string nullable

поиск (по наименованию организации (fullName))

Responses

200 OK
Body
Object
data
Object
list
Array
Object
id
string

идентификатор клиента

Example:
sdfvwervwerv23-4234-23v4-2
fullName
string

Полное наименование клиента

Example:
sdfvwerwv-werwervwr
legalAddress
string

Юридический адрес

Example:
354000 г. Сочи ул. Воровского 40
limit
integer
Example:
50
offset
integer
Example:
0
total
integer
Example:
100
Получить детальную информацию по клиенту
GET /control/api/v1/clients/{id}

Authentication

Path variables

id
string required

id клиента

Responses

200 OK
Body
Object
data
Client
Example 1
POST /control/api/v1/clients/detail HTTP/1.1 

Content-Type: application/json

{
    "id": ""
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "servwervwer-23vr23rverv",
        "fullName": "ООО \"Рога и Копыта\"",
        "shortName": "ООО \"\"РиК\"",
        "legalAddress": "354000 г. Сочи, ул. Воровского 35",
        "actualAddress": "354000 г. Сочи, ул. Воровского 35",
        "phone": "89999999999",
        "email": "roga@kopita.pro",
        "inn": "12312312312",
        "kpp": "12312314324",
        "ogrn": "123123123",
        "requisites": {
            "clientName": "ООО \"Рога и Копыта\"",
            "inn": "123123123",
            "accountNumber": "234234234",
            "bankName": "Банк номер 1",
            "bik": "1231241325",
            "kpp": "234234234",
            "correspondentAccount": "235345345345"
        }
    }
}
show more
Добавить клиента
POST /control/api/v1/client

в body естественно не отправляем id клиента

Request body

Client
Examples

Responses

200 OK
Body
Object
data
Client
Example 1
POST /control/api/v1/client HTTP/1.1 

Content-Type: application/json

{
    "id": "servwervwer-23vr23rverv",
    "fullName": "ООО \"Рога и Копыта\"",
    "shortName": "ООО \"\"РиК\"",
    "legalAddress": "354000 г. Сочи, ул. Воровского 35",
    "actualAddress": "354000 г. Сочи, ул. Воровского 35",
    "phone": "89999999999",
    "email": "roga@kopita.pro",
    "inn": "12312312312",
    "kpp": "12312314324",
    "ogrn": "123123123",
    "requisites": {
        "clientName": "ООО \"Рога и Копыта\"",
        "inn": "123123123",
        "accountNumber": "234234234",
        "bankName": "Банк номер 1",
        "bik": "1231241325",
        "kpp": "234234234",
        "correspondentAccount": "235345345345"
    }
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "servwervwer-23vr23rverv",
        "fullName": "ООО \"Рога и Копыта\"",
        "shortName": "ООО \"\"РиК\"",
        "legalAddress": "354000 г. Сочи, ул. Воровского 35",
        "actualAddress": "354000 г. Сочи, ул. Воровского 35",
        "phone": "89999999999",
        "email": "roga@kopita.pro",
        "inn": "12312312312",
        "kpp": "12312314324",
        "ogrn": "123123123",
        "requisites": {
            "clientName": "ООО \"Рога и Копыта\"",
            "inn": "123123123",
            "accountNumber": "234234234",
            "bankName": "Банк номер 1",
            "bik": "1231241325",
            "kpp": "234234234",
            "correspondentAccount": "235345345345"
        }
    }
}
show more
Отредактировать клиента
PUT /control/api/v1/clients/{id}

Path variables

id
string required

id клиента

Request body

Client

Responses

200 OK
Body
Object
data
Client
Страны
Получить список стран
GET /control/api/v1/countries
Добавить страну
POST /control/api/v1/countries
Получить список стран
GET /control/api/v1/countries

Responses

200 OK
Body
Object
data
Object
list
Array of Country
Example 1
GET /control/api/v1/countries HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "list": [
            {
                "id": "sdfvwer-wervwerv-23vrwer",
                "name": "Москва",
                "isoCode": "RU"
            }
        ]
    }
}
Добавить страну
POST /control/api/v1/countries

Request body

Object
name
string

наименования

Example:
Россия
isoCode
string

iso код

Example:
RU

Responses

200 OK
Body
Object
data
Country
Города
Получить доступные города
GET /control/api/v1/cities
Добавить город
POST /control/api/v1/cities
Получить доступные города
GET /control/api/v1/cities

Отсортированы по полю name asc.

Request parameters

countryId
string optional

идентификатор страны

Example:
sdfvewrv-wervwe-rvw

Responses

200 OK
Body
Object
data
Object
list
Array of City
Example 1
GET /control/api/v1/cities HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "list": [
            {
                "id": "sdfvser-wervw",
                "name": "Москва",
                "countryId": "v4wervwer-v23rv23rwevr"
            }
        ]
    }
}
Добавить город
POST /control/api/v1/cities

Request body

Object
name
string

наименование

Example:
Москва
countryId
string

id страны

Example:
sdfvserv-wervwerv-wevr

Responses

200 OK
Body
Object
data
City
Example 1
POST /control/api/v1/cities HTTP/1.1 

Content-Type: application/json

{
    "name": "Москва",
    "countryId": "sdfvserv-wervwerv-wevr"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "sdfvser-wervw",
        "name": "Москва",
        "countryId": "v4wervwer-v23rv23rwevr"
    }
}
Headers
User-Agent

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

string
Example:
Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko)
Region

A value should be passed as the uppercased one.

string ISO_3166-1
Example:
RU
Language

A value should be passed as the lowercased one.

string ISO 639-1
Example:
RU
X-Request-ID

Each request should have an unique value passed into the header. It could be an uuid typed string, for example

string
Example:
4a3dd175-78bb-4bc8-b09e-5f6c3947bd94
X-Time-Zone

A value from the IANA Time Zone database

string
Example:
Europe/Moscow
Authorization

An authorization token should be passed here. A user could get his/her token when he/she signs in or refreshes the old token. It must start with “Bearer” value.

string
Example:
Bearer <token>
Entities
ParkingPayload
Object
cityId
string nullable

идентификатор города

Example:
dfdtrretber
clientId
string

идентификатор клиента

Example:
sdfvwerver-23rverv
name
string

наименование

address
string

адрес

location
Location

координаты парковки

polygonPoints
Array of Location

полигон

info
string nullable

информация о парковке

schedule
Array of Weekday

расписание

rates
Object

рейты

freeTimeInMins
string nullable

бесплатное время выезда в минутах, может отсутствовать

Example:
10
freeExitTimeInMins
integer

время для выезда в минутах

Example:
15
conditions
Array
Object
timeInMins
string

время в минутах

Example:
60
price
integer

цена

Example:
200
transits
Array of Transit
rent
Object nullable

аренда

price
Price

цена

info
string

описание

Example:
парковка не несет отвестенности за ТС оставленное .....
isAvailable
boolean

доступна или нет

show more
Example 1
{
    "name": "",
    "address": "",
    "location": {
        "lat": 34.234234,
        "long": 52.12323
    },
    "polygonPoints": [
        {
            "lat": 34.234234,
            "long": 52.12323
        }
    ],
    "info": "",
    "schedule": [
        {
            "id": 1,
            "workingHours": {
                "openingTime": "24:00",
                "closingTime": "24:00"
            }
        }
    ]
}
Employee
Object
id
string nullable

ID (в body нет, в остальном required)

Example:
cf554bcf-7e82-4d78-96b5-dcefef4bf5c8
role
Role

The role of the employee

cityId
string

The id of the city where the employee works. It could be null until the cities comes to a database

Example:
13519c69-a59a-49eb-bca2-f880ec7f733e
phone
string

The phone number of the employee

Example:
88005553534
email
string

The email of the employee

Example:
admin.admin@admin.ru
livingAddress
string

The living address of the employee

Example:
МОСКВА2
firstName
string

The first name of the employee

Example:
Иван
lastName
string

The last name of the employee

Example:
Иванов
patronymic
string nullable

The patronymic of the employee (if exists)

Example:
Иванович
Role
string
Enumeration:
ADMIN
DELEGATE
FINANCIER
ENGINEER
Country
Object
id
string

идентификатор

Example:
sdfvwer-wervwerv-23vrwer
name
string

Наименование

Example:
Москва
isoCode
string

iso код

Example:
RU
Client
Object
id
string nullable

идентификатор (при создании отсутвует, в остальном required)

Example:
servwervwer-23vr23rverv
fullName
string

Полное наименование

Example:
ООО "Рога и Копыта"
shortName
string

Краткое наименование

Example:
ООО ""РиК"
legalAddress
string

юридический адрес

Example:
354000 г. Сочи, ул. Воровского 35
actualAddress
string

фактический адрес

Example:
354000 г. Сочи, ул. Воровского 35
phone
string

контактный номер телефона

Example:
89999999999
email
string

электронная почта

Example:
roga@kopita.pro
inn
string

ИНН

Example:
12312312312
kpp
string

КПП

Example:
12312314324
ogrn
string

ОГРН

Example:
123123123
requisites
Requisites

реквизиты

parkings
Array nullable

список парковок (актуален только для получения деталки)

Object
id
string

id

Example:
sdfvwerv023rv23vr-wervwerv
name
string

наименование

Example:
Моремолл
address
string

адрес парковки

Example:
ул. Воровского 45
show more
Requisites
Object
clientName
string

Наименование клиента

Example:
ООО "Рога и Копыта"
inn
string

ИНН

Example:
123123123
accountNumber
string

Номер счета клиента

Example:
234234234
bankName
string

Наименование банка

Example:
Банк номер 1
bik
string

БИК

Example:
1231241325
kpp
string

КПП

Example:
234234234
correspondentAccount
string

Корреспондентский счет

Example:
235345345345
City
Object
id
string

идентификатор

Example:
sdfvser-wervw
name
string

наименование

Example:
Москва
countryId
string

идентификатор страны

Example:
v4wervwer-v23rv23rwevr
Location
Object
lat
number

широта

Example:
34.234234
lon
number

долгота

Example:
52.12323
Weekday
Object
id
integer

идентификатор дня недели

Example:
1
workingHours
Object nullable

если закрыто - null

openingTime
string

время открытия, если круглосуточно будет 00:00 - 00:00

Example:
24:00
closingTime
string

время закрытия

Example:
24:00
Transit
Object
name
string

наименование

Example:
Северный
location
Location

локация

arrowDegree
integer

градус стрелки

Example:
270
type
string

тип

Enumeration:
EXIT

выезд

ENTRANCE

въезд

ONE

единый

barriers
Array

шлагбаумы

Object
id
string nullable

идентификатор барьера, nullable при добавлении парковки

number
integer

номер шлагбаума

deviceId
string nullable

идентификатор устройства, nullable при добавлении парковки

ParkingListItem
Object
id
string

id

Example:
sdfvwer-vwervwer
name
string

name of parking

Example:
Моремолл
address
string

address of parking

Example:
ул. Новая Заря 3
status
string

статус парковки

Enumeration:
ACTIVE

активна

INACITVE

не активна

clientName
string

имя клиента

Example:
ООО Рога и Копыта
Parking
Object
id
string

идентификатор

creatingDate
string

дата создания

name
string

наименование

address
string

адрес

schedule
Array of Weekday

расписание работы

location
Location

координаты парковки

polygonPoints
Array of Location
info
string nullable

информация о парковке

rates
Object

рейты

freeTimeInMins
string

бесплатное время выезда в минутах, может отсутствовать

Example:
10
freeExitTimeInMins
string

время для выезда в минутах

Example:
15
conditions
Array
Object
timeInMins
string

время в минутах

price
string

цена

rent
Object nullable
price
string

цена

Example:
5000
info
string

описание

isAvailable
boolean

доступно ли для аренды

Example:
false
transits
Array of Transit

транзиты

status
ParkingStatus

статус

city
City

город

show more
ParkingStatus
string
Enumeration:
NEW

новая парковка, ожидает перевода в статус ожидание устройств после проверки менеджером

WAITING_BARRIERS

ожидает барьеры

WIP_BARRIERS

в работе установка датчиков

RDY_BARRIERS

датчики установлены

INACTIVE

парковка не активна

ACTIVE

парковка активна

Price

Целое число с копейками. Пример: 500.00 - 50000. (Всегда умножать и делить на 100)

number long
FAQ
Получить список FAQ
GET /control/api/v1/faq
Добавить топик
POST /control/api/v1/faq/topic
Отредактировать топик
PUT /control/api/v1/faq/topic/{id}
Удалить топик
DELETE /control/api/v1/faq/topic/{id}
Получить список FAQ
GET /control/api/v1/faq

Responses

200 OK
Body
Object
data
Object
list
FAQItem
Example 1
GET /path HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "list": {
            "id": "asdfscervw-ervwervw",
            "title": "Как добавить автомобиль",
            "answers": [
                {
                    "question": "Проблемы с шлагбаумом.",
                    "answer": "Возможно, есть какие-то проблемы со шлагбаумом, которые не дают ему открыться. В таком случае, необходимо обратиться к администрации парковки."
                }
            ]
        }
    }
}
show more
Добавить топик
POST /control/api/v1/faq/topic

Request body

Object
title
string

заголовок

Example:
Как добавить автомобиль
answers
Array of FAQAnswer

Responses

200 OK
Body
Object
data
FAQItem
Отредактировать топик
PUT /control/api/v1/faq/topic/{id}

Path variables

id
string required

идентификатор топика

Request body

Object
title
string
answers
Array of FAQAnswer

Responses

200 OK
Body
Object
data
FAQItem
Example 1
GET /path/{id} HTTP/1.1 

Content-Type: application/json

{
    "id": "",
    "answers": [
        {
            "question": "Проблемы с шлагбаумом.",
            "answer": "Возможно, есть какие-то проблемы со шлагбаумом, которые не дают ему открыться. В таком случае, необходимо обратиться к администрации парковки."
        }
    ]
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "id": "asdfscervw-ervwervw",
        "title": "Как добавить автомобиль",
        "answers": [
            {
                "question": "Проблемы с шлагбаумом.",
                "answer": "Возможно, есть какие-то проблемы со шлагбаумом, которые не дают ему открыться. В таком случае, необходимо обратиться к администрации парковки."
            }
        ]
    }
}
show more
Удалить топик
DELETE /control/api/v1/faq/topic/{id}

Path variables

id
string required

удалить топик

Responses

204 No Content
FAQAnswer
Object
question
string

вопрос

Example:
Проблемы с шлагбаумом.
answer
string

ответ

Example:
Возможно, есть какие-то проблемы со шлагбаумом, которые не дают ему открыться. В таком случае, необходимо обратиться к администрации парковки.
FAQItem
Object
id
string

uuid

Example:
asdfscervw-ervwervw
title
string

заголовок

Example:
Как добавить автомобиль
answers
Array of FAQAnswer
Справочная информация
Получить справочные данные
GET /path
Изменить справочные данные
GET /path
Добавить / изменить документ
POST /control/api/v1/documents/upload
Удалить документ
DELETE /control/api/v1/documents/delete
Получить справочные данные
GET /path

Responses

200 OK
Body
Object
data
Object
email
string

эл. почта

Example:
pd@mail.ru
phone
string

телефон

Example:
89991234567
files
Array

файлы

Object
type
DocumentType

тип документа

link
string

ссылка на документ

Изменить справочные данные
GET /path

Request body

Object
phone
string

телефон

Example:
89999999999
email
string

эл. почта

Example:
pd@pd.pd

Responses

200 OK
Body
Object
phone
string

телефон

email
string

почта

files
Array
Object
type
DocumentType

тип документа

link
string

ссылка

Добавить / изменить документ
POST /control/api/v1/documents/upload

Request body

Object
type
DocumentType

тип документа

data
unknown

document

Responses

200 OK
Body
Object
type
DocumentType

тип документа

link
string

ссылка

Удалить документ
DELETE /control/api/v1/documents/delete

Request body

Object
type
DocumentType

Responses

204 No Content
Example 1
DELETE /path HTTP/1.1 

Content-Type: application/json

{
    "type": "rulesForUsingService"
}
DocumentType
string
Enumeration:
privacyPolicy

политика конфиденциальности

termsOfUse

пользовательское соглашение

paymentInformation

информация об оплате

requisites

реквизиты