...
| Open API (Swagger) Integration for Confluence | ||
|---|---|---|
| ||
openapi: 3.0.1
info:
title: Abills admins API
version: 0.0.15
servers:
- url: https://demo.abills.net.ua:9443/api.cgi
tags:
- name: users
description: Работа с пользователями
- name: groups
description: Группы пользователей
- name: tp
description: Тарифные планы
- name: msgs
description: Msgs
- name: internet
description: Internet
- name: iptv
description: Iptv
- name: abon
description: Abon
- name: districts
description: Районы
- name: streets
description: Улицы
- name: builds
description: Дома
- name: payments
description: Оплаты
- name: fees
description: Списания
- name: online
description: Сессии пользователя
- name: version
description: Версии
- name: equipment
description: Работа с оборудованием
paths:
/equipment/onu/list/:
get:
tags:
- equipment
summary: Список ONU
operationId: getOneList
parameters:
- name: branch
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: branchDesc
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: vlanId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuVlan
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuDesc
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuBillingDesc
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: oltRxPower
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuDhcpPort
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuGraph
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: nasIp
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: onuSnmpId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: dateTime
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: serverVlan
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: gid
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: traffic
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: login
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: userMac
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: macBehindOnu
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: distance
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: externalSystemLink
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: sort
in: query
description: Сортировка по одному параметру выше
schema:
type: string
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/OnuList'
security:
- KEY: [ ]
/equipment/box/list/:
get:
tags:
- equipment
summary: Список OLT
operationId: getOltList
parameters:
- name: sort
in: query
description: Сортировка по одному параметру выше
schema:
type: string
- name: pageRows
in: query
description: Количество записей
schema:
type: integer
default: 100000
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/OltList'
security:
- KEY: [ ]
/equipment/used/ports/:
get:
tags:
- equipment
summary: Список использованных портов
operationId: getUsedPorts
parameters:
- name: nasId
in: query
description: Поиск по nasId
schema:
type: string
- name: portsOnly
in: query
description: только порты
schema:
type: boolean
- name: fullList
in: query
description: полный список
schema:
type: boolean
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UsedPorts'
security:
- KEY: [ ]
/users/login:
post:
tags:
- users
summary: Авторизация пользователя
operationId: loginUser
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/UserLogin'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200'
x-codegen-request-body-name: body
/users/:
post:
tags:
- users
summary: Добавить нового пользователя
operationId: addUser
requestBody:
description: Параметры, которые нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreated'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/users/all:
get:
tags:
- users
summary: Получить всех пользователей
parameters:
- name: fio
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: fio2
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: fio3
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: deposit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: extDeposit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: extBillId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: credit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: creditDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: loginStatus
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: phone
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: email
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: floor
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: entrance
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: addressFlat
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportNum
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportGrant
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: city
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: zip
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: gid
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: companyId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: companyName
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractSufix
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: expire
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: reduction
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: lastPayment
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: lastFees
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: registration
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: reductionDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: comments
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: billId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: activate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: acceptRules
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: password
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: birthDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: taxNumber
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pageRows
in: query
description: Количество записей
schema:
type: integer
default: 100000
- name: sort
in: query
description: Сортировка по одному параметру выше
schema:
type: string
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserList'
security:
- KEY: [ ]
/users/{UID}:
get:
tags:
- users
summary: Получить пользователя по UID
description: Возвращает пользователя
operationId: getUserByUID
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/User'
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
put:
tags:
- users
summary: Обновить информацию о пользователе
operationId: updateUser
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
delete:
tags:
- users
summary: Удалить пользователя
operationId: deleteUser
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/users/{UID}/pi:
get:
tags:
- users
summary: Получить персональную информацию о пользователе
description: Возвращает персональную информацию пользователя
operationId: getUserPiByUID
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserPi'
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
put:
tags:
- users
summary: Изменение персональной информации пользователю
operationId: changeUserPi
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPi'
required: true
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
post:
tags:
- users
summary: Добавление персональной информации пользователю
operationId: addUserPi
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPi'
required: true
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/users/{UID}/contacts:
get:
tags:
- users
summary: Получить контакты пользователя по UID
description: Возвращает контакты пользователя
operationId: getUserContactsByUID
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsArray'
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
post:
tags:
- users
summary: Добавление контакта пользователю
operationId: updateUserContact
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserContactAdd'
required: true
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/users/{UID}/contacts/{ID}:
put:
tags:
- users
summary: Обновить контакт пользователю
operationId: updateUserConctact
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
- name: ID
in: path
description: ID контакта
required: true
schema:
type: integer
format: int64
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
delete:
tags:
- users
summary: Удалить контакт пользователя
operationId: deleteUserContact
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
- name: ID
in: path
description: ID контакта
required: true
schema:
type: integer
format: int64
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/users/contacts:
post:
tags:
- users
summary: Получить контакты
description: Возвращает контакты пользователей
operationId: getContacts
requestBody:
description: Параметры для фильтрации контактов
content:
'*/*':
schema:
$ref: '#/components/schemas/Contacts'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsArray'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/users/internet/all:
get:
tags:
- internet
summary: Получить всех пользователей
parameters:
- name: cid
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: cpe_mac
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: vlan
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: server_vlan
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: joinService
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: simultaneonsly
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: speed
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: nasId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: port
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: allFilterId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: filterId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: tpId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: tpNum
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: tpName
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: monthFee
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: abonDistribution
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: dayFee
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: personalTp
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: paymentType
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: disable
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: ipnActivate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: dayTrafLimit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: weekTrafLimit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: totalTrafLimit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: feesMethod
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: nasIp
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: fio
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: fio2
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: fio3
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: deposit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: extDeposit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: extBillId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: credit
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: creditDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: loginStatus
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: phone
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: email
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: floor
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: entrance
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: addressFlat
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportNum
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pasportGrant
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: city
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: zip
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: gid
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: companyId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: companyName
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractSufix
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: contractDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: expire
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: reduction
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: lastPayment
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: lastFees
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: registration
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: reductionDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: comments
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: billId
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: activate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: acceptRules
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: password
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: birthDate
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: taxNumber
in: query
description: Параметр который возвращает биллинг
schema:
type: boolean
default: false
- name: pageRows
in: query
description: Количество записей
schema:
type: integer
default: 100000
- name: sort
in: query
description: Сортировка по одному параметру выше
schema:
type: string
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserInternetList'
security:
- KEY: [ ]
/users/{UID}/internet:
get:
tags:
- internet
summary: Получить список ТП Internet пользователя
description: Возвращает ТП интернет пользователя
operationId: getUserInternetByUID
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserInternetList'
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
post:
tags:
- internet
summary: Добавление ТП Internet пользователю
operationId: addUserInternetaddUserInternetDepracted
deprecated: true
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserInternet'
required: true
responses:
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/usersinternet/{UID}/internet/{ID}activate:
getpost:
tags:
- internet
summary: ИнформацияИзменение обТП интернет услуге пользователя по ID услугиИнтернет пользователю
operationId: internetInfoUseraddUserInternet
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
- name: IDrequestBody:
incontent: path
descriptionapplication/json:
ID услуги
requiredschema: true
schema:
type: integer$ref: '#/components/schemas/UserInternetActivate'
formatrequired: int64true
responses:
404200:
description: ПользовательУспешно не найдендобавлено
content:
application/json:
schema:
$reftype: '#/components/schemas/ApiResponse'object
security:
- KEY: [ ]
/users/{UID}/iptv properties:
get:
tags:
-result: iptv
summary: Получить список ТП Iptv пользователя
description: Возвращает ТП Iptvtype: пользователяstring
operationId: getUserIptvByUID
parameters:
example: - name: UIDSuccessfully added
in400: path
description: UIDНет пользователяполя в биллингеtpId
requiredcontent:
true
schematext/json:
type schema:
integer
format type: int64object
responses:
200properties:
description: Успешное выполнение
errno: content:
application/json:
type: integer
schema:
$refexample: '#/components/schemas/UserIptvList'100
404:
description: Пользователь не найденerrstr:
content:
application/json:type: string
schema:
example: No $ref: '#/components/schemas/ApiResponse'field tpId
security:
- KEY: [ ]
/users/{UID}/iptv/{ID}:
getput:
tags:
- iptvinternet
summary: ИнформацияДобавление обТП Iptv услуге пользователя по ID услугиInternet пользователю
operationId: iptvInfoUserchangeUserInternet
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
- name: IDrequestBody:
incontent: path
descriptionapplication/json:
ID услуги
requiredschema: true
schema:
type: integer$ref: '#/components/schemas/UserInternetChange'
formatrequired: int64true
responses:
404200:
description: ПользовательУспешно не найденизменено
content:
application/json:
schema:
$reftype: '#/components/schemas/ApiResponse'object
security:
- KEY: [ ]
/msgs/ properties:
post:
tags:
-result: msgs
summary: Добавить сообщение
operationId: addMsgs
requestBodytype: string
description: Параметры, которые нужно указать
contentexample:
Successfully changed
application/json400:
description: Нет id schema:услуги
content:
$ref: '#/components/schemas/Msgs'
requiredtext/json: true
responses:
200schema:
description: успешное выполнение
type: object
content:
application/jsonproperties:
schema:
errno:
$ref: '#/components/schemas/ApiSuccessAddResponse'
securitytype: integer
- KEY: [ ]
x-codegen-request-body-name: body
/msgs/{ID}:example: 102
get:
tags:
-errstr:
msgs
summary: Получить сообщение по ID
description: Возвращает сообщение
type: string
operationId: getMsgsInfoByID
parameters:
- nameexample: ID
No field id
insecurity: path
- description: ID сообщенияKEY: [ ]
/users/{UID}/internet/{ID}:
get:
tags:
- internet
summary: Информация об интернет услуге пользователя по ID услуги
operationId: internetInfoUser
parameters:
- name: UID
in: path
description: UID пользователь
required: true
schema:
type: integer
format: int64
- responsesname: ID
200 in: path
description: УспешноеID выполнениеуслуги
contentrequired: true
schema:
application/json:
type: integer
schema:
format: int64
$ref: '#/components/schemas/Msgs'responses:
404:
description: СообщениеПользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/msgs/listusers/{UID}/iptv:
postget:
tags:
- msgsiptv
summary: Получить список сообщенийТП Iptv пользователя
operationIddescription: msgsListВозвращает ТП Iptv пользователя
requestBodyoperationId: getUserIptvByUID
parameters:
description: Параметры, по которым можно- фильтроватьname: сообщенияUID
contentin: path
application/json:
description: UID пользователя в биллинге
required: true
schema:
type: integer
$ref: '#/components/schemas/Msgs'
requiredformat: trueint64
responses:
200:
description: успешноеУспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponseUserIptvList'
security 404:
- KEYdescription: [Пользователь не ]найден
x-codegen-request-body-name: body
/msgs/{ID}/reply content:
get:
tagsapplication/json:
- msgsschema:
summary: Ответы на сообщение
operationId$ref: repliesListToMsgs'#/components/schemas/ApiResponse'
parameterssecurity:
- nameKEY: [ ]
/users/{UID}/iptv/{ID}:
get:
intags: path
- iptv
description: ID сообщения
summary: Информация об Iptv услуге пользователя по required:ID trueуслуги
operationId: iptvInfoUser
schema:
type: integerparameters:
- formatname: int64UID
responses:
200:in: path
description: успешноеUID выполнениепользователь
contentrequired:
application/json:
true
schema:
$reftype: '#/components/schemas/MsgsRepliesList'integer
security:
- KEYformat: [ ]int64
post:
tags:
- msgs
summary: Ответить на сообщение
operationId: addReplyToMsgs
parameters:
- name: ID
in: path
description: ID сообщенияуслуги
required: true
schema:
type: integer
format: int64
requestBodyresponses:
404:
description: Пользователь Параметры,не которыенайден
нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsReplyApiResponse'
security:
required: true
- responsesKEY:
[ ]
/msgs/:
200post:
tags:
description: успешное - msgs
summary: Добавить сообщение
operationId: addMsgs
requestBody:
description: Параметры, которые нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/Msgs'
required: true
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/msgs/reply/{REPLY_ID}/attachment:
postget:
tags:
- msgs
summary: Прикрепление файла к ответуПолучить сообщение по ID
description: Возвращает сообщение
operationId: addAttachmentToReplygetMsgsInfoByID
parameters:
- name: REPLY_ID
in: path
description: ID ответа на сообщениесообщения
required: true
schema:
type: integer
format: int64
requestBodyresponses:
200:
description: Параметры,Успешное которыевыполнение
нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsReplyAttachmentMsgs'
required404: true
responses:
200description:
Сообщение description: успешное выполнениене найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponseApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/msgs/chapterslist:
getpost:
tags:
- msgs
summary: Получить список разделовсообщений
operationId: chaptersListmsgsList
responsesrequestBody:
200description:
Параметры, по которым можно description: успешное выполнениефильтровать сообщения
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsChapterMsgs'
security:
required: true
- KEYresponses:
[ ]
/groups:
get200:
tags:
description: успешное выполнение
- groups
summarycontent:
Получить группы пользователей
description: Возвращает группы пользователейapplication/json:
operationId: getGroupsList
responsesschema:
200:
description: Успешное выполнение$ref: '#/components/schemas/ApiSuccessAddResponse'
contentsecurity:
- KEY: [ application/json:]
schema:
$ref: '#/components/schemas/Groups'
security:
- KEY: [ ]x-codegen-request-body-name: body
/tpmsgs/{tpIDID}/reply:
get:
tags:
- tpmsgs
summary: ПолучитьОтветы информацию по тарифному плану
на сообщение
description: Возвращает тарифный план
operationId: getTpInforepliesListToMsgs
parameters:
- name: tpIDID
in: path
description: tpIDID тарифного планасообщения
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешноеуспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/TpMsgsRepliesList'
404security:
- descriptionKEY: Тарифный план не найден[ ]
post:
contenttags:
- msgs
application/json:
summary: Ответить на сообщение
operationId: schema:addReplyToMsgs
parameters:
- $refname: '#/components/schemas/ApiResponse'ID
security: in: path
- KEYdescription: [ID ]сообщения
/tp/{tpID}/intervals/:
get:
tagsrequired: true
- tpschema:
summary: Получить информацию по интервалам ТП
type: integer
description: Возвращает интервалы ТП
operationIdformat: getTpIntervalsInfoint64
parametersrequestBody:
- name: tpID
description: Параметры, которые нужно указать
incontent: path
descriptionapplication/json:
tpID тарифного плана
requiredschema: true
schema:
type: integer$ref: '#/components/schemas/MsgsReply'
formatrequired: int64true
responses:
200:
description: Успешноеуспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/TpIntervalsApiSuccessAddResponse'
404security:
- descriptionKEY: Тарифный план не найден[ ]
x-codegen-request-body-name: body
content/msgs/reply/{REPLY_ID}/attachment:
post:
application/jsontags:
schema:- msgs
summary: Прикрепление файла к ответу
$refoperationId: '#/components/schemas/ApiResponse'addAttachmentToReply
securityparameters:
- KEYname: [ ]REPLY_ID
/districts:
get:
in: path
tags:
- districts
description: ID ответа на сообщение
summary: Получить районы
descriptionrequired: Возвращаетtrue
список районов
operationId: getDistricts
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$reftype: '#/components/schemas/DistrictsArray'integer
security:
- KEY: [ ]
post:format: int64
tagsrequestBody:
- districts
summarydescription: ДобавлениеПараметры, района
которые operationId: addDistrictнужно указать
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DistrictsMsgsReplyAttachment'
required: true
responses:
200:
description: Успешноеуспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/districtsmsgs/{ID}chapters:
get:
tags:
- districtsmsgs
summary: Получить информациюсписок о районеразделов
operationId: getDistrictInfochaptersList
parametersresponses:
- name200: ID
indescription: pathуспешное выполнение
descriptioncontent:
ID района
requiredapplication/json:
true
schema:
type: integer
$ref: '#/components/schemas/MsgsChapter'
security:
- KEY: [ ]
/groups:
get:
tags:
- groups
summary: Получить группы пользователей
description: Возвращает группы пользователей
format operationId: int64getGroupsList
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/DistrictsGroups'
security:
- KEY: [ ]
/tp/{tpID}:
put get:
tags:
- districtstp
summary: ОбновитьПолучить информацию о районе по тарифному плану
description: Возвращает тарифный план
operationId: updateDistrictgetTpInfo
parameters:
- name: IDtpID
in: path
description: IDtpID тарифного районаплана
required: true
schema:
type: integer
format: int64
requestBody:responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/DistrictsTp'
required404: true
responses:
description: Тарифный план не 400:найден
descriptioncontent:
Invalid ID supplied
content: { }
application/json:
securityschema:
- KEY: [ ] $ref: '#/components/schemas/ApiResponse'
security:
x-codegen-request-body-name: body - KEY: [ ]
/streets/tp/{tpID}/intervals/:
get:
tags:
- streetstp
summary: Получить улицыинформацию по интервалам ТП
description: Возвращает списокинтервалы улицТП
operationId: getStreetsgetTpIntervalsInfo
responsesparameters:
- 200name: tpID
descriptionin: Успешное выполнениеpath
contentdescription:
tpID тарифного плана
application/jsonrequired: true
schema:
$reftype: '#/components/schemas/StreetsArray'
integer
security:
- KEYformat: [ ]int64
post:
tagsresponses:
- streets200:
summary: Добавление района
description: operationId: addStreetУспешное выполнение
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreetsTpIntervals'
required404: true
responses:
description: Тарифный план не 200:найден
descriptioncontent:
Успешное выполнение
contentapplication/json:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponseApiResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/streets/{ID}districts:
get:
tags:
- streetsdistricts
summary: Получить информацию о улицерайоны
description: Возвращает список улицурайонов
operationId: getStreetInfogetDistricts
parametersresponses:
- name200: ID
indescription: pathУспешное выполнение
descriptioncontent:
ID улицы
requiredapplication/json:
true
schema:
type $ref: integer
'#/components/schemas/DistrictsArray'
security:
format: int64 - KEY: [ ]
post:
responsestags:
200:
- districts
summary: Добавление района
descriptionoperationId: addDistrict
Успешное выполнение
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreetsDistricts'
security required: true
responses:
- KEY: [ ]200:
put:
tagsdescription: Успешное выполнение
- streetscontent:
summary: Обновить информацию о улицеapplication/json:
operationId: updateStreet
parametersschema:
- name: ID
$ref: '#/components/schemas/ApiSuccessAddResponse'
in security: path
- descriptionKEY: ID[ улицы]
x-codegen-request-body-name: body
required: true/districts/{ID}:
get:
schematags:
- districts
type: integer
summary: Получить информацию о районе
formatoperationId: int64getDistrictInfo
requestBodyparameters:
- contentname: ID
application/jsonin: path
description: ID schema:района
required: true
$ref: '#/components/schemas/Streets'
requiredschema: true
responses:
type: 400:integer
description: Invalid IDformat: suppliedint64
contentresponses:
{ }
security200:
- KEYdescription: [Успешное ]выполнение
x-codegen-request-body-name: body
/buildscontent:
get:
tagsapplication/json:
- builds
summaryschema:
Получить дома
description: Возвращает список домов
operationId$ref: getBuilds'#/components/schemas/Districts'
responsessecurity:
- 200KEY:
[ ]
put:
descriptiontags:
Успешное выполнение
- districts
content:
summary: Обновить информацию о районе
application/jsonoperationId: updateDistrict
parameters:
schema- name: ID
in: path
$ref: '#/components/schemas/BuildsArray'
description: ID security:района
- KEYrequired: [ ]true
post:
tagsschema:
- builds
type: integer
summary: Добавление дома
operationIdformat: addBuildint64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuildsDistricts'
required: true
responses:
200400:
description: УспешноеInvalid ID выполнениеsupplied
content:
application/json:
schema:
{ }
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/builds/{ID}streets:
get:
tags:
- buildsstreets
summary: Получить информацию о домеулицы
description: Возвращает домсписок улиц
operationId: getBuildInfogetStreets
parametersresponses:
- name200: ID
indescription: Успешное pathвыполнение
descriptioncontent:
ID дома
requiredapplication/json: true
schema:
type$ref: integer'#/components/schemas/StreetsArray'
security:
- format: int64KEY: [ ]
post:
responsestags:
- 200:streets
summary: Добавление района
descriptionoperationId: addStreet
Успешное выполнение
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuildsStreets'
securityrequired: true
responses:
- KEY: [ ]
put200:
tags:
description: Успешное выполнение
- builds
summarycontent:
Обновить информацию о доме
operationIdapplication/json: updateBuild
parameters:
- nameschema: ID
in: path
$ref: '#/components/schemas/ApiSuccessAddResponse'
description: ID домаsecurity:
- KEY: required:[ true]
x-codegen-request-body-name: body
schema/streets/{ID}:
get:
tags:
type: integer
- streets
format: int64summary: Получить информацию о улице
requestBodydescription:
Возвращает улицу
contentoperationId: getStreetInfo
parameters:
- name: ID
in: path
description: ID улицы
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Streets'
security:
- KEY: [ ]
put:
tags:
- streets
summary: Обновить информацию о улице
operationId: updateStreet
parameters:
- name: ID
in: path
description: ID улицы
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Streets'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/builds:
get:
tags:
- builds
summary: Получить дома
description: Возвращает список домов
operationId: getBuilds
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/BuildsArray'
security:
- KEY: [ ]
post:
tags:
- builds
summary: Добавление дома
operationId: addBuild
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Builds'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/builds/{ID}:
get:
tags:
- builds
summary: Получить информацию о доме
description: Возвращает дом
operationId: getBuildInfo
parameters:
- name: ID
in: path
description: ID дома
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Builds'
security:
- KEY: [ ]
put:
tags:
- builds
summary: Обновить информацию о доме
operationId: updateBuild
parameters:
- name: ID
in: path
description: ID дома
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Builds'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/payments/types:
get:
tags:
- payments
summary: Получить список типов оплат
description: Возвращает список типов оплат
operationId: getPaymentTypesList
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentTypesArray'
security:
- KEY: [ ]
/payments/users/{UID}:
get:
tags:
- payments
summary: Получить список оплат пользователя
description: Возвращает список оплат пользователя
operationId: getUserPayments
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaymentsArray'
security:
- KEY: [ ]
post:
tags:
- payments
summary: Добавление оплаты пользователю
operationId: addUserPayment
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaymentAdd'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/fees/types:
get:
tags:
- fees
summary: Получить список типов списания
description: Возвращает список типов списания
operationId: getFeesTypesList
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/FeesTypesArray'
security:
- KEY: [ ]
/fees/users/{UID}:
get:
tags:
- fees
summary: Получить список списаний пользователя
description: Возвращает список списаний пользователя
operationId: getUserFees
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Builds'UserFeesArray'
security:
required- KEY: [ true]
/fees/users/{UID}/{SUM}:
responsespost:
tags:
400:
- fees
descriptionsummary: InvalidДобавление IDсписания suppliedпользователю
operationId: addUserFee
content: { }parameters:
- name: UID
security: in: path
- KEYdescription: [UID ]пользователя
x-codegen-request-body-namerequired: body
/payments/types:
true
schema:
get: type: integer
tags: format: int64
- payments
name: SUM
summary in: Получитьpath
список типов оплат
description: Возвращает список типов оплат
Сумма списания
required: true
schema:
operationId: getPaymentTypesList
responsestype: integer
200:
format: int64
descriptionrequestBody: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentTypesArrayUserFeeAdd'
security:
required: true
- KEYresponses:
[ ]
/payments/users/{UID}:
get400:
tags:
description: Invalid ID supplied
- payments
summary: Получить списокcontent: оплат{ пользователя}
descriptionsecurity:
Возвращает список оплат пользователя
- operationIdKEY: getUserPayments
parameters:[ ]
- x-codegen-request-body-name: UIDbody
/abon/tariffs:
in: pathget:
description: UID пользователяtags:
- required: trueabon
summary: Получить список schema:ТП
description: Возвращает type: integerсписок ТП
formatoperationId: int64getAbonTps
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaymentsArrayAbonTpsArray'
security:
- KEY: [ ]
post:
tags:
- paymentsabon
summary: Добавление оплаты пользователюТП
operationId: addUserPayment addAbonTp
requestBody:
parameters content:
- nameapplication/json: UID
schema:
in: path
description$ref: UID пользователя'#/components/schemas/AbonAddTp'
required: true
schemaresponses:
type: integer200:
description: Успешное format: int64выполнение
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaymentAddApiSuccessAddResponse'
security:
required: true
- responsesKEY: [ ]
x-codegen-request-body-name: body
400/abon/tariffs/{ID}:
get:
descriptiontags:
Invalid ID supplied
- abon
contentsummary: Получить {информацию о }ТП
security:description: Возвращает информацию о ТП
operationId: getAbonTp
- KEYparameters:
[ ]
x-codegen-request-body-- name: bodyID
/fees/types: in: path
get:
tagsdescription: ID ТП
-required: feestrue
summary schema:
Получить список типов списания
descriptiontype: integer
Возвращает список типов списания
operationIdformat: getFeesTypesListint64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/FeesTypesArrayAbonTp'
security:
- KEY: [ ]
/fees/abon/tariffs/{ID}/users/{UID}:
getpost:
tags:
- feesabon
summary: ПолучитьДобавление список списаний пользователя
description: Возвращает список списаний пользователяТП пользователю
operationId: getUserFeesaddAbonTpToUser
parameters:
- name: UIDID
in: path
description: UIDID пользователяТП
required: true
schema:
type: integer
format: int64
responses:
- name: UID
200in: path
description: УспешноеUID выполнениепользователя
contentrequired: true
schema:
application/json:
type: integer
schema:
format: int64
$refresponses: '#/components/schemas/UserFeesArray'
security200:
- KEYdescription: [Успешное ]
/fees/users/{UID}/{SUM}:
выполнение
content:
post:
tagsapplication/json:
- fees
summaryschema:
Добавление списания пользователю
operationId: addUserFee
parameters:$ref: '#/components/schemas/ApiSuccessAddResponse'
- name: UIDsecurity:
- KEY: in:[ path]
delete:
descriptiontags: UID пользователя
- abon
required: true
summary: Удаление ТП пользователя
schema:
description: Удаление ТП пользователя
typeoperationId: integergetUserAbonTps
format: int64parameters:
- name: SUMID
in: path
description: СуммаID списанияТП
required: true
schema:
type: integer
format: int64
requestBody:
- name: UID
contentin: path
application/json:
description: UID пользователя
required: true
schema:
type: integer
$ref: '#/components/schemas/UserFeeAdd'
requiredformat: trueint64
responses:
400200:
description: InvalidУспешное ID suppliedвыполнение
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/abon/tariffsusers:
get:
tags:
- abon
summary: Получить список ТПпользователей Abon
description: Возвращает список пользователей ТПAbon
operationId: getAbonTpsgetUsersAbon
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/AbonTpsArrayAbonUsersArray'
security:
- KEY: [ ]
/online/{UID}:
post get:
tags:
- abononline
summary: Получить сессии пользователя по UID
description: Возвращает Добавлениесессии ТПпользователя
operationId: addAbonTpgetUserSessions
requestBodyparameters:
content- name: UID
application/jsonin: path
description: schema:
UID пользователя в биллинге
required: true
schema:
$ref: '#/components/schemas/AbonAddTp'
type: integer
requiredformat: trueint64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponseOnlineSessionsArray'
security 404:
- KEYdescription: Пользователь [не ]найден
x-codegen-request-body-name: body
/abon/tariffs/{ID}:
content:
get:
tagsapplication/json:
- abon
summary: Получить информацию о ТПschema:
description: Возвращает информацию о ТП
operationId$ref: getAbonTp'#/components/schemas/ApiResponse'
parameterssecurity:
- nameKEY: ID[ ]
in: path/version:
description: ID ТПget:
required: truetags:
- schema:version
summary: Получить версии биллинга и type: integerAPI
formatoperationId: int64getVersion
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/AbonTp'
security:
- KEY: [ ]
/abon/tariffs/{ID}/users/{UID}:
post:Version'
tagssecurity:
- abon KEY: [ ]
components:
schemas:
summary: Добавление ТП пользователюUser:
operationIdtype: addAbonTpToUserobject
parametersproperties:
- namelogin: ID
intype: pathstring
descriptionexample: ID ТПtestUser
requiredpassword: true
schematype: string
typeexample: integer"123456"
formatcreateBill:
int64
- nametype: UIDinteger
UserPi:
intype: pathobject
properties:
description: UID пользователяfio:
requiredtype: truestring
schemadescription: Фамилия
typeexample: integerПетренко
fio2:
format: int64
responsestype: string
200 description: Имя
descriptionexample: Успешное выполнениеИван
contentfio3:
application/json:type: string
description: Отчество
schema:
example: Петрович
$refcomments: '#/components/schemas/ApiSuccessAddResponse'
securitytype: string
- KEY: [ ]email:
delete:
tagstype: string
- abonphone:
summary: Удаление ТП пользователя
type: string
description: Удаление ТП пользователяUserContactAdd:
operationIdtype: getUserAbonTpsobject
parametersproperties:
- namevalue: ID
intype: pathstring
description: ID ТП Контакт - email, телефон
requiredexample: true1234567889
schematypeId:
type: integer
description: Вид format:контакта
int64
- nameexample: UID2
inpriority: path
descriptiontype: UID пользователяinteger
requireddescription: trueПриоритет
schemaexample: 1
UserCreated:
type: integerobject
properties:
format preAdd:
int64
responsestype: integer
200 example: 1
description: Успешное выполнениеtotal:
contenttype: { }integer
security:
example: 0
- KEY: [ ]
/abon/usersinsertId:
get:
tagstype: string
- abon example: "17"
summary uid:
Получить список пользователей Abon
descriptiontype: string
Возвращает список пользователей Abon
operationIdexample: getUsersAbon"32"
responses affected:
200 type: integer
descriptionexample: 1
Успешное выполнение
login:
content:
type: string
application/json:
example: testUser
UserInternetList:
schematype: array
items:
$ref: '#/components/schemas/AbonUsersArrayUserInternetList_inner'
UserInternet:
security type: object
properties:
- KEY: [ ]
/online/{UID}tpId:
get:
tagstype: integer
- online
example: 41
summarycid:
Получить сессии пользователя по UID
description: Возвращает сессии пользователя
type: string
operationIdexample: getUserSessions
14:11:11:11:11:c1
parameters activate:
- nametype: UIDstring
inexample: path0000-00-00
expire:
description: UID пользователя вtype: биллингеstring
requiredexample: true0000-00-00
UserInternetActivate:
schematype: object
properties:
typetpId:
integer
type: integer
format: int64
responsesexample: 41
200status:
descriptiontype: Успешное выполнениеinteger
contentexample: 1
application/json:default: 0
cid:
schema:
type: string
$ref: '#/components/schemas/OnlineSessionsArray'example: 14:11:11:11:11:c1
404serviceExpire:
descriptiontype: Пользователь не найденstring
content:example: 0000-00-00
application/json:default: 0000-00-00
serviceActivate:
schema:
type: string
$ref: '#/components/schemas/ApiResponse'example: 0000-00-00
security:
default: 0000-00-00
- KEY: [ ]
/versionstatusDays:
get:
tagstype: string
- version
summarydefault: Получить''
версии биллинга и API
operationIdpersonalTp: getVersion
responses:
200:type: integer
descriptiondefault: Успешное выполнение0
contentcomments:
application/json:type: string
example: Абонент попросил 2 schema:услугу
$refdefault: '#/components/schemas/Version'
security staticIpPool:
- KEY: [ ]
components:
schemas: type: string
User:
typedefault: object''
properties:
login:port:
type: stringinteger
exampledefault: testUser0
passwordnasId:
type: stringinteger
exampledefault: "123456"0
createBillserverVlan:
type: integerstring
UserPi:
typedefault: object''
properties vlan:
fio type: integer
type: stringdefault: 0
ipv6Mask:
descriptiontype: Фамилияinteger
exampledefault: Петренко32
fio2ivp6:
type: string
descriptiondefault: Имя'2001:0db8:85a3:0000:0000:8a2e:0370:7334'
ipv6Prefix:
example: Иван
fio3type: integer
typeipv6PrefixMask: string
descriptiontype: Отчествоinteger
exampledefault: Петрович32
commentsstaticIpv6Pool:
type: string
email default: ''
UserInternetChange:
type: stringobject
phoneproperties:
typeid: string
UserContactAdd:
type: objectinteger
properties: example: 41
valuestatus:
type: stringinteger
descriptionexample: Контакт - email, телефон1
exampledefault: 12345678890
typeIdcid:
type: integerstring
description: Вид контактаexample: 14:11:11:11:11:c1
serviceExpire:
exampletype: 2string
priority:example: 0000-00-00
typedefault: integer0000-00-00
descriptionserviceActivate: Приоритет
exampletype: 1string
UserCreated:
typeexample: object0000-00-00
properties: default: 0000-00-00
preAddstatusDays:
type: integerstring
exampledefault: 1''
totalpersonalTp:
type: integer
exampledefault: 0
insertIdcomments:
type: string
example: "17": Абонент попросил 2 услугу
default: ''
uidstaticIpPool:
type: string
exampledefault: "32"''
affectedport:
type: integer
exampledefault: 10
loginnasId:
type: stringinteger
exampledefault: testUser0
UserInternetList serverVlan:
type: arraystring
items: default: ''
$refvlan: '#/components/schemas/UserInternetList_inner'
UserInternet:
type: objectinteger
properties: default: 0
tpIdipv6Mask:
type: integer
exampledefault: 4132
cidivp6:
type: string
exampledefault: 14:11:11:11:11:c1'2001:0db8:85a3:0000:0000:8a2e:0370:7334'
ipv6Prefix:
type: integer
activateipv6PrefixMask:
type: stringinteger
exampledefault: 0000-00-0032
expirestaticIpv6Pool:
type: string
exampledefault: 0000-00-00''
UserIptvList:
type: array
items:
$ref: '#/components/schemas/UserIptvList_inner'
Contacts:
type: object
properties:
value:
type: string
example: test@gmail.com
type:
type: string
description: _SHOW - отобразить поле
example: _SHOW
typeName:
type: string
example: _SHOW
ContactsArray:
type: array
items:
$ref: '#/components/schemas/ContactsArray_inner'
Tp:
type: object
properties:
id:
type: integer
example: 2
tpId:
type: integer
example: 83
dayFee:
type: integer
monthFee:
type: integer
module:
type: string
example: Internet
changePrice:
type: integer
activPrice:
type: integer
serviceId:
type: integer
status:
type: integer
TpIntervals:
type: array
items:
$ref: '#/components/schemas/TpIntervals_inner'
Groups:
type: array
items:
$ref: '#/components/schemas/Groups_inner'
Msgs:
type: object
properties:
uid:
type: integer
example: 11135
chapter:
type: integer
example: 2
message:
type: string
example: Test message
state:
type: integer
example: 0
subject:
type: string
example: Message subject
priority:
type: integer
example: 2
MsgsReply:
type: object
properties:
aid:
type: integer
example: 2
reply_text:
type: string
example: Reply text
MsgsRepliesList:
type: array
items:
$ref: '#/components/schemas/MsgsRepliesList_inner'
MsgsReplyAttachment:
type: object
properties:
filename:
type: string
example: Test.txt
filesize:
type: integer
example: 12
content:
type: string
example: ' Test content'
content_type:
type: string
example: text/plain
message_type:
type: integer
example: 1
MsgsChapter:
type: array
items:
$ref: '#/components/schemas/MsgsChapter_inner'
Districts:
type: object
properties:
name:
type: string
example: пос.Зуевка
city:
type: string
example: Харцызск
zip:
type: string
DistrictsArray:
type: array
items:
$ref: '#/components/schemas/DistrictsArray_inner'
Streets:
type: object
properties:
name:
type: string
example: ул.Цэемовская
district_id:
type: integer
example: 2
second_name:
type: string
StreetsArray:
type: array
items:
$ref: '#/components/schemas/StreetsArray_inner'
Builds:
type: object
properties:
street_id:
type: integer
example: 2
number:
type: string
BuildsArray:
type: array
items:
$ref: '#/components/schemas/BuildsArray_inner'
PaymentTypesArray:
type: array
items:
$ref: '#/components/schemas/PaymentTypesArray_inner'
UserPaymentsArray:
type: array
items:
$ref: '#/components/schemas/UserPaymentsArray_inner'
UserPaymentAdd:
type: object
properties:
sum:
type: integer
example: 500
method:
type: integer
example: 6
bill_id:
type: integer
example: 10
FeesTypesArray:
type: array
items:
$ref: '#/components/schemas/FeesTypesArray_inner'
UserFeesArray:
type: array
items:
$ref: '#/components/schemas/UserFeesArray_inner'
UserFeeAdd:
type: object
properties:
method:
type: integer
example: 6
bill_id:
type: integer
example: 10
describe:
type: string
AbonTpsArray:
type: array
items:
$ref: '#/components/schemas/AbonTpsArray_inner'
AbonAddTp:
type: object
properties:
price:
type: integer
example: 100
period:
type: integer
example: 1
name:
type: string
example: Test abon TP
description:
type: string
example: Test description
AbonTp:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Test abon TP
price:
type: integer
example: 100
userPortal:
type: integer
example: 0
userCount:
type: integer
example: 10
discount:
type: integer
example: 0
paymentType:
type: integer
example: 0
periodAlignment:
type: integer
example: 1
nextAbonDate:
type: string
example: 2021-10-01
description:
type: string
AbonUsersArray:
type: array
items:
$ref: '#/components/schemas/AbonUsersArray_inner'
OnlineSessionsArray:
type: array
items:
$ref: '#/components/schemas/OnlineSessionsArray_inner'
Version:
type: object
properties:
version:
type: string
example: 0.91.0
apiVersion:
type: string
example: "0.01"
billing:
type: string
example: Abills
ApiResponse:
type: object
properties:
errstr:
type: string
example: ERROR_NOT_EXIST
errno:
type: integer
example: 2
ApiSuccessAddResponse:
type: object
properties:
total:
type: integer
example: 0
affected:
type: integer
example: 1
insertId:
type: integer
example: 37
UserLogin:
type: object
properties:
login:
type: string
example: testuser
password:
type: string
example: testuser
inline_response_200:
type: object
properties:
login:
type: string
example: testuser
sid:
type: string
example: sW44EJZLyWDMeXAV
uid:
type: string
example: "5690"
UserInternetList_inner:
type: object
properties:
id:
type: integer
example: 2
tpName:
type: string
example: Премиум до 100м
tpId:
type: integer
example: 41
internetStatus:
type: integer
example: 0
cid:
type: string
example: 14:11:11:11:11:c1
monthFee:
type: integer
example: 250
dayFee:
type: integer
example: 0
UserIptvList_inner:
type: object
properties:
id:
type: integer
example: 2
tpName:
type: string
example: Премиум Iptvportal
tpId:
type: integer
example: 41
serviceStatus:
type: integer
example: 0
monthFee:
type: integer
example: 250
dayFee:
type: integer
example: 0
serviceId:
type: integer
example: 0
subscribeId:
type: integer
example: 0
filterId:
type: integer
example: 0
ContactsArray_inner:
type: object
properties:
id:
type: integer
example: 1
uid:
type: string
example: "132"
value:
type: string
example: test@gmail.com
typeName:
type: string
example: Email
TpIntervals_inner:
type: object
properties:
begin:
type: string
example: 00:00:00
end:
type: string
example: 23:59:59
id:
type: integer
example: 2
tarif:
type: string
trafficClasses:
type: string
day:
type: integer
Groups_inner:
type: object
properties:
id:
type: integer
example: 53
name:
type: string
example: Должники
descr:
type: string
domainId:
type: integer
disableChgTp:
type: integer
example: 1
MsgsRepliesList_inner:
type: object
properties:
id:
type: integer
example: 2
text:
type: string
example: Reply text
aid:
type: integer
example: 2
admin:
type: string
example: abills
datetime:
type: string
example: 2021-08-09 13:25:41
mainMsg:
type: integer
example: 40
MsgsChapter_inner:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: Первый раздел
responsible:
type: integer
example: 1
innerChapter:
type: integer
example: 0
autoclose:
type: integer
example: 50
DistrictsArray_inner:
type: object
properties:
id:
type: integer
example: 10
name:
type: string
example: пос.Зуевка
city:
type: string
example: Харцызск
zip:
type: string
streetCount:
type: integer
example: 31
StreetsArray_inner:
type: object
properties:
id:
type: integer
example: 10
streetName:
type: string
example: ул.Цэемовская
districtId:
type: integer
example: 2
buildCount:
type: integer
example: 31
BuildsArray_inner:
type: object
properties:
id:
type: integer
example: 10
streetName:
type: string
example: ул.Цэемовская
streetId:
type: integer
example: 2
number:
type: string
example: "31"
PaymentTypesArray_inner:
type: object
properties:
id:
type: integer
example: 10
name:
type: string
example: Credit card
feesType:
type: integer
example: 0
color:
type: string
UserPaymentsArray_inner:
type: object
properties:
id:
type: integer
example: 10
sum:
type: integer
example: 500
regDate:
type: string
example: 2021-07-02 07:46:01
method:
type: integer
example: 6
innerDescribe:
type: string
FeesTypesArray_inner:
type: object
properties:
id:
type: integer
example: 10
name:
type: string
example: Пеня
sum:
type: integer
example: 500
defaultDescribe:
type: string
UserFeesArray_inner:
type: object
properties:
id:
type: integer
example: 10
sum:
type: integer
example: 500
regDate:
type: string
example: 2021-07-02 07:46:01
method:
type: integer
example: 2
dsc:
type: string
example: 'Internet: М/А Премиум до 100м (41) - Распределение абонплаты'
AbonTpsArray_inner:
type: object
properties:
tpId:
type: integer
example: 1
name:
type: string
example: Test abon TP
price:
type: integer
example: 100
userPortal:
type: integer
example: 0
userCount:
type: integer
example: 10
discount:
type: integer
example: 0
paymentType:
type: integer
example: 0
periodAlignment:
type: integer
example: 1
nextAbonDate:
type: string
example: 2021-10-01
description:
type: string
AbonUsersArray_inner:
type: object
properties:
tpId:
type: integer
example: 1
tpName:
type: string
example: Test abon TP
price:
type: integer
example: 100
serviceCount:
type: integer
example: 1
date:
type: string
example: 2021-08-11
nextAbon:
type: string
example: 2021-09-01
uid:
type: integer
example: 11135
login:
type: string
example: "3433"
OnlineSessionsArray_inner:
type: object
properties:
clientIpNum:
type: integer
example: 3232238092
nasId:
type: integer
example: 12
duration:
type: string
example: 838:59:59
status:
type: integer
example: 10
userName:
type: string
example: userName
clientIp:
type: string
example: 192.168.10.12
acctSessionId:
type: string
example: Akie6VpiYU
OnuList:
type: array
items:
type: object
properties:
id:
type: number
example: 3
dhcpPort:
type: string
example: 0/01/3/002
nasId:
type: number
example: 17
onuId:
type: number
example: 2
onuSnmpId:
type: number
example: 268501760
ponType:
type: string
example: gpon
snmpId:
type: number
example: 268501760
vlan:
type: number
example: 0
OltList:
type: array
items:
type: object
properties:
id:
type: number
example: 3
marking:
type: string
example: example
datetime:
type: string
example: 2020-12-01 12:14:12
serial:
type: string
example: example
UserList:
type: array
items:
type: object
properties:
deposit:
type: number
example: 36579.21
fio:
type: string
example: Иванов Иван
uid:
type: integer
example: 1
gid:
type: integer
example: 1
login:
type: string
example: testuser
billId:
type: integer
example: 12
UsedPorts:
type: object
properties:
5c:F4:Ab:C6:Db:De:
type: array
items:
type: object
properties:
nasMngPassword:
type: string
example: ''
authType:
type: integer
example: 1
nasName:
type: string
example: zyxel_lab
nasDisable:
type: integer
example: 0
id:
type: integer
example: 100
ip:
type: string
example: "172.17.0.2"
disable:
type: integer
example: 0
nasIp:
type: string
example: "172.17.0.2"
nasId:
type: number
example: 100
nasAlive:
type: number
example: 0
mac:
type: string
example: 5c:f4:ab:c6:db:de
nasType:
type: string
example: dhcp
nasRadPairs:
type: string
example: ''
securitySchemes:
KEY:
type: apiKey
name: KEY
in: header |
...