openapi: 3.0.1
info:
title: Abills useradmins API
version: 0.0.11
servers:
- url: https://demo.abills.net.ua:9443/api.cgi
tags:
- name: userusers
description: Работа с пользователемпользователями
- name: internetgroups
description: Работа с услугой ИнтернетГруппы пользователей
- name: msgstp
description: Работа с заявками пользователяТарифные планы
- name: abonmsgs
description: Работа с периодическими списаниямиMsgs
- name: paysysinternet
description: Работа с платежными системамиInternet
- name: configiptv
description: Все доступные конфигурацииIptv
- name: contactsabon
description: РаботаAbon
с- контактами
pathsname: districts
/users/login: description: Районы
- name: post:streets
description: Улицы
- tagsname: builds
description: Дома
- -name: userpayments
description: Оплаты
- summaryname: Авторизацияfees
пользователя
description: Списания
- operationIdname: loginUseronline
description: Сессии requestBody:пользователя
- name: version
contentdescription: Версии
- name: equipment
description: Работа '*/*'с оборудованием
paths:
/equipment/onu/list/:
get:
schematags:
- equipment
$refsummary: '#/components/schemas/UserLoginBody'
Список ONU
operationId: getOneList
required parameters:
true
- responsesname: branch
200 in: query
description: Параметр Успешноекоторый возвращает выполнениебиллинг
contentschema:
application/jsontype: boolean
default: schema:false
- name: branchDesc
$ref: '#/components/schemas/UserLogin'
/user/{UID}: in: query
get:
tags:
description: Параметр который возвращает биллинг
- userschema:
summary: Информация о пользователе type: boolean
operationId: userInfo
default: parameters:false
- name: UIDvlanId
in: pathquery
description: Параметр который UIDвозвращает пользователябиллинг
requiredschema:
true
schematype: boolean
typedefault: stringfalse
- responsesname: onuId
200 in: query
description: Успешное выполнениеПараметр который возвращает биллинг
contentschema:
application/jsontype: boolean
default: schema:false
- name: onuVlan
$ref: '#/components/schemas/User'
in: query
security:
- USER_SIDdescription: [Параметр ]
который /user/{UID}/pi:возвращает биллинг
get:
tagsschema:
- user
summarytype: Персональная информация пользователяboolean
operationId: userPersonalInfo
parametersdefault: false
- name: UIDonuDesc
in: pathquery
description: Параметр который UIDвозвращает пользователябиллинг
requiredschema:
true
schematype: boolean
typedefault: stringfalse
- responsesname: onuBillingDesc
200 in: query
description: Параметр Успешноекоторый возвращает выполнениебиллинг
contentschema:
application/jsontype: boolean
default: schema:false
- name: oltRxPower
$ref: '#/components/schemas/UserPi'
in: query
security:
- USER_SIDdescription: [Параметр ]
который /user/{UID}/credit:возвращает биллинг
get:
tagsschema:
- user
summarytype: Информация об установке кредитаboolean
operationId: userCreditInfo
default: parameters:false
- name: UIDonuDhcpPort
in: pathquery
description: UIDПараметр пользователя
который required: trueвозвращает биллинг
schema:
type: stringboolean
responses:
default: 200:false
- descriptionname: Успешное выполнениеonuGraph
contentin: query
application/jsondescription:
Параметр который возвращает биллинг
schema:
type: boolean
$ref: '#/components/schemas/UserCreditInfo'
securitydefault: false
- USER_SIDname: [ ]nasIp
post:
tagsin: query
- user
description: Параметр который возвращает биллинг
summary: Установка кредита пользователю
operationIdschema: userSetCredit
parameters:
type: boolean
- namedefault: UIDfalse
- inname: pathonuSnmpId
descriptionin: UID пользователяquery
required: truedescription: Параметр который возвращает биллинг
schema:
type: stringboolean
responses:
200default: false
- descriptionname: Успешное выполнениеdateTime
contentin: query
application/jsondescription:
Параметр который возвращает биллинг
schema:
type: boolean
$ref: '#/components/schemas/UserCredit'
securitydefault: false
- USER_SID: [ ]
/user/{UID}/internet:name: serverVlan
in: query
get:
tags:description: Параметр который возвращает биллинг
- internetschema:
summary: Информация об интернет услугахtype: пользователяboolean
operationId: userInternetInfo
default: parameters:false
- name: UIDgid
in: pathquery
description: Параметр UIDкоторый возвращает пользователябиллинг
requiredschema:
true
schematype: boolean
typedefault: stringfalse
responses- name: traffic
200in: query
description: Успешное выполнениеПараметр который возвращает биллинг
contentschema:
application/jsontype: boolean
default: schema:false
- name: login
$ref: '#/components/schemas/UserInternet'
securityin: query
- USER_SIDdescription: [Параметр ]
который /user/{UID}/internet/{ID}:возвращает биллинг
put:
tagsschema:
- internet
summarytype: Смена ТПboolean
operationId: userChangeInternetTP
default: parameters:false
- name: UIDuserMac
in: pathquery
description: Параметр который UIDвозвращает пользователябиллинг
requiredschema:
true
schematype: boolean
typedefault: stringfalse
- name: IDmacBehindOnu
in: pathquery
description: Параметр IDкоторый услугивозвращает Интернетбиллинг
requiredschema:
true
schematype: boolean
typedefault: stringfalse
- requestBodyname: distance
contentin: query
'*/*':
description: Параметр который возвращает биллинг
schema:
type: boolean
$refdefault: '#/components/schemas/body'false
- requiredname: trueexternalSystemLink
responsesin: query
200: description: Параметр который возвращает биллинг
description: Успешное выполнение
schema:
type: boolean
contentdefault: false
- name: sort
application/json:
in: query
description: Сортировка по одному параметру выше
schema:
type: string
$ref: '#/components/schemas/InternetChangeTPSuccess' responses:
400200:
description: успешное Ошибкавыполнение
content:
application/json:
schema:
$ref: '#/components/schemas/InternetChangeTPErrorOnuList'
security:
- USER_SIDKEY: [ ]
x-codegen-request-body-name: body
/user/{UID}/internet/{ID}/speed/equipment/box/list/:
get:
tags:
- internetequipment
summary: СкоростьСписок ТПOLT
operationId: userTpSpeedgetOltList
parameters:
- name: UIDsort
in: pathquery
description: UIDСортировка пользователя
по одному required: trueпараметру выше
schema:
type: string
- name: IDpageRows
in: pathquery
description: IDКоличество услуги Интернетзаписей
requiredschema:
true
schematype: integer
typedefault: string100000
responses:
200:
description: Успешноеуспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/InternetSpeedOltList'
security:
- USER_SIDKEY: [ ]
/userequipment/{UID}used/internetports/{ID}/holdup:
postget:
tags:
- internetequipment
summary: ПриостановлениеСписок услугииспользованных Интернетпортов
operationId: userInternetHoldupgetUsedPorts
parameters:
- name: UIDnasId
in: pathquery
description: UIDПоиск пользователя
required: trueпо nasId
schema:
type: string
- name: IDportsOnly
in: pathquery
description: IDтолько услуги Интернетпорты
requiredschema: true
schema:
type: boolean
- typename: stringfullList
requestBody:
in: query
content:
description: '*/*':
полный список
schema:
$ref: '#/components/schemas/body_1'
required: truetype: boolean
responses:
200:
description: Успешноеуспешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/HoldupReplyUsedPorts'
security:
- USER_SIDKEY: [ ]
x-codegen-request-body-name: body/users/login:
deletepost:
tags:
- internetusers
summary: Удаление рассписания на приостановление услуги ИнтернетАвторизация пользователя
operationId: userDeleteInternetHolduploginUser
parametersrequestBody:
- namecontent: UID
in: path'*/*':
description: UID пользователяschema:
required: true
$ref: '#/components/schemas/UserLogin'
schema:
required: true
type: stringresponses:
- name200: ID
indescription: pathУспешное выполнение
descriptioncontent:
ID услуги Интернет
application/json:
required: true
schema:
type: string
$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: addUserInternet
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
/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
- 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/{UID}/iptv:
get:
tags:
- iptv
summary: Получить список ТП Iptv пользователя
description: Возвращает ТП Iptv пользователя
operationId: getUserIptvByUID
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserIptvList'
404:
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/users/{UID}/iptv/{ID}:
get:
tags:
- iptv
summary: Информация об Iptv услуге пользователя по ID услуги
operationId: iptvInfoUser
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: [ ]
/msgs/:
post:
tags:
- 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/{ID}:
get:
tags:
- msgs
summary: Получить сообщение по ID
description: Возвращает сообщение
operationId: getMsgsInfoByID
parameters:
- name: ID
in: path
description: ID сообщения
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Msgs'
404:
description: Сообщение не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/msgs/list:
post:
tags:
- msgs
summary: Получить список сообщений
operationId: msgsList
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/{ID}/reply:
get:
tags:
- msgs
summary: Ответы на сообщение
operationId: repliesListToMsgs
parameters:
- name: ID
in: path
description: ID сообщения
required: true
schema:
type: integer
format: int64
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsRepliesList'
security:
- KEY: [ ]
post:
tags:
- msgs
summary: Ответить на сообщение
operationId: addReplyToMsgs
parameters:
- name: ID
in: path
description: ID сообщения
required: true
schema:
type: integer
format: int64
requestBody:
description: Параметры, которые нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsReply'
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:
post:
tags:
- msgs
summary: Прикрепление файла к ответу
operationId: addAttachmentToReply
parameters:
- name: REPLY_ID
in: path
description: ID ответа на сообщение
required: true
schema:
type: integer
format: int64
requestBody:
description: Параметры, которые нужно указать
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsReplyAttachment'
required: true
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/msgs/chapters:
get:
tags:
- msgs
summary: Получить список разделов
operationId: chaptersList
responses:
200:
description: успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsChapter'
security:
- KEY: [ ]
/groups:
get:
tags:
- groups
summary: Получить группы пользователей
description: Возвращает группы пользователей
operationId: getGroupsList
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Groups'
security:
- KEY: [ ]
/tp/{tpID}:
get:
tags:
- tp
summary: Получить информацию по тарифному плану
description: Возвращает тарифный план
operationId: getTpInfo
parameters:
- name: tpID
in: path
description: tpID тарифного плана
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Tp'
404:
description: Тарифный план не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/tp/{tpID}/intervals/:
get:
tags:
- tp
summary: Получить информацию по интервалам ТП
description: Возвращает интервалы ТП
operationId: getTpIntervalsInfo
parameters:
- name: tpID
in: path
description: tpID тарифного плана
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/TpIntervals'
404:
description: Тарифный план не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- KEY: [ ]
/districts:
get:
tags:
- districts
summary: Получить районы
description: Возвращает список районов
operationId: getDistricts
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/DistrictsArray'
security:
- KEY: [ ]
post:
tags:
- districts
summary: Добавление района
operationId: addDistrict
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Districts'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/districts/{ID}:
get:
tags:
- districts
summary: Получить информацию о районе
operationId: getDistrictInfo
parameters:
- name: ID
in: path
description: ID района
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/Districts'
security:
- KEY: [ ]
put:
tags:
- districts
summary: Обновить информацию о районе
operationId: updateDistrict
parameters:
- name: ID
in: path
description: ID района
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Districts'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/streets:
get:
tags:
- streets
summary: Получить улицы
description: Возвращает список улиц
operationId: getStreets
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/StreetsArray'
security:
- KEY: [ ]
post:
tags:
- streets
summary: Добавление района
operationId: addStreet
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Streets'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/streets/{ID}:
get:
tags:
- streets
summary: Получить информацию о улице
description: Возвращает улицу
operationId: 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/UserFeesArray'
security:
- KEY: [ ]
/fees/users/{UID}/{SUM}:
post:
tags:
- fees
summary: Добавление списания пользователю
operationId: addUserFee
parameters:
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: int64
- name: SUM
in: path
description: Сумма списания
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserFeeAdd'
required: true
responses:
400:
description: Invalid ID supplied
content: { }
security:
- KEY: [ ]
x-codegen-request-body-name: body
/abon/tariffs:
get:
tags:
- abon
summary: Получить список ТП
description: Возвращает список ТП
operationId: getAbonTps
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/AbonTpsArray'
security:
- KEY: [ ]
post:
tags:
- abon
summary: Добавление ТП
operationId: addAbonTp
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AbonAddTp'
required: true
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSuccessAddResponse'
security:
- KEY: [ ]
x-codegen-request-body-name: body
/abon/tariffs/{ID}:
get:
tags:
- abon
summary: Получить информацию о ТП
description: Возвращает информацию о ТП
operationId: getAbonTp
parameters:
- name: ID
in: path
description: ID ТП
required: true
schema:
type: integer
format: int64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/HoldupReplyAbonTp'
security:
- USER_SIDKEY: [ ]
/abon/usertariffs/{UIDID}/internetusers/tariffs{UID}:
getpost:
tags:
- internetabon
summary: Добавление ТП пользователю
operationId: addAbonTpToUser
parameters:
- name: ID
in: Доступные для изменения ТП, на которые хватает денег path
description: ID ТП
required: true
schema:
type: integer
operationId: userInternetAvailableToChangeTariffs
format: parameters:int64
- name: UID
in: path
description: UID пользователя
required: true
schema:
type: integer
format: stringint64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserAvailableTariffsApiSuccessAddResponse'
security:
- USER_SIDKEY: [ ]
/user/{UID}/internet/tariffs/all:
getdelete:
tags:
- internetabon
summary: Все доступные для изменения ТП
operationId: userInternetAvailableToChangeTariffsAllУдаление ТП пользователя
parametersdescription:
- name: UID
in: path
description: UIDУдаление ТП пользователя
requiredoperationId: truegetUserAbonTps
schemaparameters:
- typename: stringID
responses:
200:
description: Успешное выполнениеin: path
content:
description: ID ТП
application/json:
required: true
schema:
type: integer
$ref: '#/components/schemas/UserAvailableTariffs'
securityformat: int64
- USER_SID: [ ]
/user/{UID}/internet/{ID}/warnings:name: UID
get:
tagsin: path
- internet
description: UID пользователя
summary: Информация оrequired: списанияхtrue
operationId: userInternetWarnings
schema:
parameters:
- nametype: UIDinteger
informat: pathint64
responses:
description: UID пользователя200:
requireddescription: Успешное trueвыполнение
schemacontent:
{ }
type: stringsecurity:
- nameKEY: ID[ ]
/abon/users:
in: pathget:
tags:
description: ID услуги
- abon
requiredsummary: true
Получить список пользователей Abon
schemadescription:
Возвращает список пользователей Abon
typeoperationId: stringgetUsersAbon
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/InternetWarningsAbonUsersArray'
security:
- USER_SIDKEY: [ ]
/useronline/{UID}/abon:
get:
tags:
- abononline
summary: Информация об периодических списаниях Получить сессии пользователя по UID
description: Возвращает сессии пользователя
operationId: userAbonInfogetUserSessions
parameters:
- name: UID
in: path
description: UID пользователя в биллинге
required: true
schema:
type: integer
format: stringint64
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/UserAbonOnlineSessionsArray'
security 404:
- USER_SIDdescription: [Пользователь ]
/user/{UID}/msgs:не найден
get:
tagscontent:
- msgsapplication/json:
summary: Список заявок пользователя
operationIdschema:
userMsgsList
parameters:
- name$ref: UID'#/components/schemas/ApiResponse'
security:
in: path
- KEY: [ ]
/version:
description: UID пользователяget:
tags:
required: true
- version
schemasummary:
Получить версии биллинга и API
typeoperationId: stringgetVersion
responses:
200:
description: Успешное выполнение
content:
application/json:
schema:
$ref: '#/components/schemas/MsgsArrayVersion'
security:
- USER_SIDKEY: [ ]
postcomponents:
tagsschemas:
- msgs
summary: Создание заявкиUser:
operationIdtype: userAddMessageobject
parametersproperties:
- namelogin: UID
intype: pathstring
descriptionexample: UID пользователяtestUser
requiredpassword: true
schematype: string
type: string
requestBody:example: "123456"
contentcreateBill:
'*/*':type: integer
schemaUserPi:
type: object
$ref: '#/components/schemas/MsgsAdd'properties:
requiredfio: true
responses:
200:type: string
description: Успешное выполнениеФамилия
contentexample: Петренко
application/jsonfio2:
type: schema:string
description: Имя
$ref: '#/components/schemas/MsgsAdded'
securityexample: Иван
- USER_SID: [ ]
fio3:
x-codegen-request-body-name: body
/user/{UID}/msgs/{ID}:type: string
get:
tagsdescription: Отчество
- msgs
example: Петрович
summary comments:
Информация о заявке пользователя
operationIdtype: userMsgsstring
parameters email:
- nametype: UIDstring
inphone: path
descriptiontype: UID пользователяstring
UserContactAdd:
requiredtype: trueobject
properties:
schema value:
type: string
description: Контакт - name:email, IDтелефон
inexample: path1234567889
description: ID заявкиtypeId:
requiredtype: trueinteger
schemadescription:
Вид контакта
type: string
responsesexample: 2
200priority:
descriptiontype: Успешное выполнениеinteger
contentdescription: Приоритет
example: 1
application/jsonUserCreated:
type: object
schemaproperties:
preAdd:
$ref type: '#/components/schemas/MsgsInfo'integer
security:
example: 1
- USER_SID: [ ]
/user/{UID}/msgs/{ID}/replytotal:
get:
tagstype: integer
- msgs
example: 0
summary insertId:
Список заявок пользователя
operationIdtype: userMsgReplyListstring
parameters: example: "17"
- nameuid: UID
intype: pathstring
descriptionexample: UID пользователя"32"
requiredaffected: true
schematype: integer
typeexample: string1
- namelogin: ID
intype: pathstring
example: testUser
descriptionUserInternetList:
ID заявки
type: array
requireditems: true
schema:$ref: '#/components/schemas/UserInternetList_inner'
UserInternet:
type: stringobject
responsesproperties:
200tpId:
descriptiontype: Успешное выполнениеinteger
contentexample: 41
application/jsoncid:
type: string
schema:
example: 14:11:11:11:11:c1
$ref: '#/components/schemas/MsgsReplyArray'activate:
security:
type: string
- USER_SID: [ ]
post:example: 0000-00-00
tags expire:
-type: msgsstring
summary: Создание заявки
example: 0000-00-00
operationIdUserIptvList: userAddReply
parameterstype: array
- name: UIDitems:
in$ref: path'#/components/schemas/UserIptvList_inner'
Contacts:
descriptiontype: UID пользователяobject
required: trueproperties:
schemavalue:
type: string
- nameexample: IDtest@gmail.com
intype: path
descriptiontype: ID заявкиstring
requireddescription: true
_SHOW - отобразить поле
schema:
example: _SHOW
typetypeName: string
requestBody:
content:type: string
'*/*':example: _SHOW
ContactsArray:
type: schema:array
items:
$ref: '#/components/schemas/MsgsReplyAddContactsArray_inner'
required: trueTp:
responsestype: object
200properties:
description: Успешное выполнениеid:
contenttype: { }integer
security:
- USER_SID: [ ]
x-codegen-request-body-name: body
/user/{UID}/msgs/chapters:example: 2
get tpId:
tagstype: integer
- msgs
example: 83
summary dayFee:
Список разделов заявок пользователя
operationIdtype: userMsgsChaptersinteger
parameters monthFee:
- nametype: UIDinteger
inmodule: path
descriptiontype: UID пользователяstring
requiredexample: trueInternet
schemachangePrice:
type: stringinteger
responses activPrice:
200 type: integer
serviceId:
description: Успешное выполнение
type: integer
content:
status:
application/json:
type: integer
TpIntervals:
schematype: array
items:
$ref: '#/components/schemas/MsgsArrayChaptersTpIntervals_inner'
securityGroups:
- USER_SIDtype: [ ]array
/user/{UID}/paysys/systems:
getitems:
tags:
- paysys$ref: '#/components/schemas/Groups_inner'
summary: Список платежных систем доступных пользователюMsgs:
operationIdtype: userPaysysListobject
parametersproperties:
- nameuid: UID
intype: pathinteger
descriptionexample: UID пользователя11135
requiredchapter: true
schematype: integer
example: 2
type: string
responsesmessage:
200 type: string
descriptionexample: УспешноеTest выполнениеmessage
contentstate:
application/json:type: integer
example: 0
schema:
subject:
$reftype: '#/components/schemas/PaysysArray'string
security:
example: Message subject
- USER_SID: [ ]
/user/{UID}/configpriority:
get:
tagstype: integer
- config example: 2
MsgsReply:
summary: Список доступных конфигурацийtype: пользователяobject
operationIdproperties:
userConfig
parametersaid:
- nametype: UIDinteger
inexample: path2
description: UID пользователяreply_text:
requiredtype: truestring
schemaexample:
Reply text
MsgsRepliesList:
type: stringarray
responsesitems:
200:$ref: '#/components/schemas/MsgsRepliesList_inner'
MsgsReplyAttachment:
descriptiontype: Успешное выполнение
object
properties:
contentfilename:
application/json:type: string
example: Test.txt
schema:
filesize:
$reftype: '#/components/schemas/UserConfig'integer
security:
example: 12
- USER_SID: [ ]
/currencycontent:
get:
tagstype: string
- config
example: ' Test content'
summary: Валюта на биллинге
content_type:
operationId: billingCurrency
responsestype: string
200: example: text/plain
description: Успешное выполнениеmessage_type:
contenttype: integer
application/json:
example: 1
MsgsChapter:
schematype: array
items:
$ref: '#/components/schemas/BillingCurrencyMsgsChapter_inner'
/version Districts:
get type: object
tagsproperties:
- configname:
summary: Получить версии биллинга иtype: APIstring
operationId: getVersion
responses:example: пос.Зуевка
200city:
descriptiontype: Успешное выполнениеstring
contentexample: Харцызск
zip:
application/json:
type: string
DistrictsArray:
schematype: array
items:
$ref: '#/components/schemas/Version'
/user/{UID}/paysys/pay:DistrictsArray_inner'
postStreets:
tagstype: object
properties:
- paysys
summaryname:
Формирование ссылки на быструю оплату
operationIdtype: userPaysysPaystring
parameters:
- nameexample: UIDул.Цэемовская
in: pathdistrict_id:
descriptiontype: UID пользователяinteger
requiredexample: true2
schemasecond_name:
type: string
StreetsArray:
requestBodytype: array
contentitems:
$ref: '*/*':#/components/schemas/StreetsArray_inner'
Builds:
type: schema:object
properties:
$refstreet_id: '#/components/schemas/PaysysPayBody'
requiredtype: trueinteger
responsesexample: 2
200number:
descriptiontype: Успешное выполнениеstring
BuildsArray:
contenttype: array
items:
application/json:
$ref: '#/components/schemas/BuildsArray_inner'
PaymentTypesArray:
type: schema:array
items:
$ref: '#/components/schemas/PaysysPay'PaymentTypesArray_inner'
UserPaymentsArray:
securitytype: array
items:
- USER_SID: [ ]
$ref: '#/user/{UID}/paysys/transaction/status:components/schemas/UserPaymentsArray_inner'
postUserPaymentAdd:
tagstype: object
properties:
- paysys
sum:
summary: Проверка статуса платежа
operationIdtype: userPaysysTransactionStatusinteger
parameters example: 500
- namemethod: UID
intype: pathinteger
descriptionexample: UID пользователя6
required: truebill_id:
schematype: integer
example: 10
type FeesTypesArray: string
requestBodytype: array
contentitems:
$ref: '*/*':#/components/schemas/FeesTypesArray_inner'
UserFeesArray:
type: schema:array
items:
$ref: '#/components/schemas/PaysysTransactionStatusBodyUserFeesArray_inner'
UserFeeAdd:
requiredtype: true
object
properties:
responsesmethod:
200 type: integer
example: 6
description: Успешное выполнениеbill_id:
type: integer
contentexample: 10
describe:
application/json:
type: string
AbonTpsArray:
schematype: array
items:
$ref: '#/components/schemas/PaysysTransactionStatusAbonTpsArray_inner'
securityAbonAddTp:
type: object
- USER_SID: [ ]
/user/{UID}/contacts/push/subscribeproperties:
post:
tagsprice:
- contacts
type: integer
summary: Подписка на Push уведомления
example: 100
operationId: userPushSubscribeCreate
parametersperiod:
- nametype: UIDinteger
inexample: path1
description: UID пользователяname:
requiredtype: truestring
schemaexample:
Test abon TP
typedescription: string
requestBody:
content:type: string
'*/*'example:
Test description
AbonTp:
schematype: object
properties:
$refid: '#/components/schemas/PushSubscribeCreateBody'
requiredtype: trueinteger
responses: example: 1
200name:
descriptiontype: Успешное выполнениеstring
contentexample:
Test abon TP
application/jsonprice:
type: integer
schema:
example: 100
$ref: '#/components/schemas/PushSubscribe'userPortal:
security:
type: integer
- USER_SID: [ ]
deleteexample: 0
tags userCount:
-type: contactsinteger
summary: Отписка от Pushexample: уведомления10
operationId: userPushSubscribeDelete
discount:
parameterstype: integer
- nameexample: UID0
inpaymentType: path
descriptiontype: UID пользователяinteger
requiredexample: true0
schemaperiodAlignment:
type: stringinteger
responsesexample: 1
200nextAbonDate:
descriptiontype: Успешное выполнениеstring
content:
example: 2021-10-01
description:
application/json:
type: string
AbonUsersArray:
schematype: array
items:
$ref: '#/components/schemas/PushSubscribeAbonUsersArray_inner'
securityOnlineSessionsArray:
- USER_SIDtype: [ ]array
get:
tagsitems:
- contacts$ref: '#/components/schemas/OnlineSessionsArray_inner'
summary: Получить FCM токенVersion:
operationIdtype: userPushSubscribeGetobject
parametersproperties:
- nameversion: UID
intype: pathstring
descriptionexample: UID пользователя0.91.0
requiredapiVersion: true
schematype: string
example: type: string
"0.01"
responsesbilling:
200 type: string
descriptionexample: Успешное выполнениеAbills
ApiResponse:
contenttype: object
application/jsonproperties:
errstr:
schema:
type: string
$ref: '#/components/schemas/PushSubscribeInfo'
example: ERROR_NOT_EXIST
securityerrno:
- USER_SID: [ ]
components:
schemas:type: integer
example: 2
UserApiSuccessAddResponse:
type: object
properties:
logintotal:
type: stringinteger
example: "3433"0
depositaffected:
type: integer
example: 16001
creditinsertId:
type: integer
example: 37
UserLogin:
type: 100 object
properties:
creditDatelogin:
type: string
example: 2021-08-13testuser
billIdpassword:
type: integerstring
example: 12testuser
gidinline_response_200:
type: integerobject
example: 57properties:
disablelogin:
type: integerstring
example: 0testuser
deletedsid:
type: integerstring
example: 0sW44EJZLyWDMeXAV
UserPi uid:
type: object
type: string
properties:
fioexample: "5690"
UserInternetList_inner:
type: stringobject
example: Иванов Иван Ивановичproperties:
addressFullid:
type: stringinteger
example: ул.Адамца, 121, 3 example: 2
agetpName:
type: integerstring
example: Премиум до 33100м
locationIdtpId:
type: integer
example: 144441
contractIdinternetStatus:
type: stringinteger
example: "575493"0
emailcid:
type: arraystring
items: example: 14:11:11:11:11:c1
monthFee:
type: stringinteger
example: test@gmail.com250
phonedayFee:
type: arrayinteger
itemsexample: 0
UserIptvList_inner:
type: stringobject
properties:
example: "380976574568" id:
UserInternet:
type: arrayinteger
itemsexample: 2
$ref: '#/components/schemas/UserInternet_inner'tpName:
InternetSpeed:
type: arraystring
items: example: Премиум Iptvportal
$ref: '#/components/schemas/InternetSpeed_inner'tpId:
UserAbon:
type: arrayinteger
itemsexample: 41
$ref: '#/components/schemas/UserAbon_inner'serviceStatus:
UserCredit:
type: objectinteger
properties: example: 0
creditSummonthFee:
type: integer
example: 500250
creditChangePricedayFee:
type: integer
example: 1000
uidserviceId:
type: integer
example: 111350
creditDayssubscribeId:
type: stringinteger
example: "3"0
creditMonthChangesfilterId:
type: stringinteger
example: "1"0
UserCreditInfoContactsArray_inner:
type: object
properties:
creditChgPriceid:
type: stringinteger
example: "500"1
creditMonthChangesuid:
type: string
example: "1132"
creditSumvalue:
type: string
example: "800"test@gmail.com
creditDaystypeName:
type: string
example: "3"Email
UserAvailableTariffsTpIntervals_inner:
type: arrayobject
itemsproperties:
$ref: '#/components/schemas/UserAvailableTariffs_inner'begin:
HoldupReply:
type: objectstring
properties:example: 00:00:00
successend:
type: integerstring
example: 123:59:59
msgid:
type: stringinteger
InternetWarnings:
typeexample: object
properties:2
messageTypetarif:
type: string
example: success
warningtrafficClasses:
type: string
example: следующее списание через 7 дней
day:
type: daysToFee:integer
Groups_inner:
type: stringobject
example: "2"properties:
sumid:
type: integer
example: 15053
abonDatename:
type: string
example: 2021-10-01Должники
InternetChangeTPSuccess:
descr:
type: object
propertiestype: string
successdomainId:
type: integer
disableChgTp:
example: 1
type: uid:integer
typeexample: integer1
InternetChangeTPErrorMsgsRepliesList_inner:
type: object
properties:
errorid:
type: integer
example: 1452
messagetext:
type: string
messageType example:
Reply text
typeaid:
string
messageTitletype: integer
typeexample: string2
MsgsAddadmin:
type: objectstring
propertiesexample: abills
chapterdatetime:
type: integerstring
example: 3 2021-08-09 13:25:41
messagemainMsg:
type: stringinteger
example: Some message40
MsgsChapter_inner:
subject:
type: object
typeproperties: string
exampleid:
Message subject
prioritytype: integer
typeexample: integer2
examplename: 2
MsgsAdded:
type: objectstring
propertiesexample: Первый раздел
insertIdresponsible:
type: integer
example: 431
msgIdinnerChapter:
type: integer
example: 430
affectedautoclose:
type: integer
example: 150
MsgsInfoDistrictsArray_inner:
type: object
properties:
subjectid:
type: stringinteger
example: Message user api subject10
messagename:
type: string
example: Test message from user apiпос.Зуевка
chapterNamecity:
type: string
example: Второй разделХарцызск
chapterzip:
type: integerstring
streetCount:
example: 3
type: priority:integer
typeexample: integer31
StreetsArray_inner:
example: 2type: object
properties:
stateid:
type: integer
example: 010
datestreetName:
type: string
example: 2021-09-02 13:20:37 ул.Цэемовская
districtId:
MsgsArray:
type: arrayinteger
items: example: 2
$ref: '#/components/schemas/MsgsInfo'buildCount:
MsgsArrayChapters:
type: arrayinteger
items:
$refexample: '#/components/schemas/MsgsChapter'31
MsgsReplyBuildsArray_inner:
type: object
properties:
uidid:
type: integer
example: 010
aidstreetName:
type: integerstring
example: 2ул.Цэемовская
idstreetId:
type: integer
example: 542
textnumber:
type: string
example: some reply text: "31"
PaymentTypesArray_inner:
type: object
properties:
datetimeid:
type: stringinteger
example: 2021-09-02 12:50:47 10
name:
MsgsReplyAdd:
type: objectstring
properties: example: Credit card
reply_textfeesType:
type: stringinteger
example: Some reply text0
reply_subjectcolor:
type: string
UserPaymentsArray_inner:
exampletype: Subjectobject
MsgsReplyArray properties:
type: array
id:
itemstype: integer
$ref example: '#/components/schemas/MsgsReply'
10
bodysum:
type: objectinteger
propertiesexample: 500
tp_idregDate:
type: integerstring
example: 42021-07-02 07:46:01
datemethod:
type: stringinteger
example: 2021-09-176
periodinnerDescribe:
type: integerstring
bodyFeesTypesArray_1inner:
type: object
properties:
from_dateid:
type: stringinteger
example: 2021-08-1410
to_datename:
type: string
example: 2021-08-17Пеня
UserInternet_inner:
type: object
properties:
idsum:
type: integer
example: 2500
tpNamedefaultDescribe:
type: string
UserFeesArray_inner:
example: Премиум до 100мtype: object
properties:
tpIdid:
type: integer
example: 4110
internetStatussum:
type: integer
example: 0500
cidregDate:
type: string
example: 14:11:11:11:11:c1 2021-07-02 07:46:01
monthFeemethod:
type: integer
example: 2502
dayFeedsc:
type: integerstring
example: 'Internet: 0 М/А Премиум до 100м (41) - Распределение абонплаты'
InternetSpeedAbonTpsArray_inner:
type: object
properties:
inSpeedtpId:
type: integer
example: 29991
outSpeedname:
type: integerstring
example: Test 3000abon TP
tpNumprice:
type: integer
example: 155100
UserAbon_inner userPortal:
type: objectinteger
properties: example: 0
iduserCount:
type: integer
example: 210
namediscount:
type: stringinteger
example: Test abon TP0
pricepaymentType:
type: integer
example: 1000
periodperiodAlignment:
type: integer
example: 1
nextAbonnextAbonDate:
type: string
example: 2021-0910-01
commentsdescription:
type: string
AbonUsersArray_inner:
description:
type: object
typeproperties: string
example: Test descriptiontpId:
UserAvailableTariffs_inner:
type: objectinteger
properties: example: 1
idtpName:
type: integerstring
example: 2Test abon TP
nameprice:
type: stringinteger
example: Премиум до 100м100
tpIdserviceCount:
type: integer
example: 411
monthFeedate:
type: integerstring
example: 2502021-08-11
dayFeenextAbon:
type: integerstring
example: 02021-09-01
commentsuid:
type: string
integer
PaysysArrayexample: 11135
type: array
login:
items:
type: string
$refexample: '#/components/schemas/PaymentSystem'"3433"
PaymentSystemOnlineSessionsArray_inner:
type: object
properties:
idclientIpNum:
type: integer
example: 13232238092
namenasId:
type: stringinteger
example: LiqPay12
moduleduration:
type: string
example: Liqpay.pm838:59:59
PaysysPayBody status:
type: objectinteger
propertiesexample: 10
systemIduserName:
type: integerstring
example: 1userName
sumclientIp:
type: integerstring
example: 100192.168.10.12
operationIdacctSessionId:
type: string
example: 123456789Akie6VpiYU
PaysysPayOnuList:
type: objectarray
propertiesitems:
operationIdtype: object
typeproperties: string
exampleid: 123456789
transactionId:
type: stringnumber
example: Liqpay:1234567893
url dhcpPort:
type: string
example: https://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789
0/01/3/002
PaysysTransactionStatusnasId:
type: objectnumber
properties example: 17
idonuId:
type: integernumber
example: 12
datetimeonuSnmpId:
type: stringnumber
example: "2022-01-01 01:01:01"
268501760
loginponType:
type: string
example: testgpon
status snmpId:
type: integernumber
example: 1268501760
systemIdvlan:
type: integernumber
example: 10
OltList:
sum:
type: array
typeitems: integer
exampletype: 100object
uidproperties:
typeid:
integer
exampletype: 1number
transactionId:
typeexample: string3
examplemarking:
Liqpay:123456789
PaysysTransactionStatusBody:
type: objectstring
properties:
example: transactionId:example
typedatetime:
string
exampletype: Liqpay:123456789string
UserLoginBody:
type: object
example: properties:2020-12-01 12:14:12
login serial:
type: string
example: testuserexample
passwordUserList:
type: stringarray
example: testuser
items:
UserLogin:
type: object
properties:
logindeposit:
type: stringnumber
example: testuser36579.21
sid fio:
type: string
example: sW44EJZLyWDMeXAV
Иванов Иван
uid:
type: integer
example: 1
UserConfiggid:
type: objectinteger
properties example: 1
cardsUserPaymentlogin:
type: integerstring
example: 6testuser
docsActsList billId:
type: integer
example: 912
UsedPorts:
docsInvoicesListtype: object
properties:
type: integer5c:F4:Ab:C6:Db:De:
exampletype: 8array
docsReceiptList items:
type: integerobject
example properties:
5
internetUserInfo:
nasMngPassword:
type: integer
exampletype: 3string
internetUserStats:
typeexample: integer''
example: 10
authType:
msgsUser:
type: integer
example: 1
paysysPayment:
nasName:
type: integer
exampletype: 4string
paysysSubscribe:
typeexample: integerzyxel_lab
example: 7
nasDisable:
paysysUserLog:
type: integer
example: 2
MsgsChapterexample: 0
type: object
propertiesid:
id:
type: integer
example: 1
name:example: 100
type: string
ip:
example: Example chapter
BillingCurrency:
type: objectstring
properties:
system_currency:
example: "172.17.0.2"
type: integer
exampledisable: 980
Version:
type: object
type: properties:integer
version:
typeexample: string0
example: 0.91.0
nasIp:
apiVersion:
type: string
example: "172.17.0.012"
billing nasId:
type: stringnumber
example: Abills
PushSubscribeCreateBodyexample: 100
type: object
propertiesnasAlive:
token:
type: stringnumber
example: "d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM"
PushSubscribeexample: 0
type: object
propertiesmac:
result:
type: string
example: OK
PushSubscribeInfo:example: 5c:f4:ab:c6:db:de
type: object
propertiesnasType:
value:
type: string
example: "d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM"
dhcp
uid:
nasRadPairs:
type: integerstring
example: 1''
securitySchemes:
USER_SIDKEY:
type: apiKey
name: USERSIDKEY
in: header |