...
Open API (Swagger) Integration for Confluence |
---|
{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "Abills admins API" }, "host": "demo.abills.net.ua:9443", "license "basePath": "/api.cgi", "tags": [ { "name": "Apache 2.0users", "urldescription": "http://www.apache.org/licenses/LICENSE-2.0.htmlРабота с пользователями" }, }, { "hostname": "demo.abills.net.ua:9443groups", "basePathdescription": "/api.cgi",Группы пользователей" "tags": [ }, { "name": "Userstp", "description": "РаботаТарифные с пользователямипланы" }, ], { "schemesname": ["msgs", "https "description": "Msgs" ] }, "paths": { "/users/login": { "post": { 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": "Сессии пользователя" } ], "schemes": [ "https" ], "paths": { "/users/login": { "post": { "tags": [ "users" ], "summary": "Авторизация пользователя", "operationId": "loginUser", "produces": [ "application/json" ], "parameters": [ { "name": "login", "in": "query", "description": "Логин пользователя", "required": true, "type": "string" }, { "name": "password", "in": "query", "description": "Пароль пользователя", "required": true, "type": "string" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/inline_response_200" } } } } }, "/users/": { "post": { "tags": [ "users" ], "summary": "Добавить нового пользователя", "operationId": "addUser", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Параметры, которые нужно указать", "required": true, "schema": { "$ref": "#/definitions/User" } } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/UserCreated" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}": { "get": { "tags": [ "users" ], "summary": "Получить пользователя по UID", "description": "Возвращает пользователя", "operationId": "getUserByUID", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/User" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "put": { "tags": [ "users" ], "summary": "Обновить информацию о пользователе", "operationId": "updateUser", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "Pet object that needs to be added to the store", "required": true, "schema": { "$ref": "#/definitions/User" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] }, "delete": { "tags": [ "users" ], "summary": "Удалить пользователя", "operationId": "deleteUser", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/pi": { "get": { "tags": [ "users" ], "summary": "Получить персональную информацию о пользователе", "description": "Возвращает персональную информацию пользователя", "operationId": "getUserPiByUID", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/UserPi" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "users" ], "summary": "Добавление персональной информации пользователю", "operationId": "addUserPi", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UserPi" } } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "put": { "tags": [ "users" ], "summary": "Изменение персональной информации пользователю", "operationId": "changeUserPi", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UserPi" } } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/contacts": { "get": { "tags": [ "users" ], "summary": "Получить контакты пользователя по UID", "description": "Возвращает контакты пользователя", "operationId": "getUserContactsByUID", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ContactsArray" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "users" ], "summary": "Добавление контакта пользователю", "operationId": "updateUserContact", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/User" } } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/contacts/{ID}": { "put": { "tags": [ "users" ], "summary": "Обновить контакт пользователю", "operationId": "updateUserConctact", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "name": "ID", "in": "path", "description": "ID контакта", "required": true, "type": "integer", "format": "int64" } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "delete": { "tags": [ "users" ], "summary": "Удалить контакт пользователя", "operationId": "deleteUserContact", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" }, { "name": "ID", "in": "path", "description": "ID контакта", "required": true, "type": "integer", "format": "int64" } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/contacts": { "post": { "tags": [ "users" ], "summary": "Получить контакты", "description": "Возвращает контакты пользователей", "operationId": "getContacts", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Параметры для фильтрации контактов", "required": true, "schema": { "$ref": "#/definitions/Contacts" } } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ContactsArray" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/internet": { "get": { "tags": [ "internet" ], "summary": "Получить список ТП Internet пользователя", "description": "Возвращает ТП интернет пользователя", "operationId": "getUserInternetByUID", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/UserInternetList" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "internet" ], "summary": "Добавление ТП Internet пользователю", "operationId": "addUserInternet", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UserInternet" } } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/internet/{ID}": { "get": { "tags": [ "internet" ], "summary": "Информация об интернет услуге пользователя по ID услуги", "operationId": "internetInfoUser", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "name": "ID", "in": "path", "description": "ID услуги", "required": true, "type": "integer", "format": "int64" } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/iptv": { "get": { "tags": [ "iptv" ], "summary": "Получить список ТП Iptv пользователя", "description": "Возвращает ТП Iptv пользователя", "operationId": "getUserIptvByUID", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/UserIptvList" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/users/{UID}/iptv/{ID}": { "get": { "tags": [ "iptv" ], "summary": "Информация об Iptv услуге пользователя по ID услуги", "operationId": "iptvInfoUser", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователь", "required": true, "type": "integer", "format": "int64" }, { "name": "ID", "in": "path", "description": "ID услуги", "required": true, "type": "integer", "format": "int64" } ], "responses": { "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/": { "post": { "tags": [ "msgs" ], "summary": "Добавить сообщение", "operationId": "addMsgs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Параметры, которые нужно указать", "required": true, "schema": { "$ref": "#/definitions/Msgs" } } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/{ID}": { "get": { "tags": [ "msgs" ], "summary": "Получить сообщение по ID", "description": "Возвращает сообщение", "operationId": "getMsgsInfoByID", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID сообщения", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Msgs" } }, "404": { "description": "Сообщение не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/list": { "post": { "tags": [ "msgs" ], "summary": "Получить список сообщений", "operationId": "msgsList", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Параметры, по которым можно фильтровать сообщения", "required": true, "schema": { "$ref": "#/definitions/Msgs" } } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/{ID}/reply": { "get": { "tags": [ "msgs" ], "summary": "Ответы на сообщение", "operationId": "repliesListToMsgs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID сообщения", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/MsgsRepliesList" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "msgs" ], "summary": "Ответить на сообщение", "operationId": "addReplyToMsgs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID сообщения", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "Параметры, которые нужно указать", "required": true, "schema": { "$ref": "#/definitions/MsgsReply" } } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/reply/{REPLY_ID}/attachment": { "post": { "tags": [ "msgs" ], "summary": "Прикрепление файла к ответу", "operationId": "addAttachmentToReply", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "REPLY_ID", "in": "path", "description": "ID ответа на сообщение", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "description": "Параметры, которые нужно указать", "required": true, "schema": { "$ref": "#/definitions/MsgsReplyAttachment" } } ], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/msgs/chapters": { "get": { "tags": [ "msgs" ], "summary": "Получить список разделов", "operationId": "chaptersList", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "успешное выполнение", "schema": { "$ref": "#/definitions/MsgsChapter" } } }, "security": [ { "KEY": [] } ] } }, "/groups": { "get": { "tags": [ "groups" ], "summary": "Получить группы пользователей", "description": "Возвращает группы пользователей", "operationId": "getGroupsList", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Groups" } } }, "security": [ { "KEY": [] } ] } }, "/tp/{tpID}": { "get": { "tags": [ "tp" ], "summary": "Получить информацию по тарифному плану", "description": "Возвращает тарифный план", "operationId": "getTpInfo", "produces": [ "application/json" ], "parameters": [ { "name": "tpID", "in": "path", "description": "tpID тарифного плана", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Tp" } }, "404": { "description": "Тарифный план не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/tp/{tpID}/intervals/": { "get": { "tags": [ "tp" ], "summary": "Получить информацию по интервалам ТП", "description": "Возвращает интервалы ТП", "operationId": "getTpIntervalsInfo", "produces": [ "application/json" ], "parameters": [ { "name": "tpID", "in": "path", "description": "tpID тарифного плана", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/TpIntervals" } }, "404": { "description": "Тарифный план не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } }, "/districts": { "get": { "tags": [ "districts" ], "summary": "Получить районы", "description": "Возвращает список районов", "operationId": "getDistricts", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/DistrictsArray" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "districts" ], "summary": "Добавление района", "operationId": "addDistrict", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Districts" } } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/districts/{ID}": { "get": { "tags": [ "districts" ], "summary": "Получить информацию о районе", "operationId": "getDistrictInfo", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID района", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Districts" } } }, "security": [ { "KEY": [] } ] }, "put": { "tags": [ "districts" ], "summary": "Обновить информацию о районе", "operationId": "updateDistrict", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID района", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Districts" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] } }, "/streets": { "get": { "tags": [ "streets" ], "summary": "Получить улицы", "description": "Возвращает список улиц", "operationId": "getStreets", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/StreetsArray" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "streets" ], "summary": "Добавление района", "operationId": "addStreet", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Streets" } } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/streets/{ID}": { "get": { "tags": [ "streets" ], "summary": "Получить информацию о улице", "description": "Возвращает улицу", "operationId": "getStreetInfo", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID улицы", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Streets" } } }, "security": [ { "KEY": [] } ] }, "put": { "tags": [ "streets" ], "summary": "Обновить информацию о улице", "operationId": "updateStreet", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID улицы", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Streets" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] } }, "/builds": { "get": { "tags": [ "builds" ], "summary": "Получить дома", "description": "Возвращает список домов", "operationId": "getBuilds", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/BuildsArray" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "builds" ], "summary": "Добавление дома", "operationId": "addBuild", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Builds" } } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/builds/{ID}": { "get": { "tags": [ "builds" ], "summary": "Получить информацию о доме", "description": "Возвращает дом", "operationId": "getBuildInfo", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID дома", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/Builds" } } }, "security": [ { "KEY": [] } ] }, "put": { "tags": [ "builds" ], "summary": "Обновить информацию о доме", "operationId": "updateBuild", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID дома", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/Builds" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] } }, "/payments/types": { "get": { "tags": [ "payments" ], "summary": "Получить список типов оплат", "description": "Возвращает список типов оплат", "operationId": "getPaymentTypesList", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/PaymentTypesArray" } } }, "security": [ { "KEY": [] } ] } }, "/payments/users/{UID}": { "get": { "tags": [ "payments" ], "summary": "Получить список оплат пользователя", "description": "Возвращает список оплат пользователя", "operationId": "getUserPayments", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/UserPaymentsArray" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "payments" ], "summary": "Добавление оплаты пользователю", "operationId": "addUserPayment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UserPaymentAdd" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] } }, "/fees/types": { "get": { "tags": [ "fees" ], "summary": "Получить список типов списания", "description": "Возвращает список типов списания", "operationId": "getFeesTypesList", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/FeesTypesArray" } } }, "security": [ { "KEY": [] } ] } }, "/fees/users/{UID}": { "get": { "tags": [ "fees" ], "summary": "Получить список списаний пользователя", "description": "Возвращает список списаний пользователя", "operationId": "getUserFees", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/UserFeesArray" } } }, "security": [ { "KEY": [] } ] } }, "/fees/users/{UID}/{SUM}": { "post": { "tags": [ "fees" ], "summary": "Добавление списания пользователю", "operationId": "addUserFee", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" }, { "name": "SUM", "in": "path", "description": "Сумма списания", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UserFeeAdd" } } ], "responses": { "400": { "description": "Invalid ID supplied" } }, "security": [ { "KEY": [] } ] } }, "/abon/tariffs": { "get": { "tags": [ "abon" ], "summary": "Получить список ТП", "description": "Возвращает список ТП", "operationId": "getAbonTps", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/AbonTpsArray" } } }, "security": [ { "KEY": [] } ] }, "post": { "tags": [ "abon" ], "summary": "Добавление ТП", "operationId": "addAbonTp", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AbonAddTp" } } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] } }, "/abon/tariffs/{ID}": { "get": { "tags": [ "abon" ], "summary": "Получить информацию о ТП", "description": "Возвращает информацию о ТП", "operationId": "getAbonTp", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID ТП", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/AbonTp" } } }, "security": [ { "KEY": [] } ] } }, "/abon/tariffs/{ID}/users/{UID}": { "post": { "tags": [ "abon" ], "summary": "Добавление ТП пользователю", "operationId": "addAbonTpToUser", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID ТП", "required": true, "type": "integer", "format": "int64" }, { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/ApiSuccessAddResponse" } } }, "security": [ { "KEY": [] } ] }, "delete": { "tags": [ "abon" ], "summary": "Удаление ТП пользователя", "description": "Удаление ТП пользователя", "operationId": "getUserAbonTps", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "ID ТП", "required": true, "type": "integer", "format": "int64" }, { "name": "UID", "in": "path", "description": "UID пользователя", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение" } }, "security": [ { "KEY": [] } ] } }, "/abon/users": { "get": { "tags": [ "abon" ], "summary": "Получить список пользователей Abon", "description": "Возвращает список пользователей Abon", "operationId": "getUsersAbon", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/AbonUsersArray" } } }, "security": [ { "KEY": [] } ] } }, "/online/{UID}": { "get": { "tags": [ "online" ], "summary": "Получить сессии пользователя по UID", "description": "Возвращает сессии пользователя", "operationId": "getUserSessions", "produces": [ "application/json" ], "parameters": [ { "name": "UID", "in": "path", "description": "UID пользователя в биллинге", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Успешное выполнение", "schema": { "$ref": "#/definitions/OnlineSessionsArray" } }, "404": { "description": "Пользователь не найден", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "KEY": [] } ] } } }, "securityDefinitions": { "KEY": { "type": "apiKey", "name": "KEY", "in": "header" } }, "definitions": { "User": { "type": "object", "properties": { "login": { "type": "string", "example": "testUser" }, "password": { "type": "string", "example": "123456" }, "createBill": { "type": "integer" } } }, "UserPi": { "type": "object", "properties": { "fio": { "type": "string", "example": "Петренко", "description": "Фамилия" }, "fio2": { "type": "string", "example": "Иван", "description": "Имя" }, "fio3": { "type": "string", "example": "Петрович", "description": "Отчество" }, "comments": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "UserCreated": { "type": "object", "properties": { "preAdd": { "type": "integer", "example": 1 }, "total": { "type": "integer", "example": 0 }, "insertId": { "type": "string", "example": "17" }, "uid": { "type": "string", "example": "32" }, "affected": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "testUser" } } }, "UserInternetList": { "type": "array", "items": { "$ref": "#/definitions/UserInternetList_inner" } }, "UserInternet": { "type": "object", "properties": { "tpId": { "type": "integer", "example": 41 }, "cid": { "type": "string", "example": "14:11:11:11:11:c1" }, "activate": { "type": "string", "example": "0000-00-00" }, "expire": { "type": "string", "example": "0000-00-00" } } }, "UserIptvList": { "type": "array", "items": { "$ref": "#/definitions/UserIptvList_inner" } }, "Contacts": { "type": "object", "properties": { "value": { "type": "string", "example": "test@gmail.com" }, "type": { "type": "string", "example": "_SHOW", "description": "_SHOW - отобразить поле" }, "typeName": { "type": "string", "example": "_SHOW" } } }, "ContactsArray": { "type": "array", "items": { "$ref": "#/definitions/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": "#/definitions/TpIntervals_inner" } }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/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": "#/definitions/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": "#/definitions/MsgsChapter_inner" } }, "Districts": { "type": "object", "properties": { "name": { "type": "string", "example": "пос.Зуевка" }, "city": { "type": "string", "example": "Харцызск" }, "zip": { "type": "string" } } }, "DistrictsArray": { "type": "array", "items": { "$ref": "#/definitions/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": "#/definitions/StreetsArray_inner" } }, "Builds": { "type": "object", "properties": { "street_id": { "type": "integer", "example": 2 }, "number": { "type": "string" } } }, "BuildsArray": { "type": "array", "items": { "$ref": "#/definitions/BuildsArray_inner" } }, "PaymentTypesArray": { "type": "array", "items": { "$ref": "#/definitions/PaymentTypesArray_inner" } }, "UserPaymentsArray": { "type": "array", "items": { "$ref": "#/definitions/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": "#/definitions/FeesTypesArray_inner" } }, "UserFeesArray": { "type": "array", "items": { "$ref": "#/definitions/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": "#/definitions/AbonTpsArray_inner" } }, "AbonAddTp": { "type": "object", "properties": { "price": { "type": "integer", "example": 100 }, "period": { "tagstype": ["integer", "Usersexample": 1 ]}, "summaryname": "Авторизация пользователя", { "operationIdtype": "loginUserstring", "producesexample": [ "Test "application/json"abon TP" ]}, "parametersdescription": [ { "nametype": "loginstring", "inexample": "queryTest description", } "description": "Логин пользователя",} }, "requiredAbonTp": true,{ "type": "stringobject", },"properties": { "id": { "nametype": "passwordinteger", "inexample": "query",1 "description": "Пароль пользователя"}, "requiredname": true,{ "type": "string", "example": "Test abon }TP" ]}, "responsesprice": { "200type": {"integer", "descriptionexample": "Успешное выполнение", 100 }, "schemauserPortal": { "$reftype": "#/definitions/inline_response_200"integer", }"example": 0 }, "userCount": }{ } }"type": "integer", "/users/": { "example": 10 }, "postdiscount": { "tagstype": ["integer", "Usersexample": 0 ]}, "summarypaymentType": "Добавить{ нового пользователя", "operationIdtype": "addUserinteger", "consumesexample": [0 "application/json" }, ],"periodAlignment": { "producestype": ["integer", "application/json"example": 1 ]}, "parametersnextAbonDate": [{ {"type": "string", "inexample": "body2021-10-01", }, "namedescription": "body", { "descriptiontype": "Параметры, которые нужно указать", string" } } "required": true }, "AbonUsersArray": { "schematype": {"array", "items": { "$ref": "#/definitions/UserAbonUsersArray_inner" } }, } "OnlineSessionsArray": { }"type": "array", ],"items": { "responses$ref": {"#/definitions/OnlineSessionsArray_inner" } }, "200ApiResponse": { "descriptiontype": "успешное выполнениеobject", "schema"properties": { "$referrstr": "#/definitions/UserCreated"{ "type": "string", } }"example": "ERROR_NOT_EXIST" }, "securityerrno": [{ {"type": "integer", "KEYexample": []2 } ] } }, "/users/{UID}ApiSuccessAddResponse": { "gettype": {"object", "tagsproperties": [{ "Userstotal": { ] "type": "integer", "summaryexample": "Получить пользователя по UID",0 "description": "Возвращает пользователя"}, "operationIdaffected": "getUserByUID", { "producestype": ["integer", "application/json"example": 1 ]}, "parametersinsertId": [{ {"type": "integer", "nameexample": "UID",37 } "in": "path" } }, "inline_response_200": { "descriptiontype": "UID пользователя в биллингеobject", "properties": { "requiredlogin": true,{ "type": "integerstring", "formatexample": "int64testuser" } ], "responsessid": { "200type": {"string", "descriptionexample": "Успешное выполнениеsW44EJZLyWDMeXAV", }, "schemauid": { "$reftype": "#/definitions/Userstring", "example": } "5690" } }, }, "404UserInternetList_inner": { "descriptiontype": "Пользователь не найденobject", "schemaproperties": { "$ref"id": "#/definitions/inline_response_404"{ "type": "integer", } "example": }2 }, "securitytpName": [ { "KEYtype": []"string", } ] "example": "Премиум до 100м" }, "puttpId": { "tagstype": ["integer", "Usersexample": 41 ]}, "summaryinternetStatus": "Обновить{ информацию о пользователе", "operationIdtype": "updateUserinteger", "consumesexample": [ "application/json"0 ]}, "producescid": [{ "type": "application/jsonstring", ], "parameters"example": ["14:11:11:11:11:c1" {}, "namemonthFee": "UID", { "intype": "pathinteger", "descriptionexample": "UID пользователь", 250 }, "requireddayFee": true,{ "type": "integer", "formatexample": "int64"0 } }, }, "UserIptvList_inner": { "type": "object", "inproperties": { "bodyid",: { "nametype": "bodyinteger", "descriptionexample": "Pet object that needs to be added to the store", 2 }, "tpName": { "requiredtype": true"string", "schemaexample": "Премиум {Iptvportal" }, "$reftpId": "#/definitions/User"{ "type": "integer", } "example": }41 ]}, "responsesserviceStatus": { "400type": {"integer", "descriptionexample": "Invalid ID supplied"0 }, "404monthFee": { "descriptiontype": "Pet not found"integer", "example": 250 }, "405dayFee": { "descriptiontype": "Validation exceptioninteger", }"example": 0 }, "securityserviceId": [ { "KEYtype": []"integer", } "example": 0 ] }, "deletesubscribeId": { "tagstype": ["integer", "Usersexample": 0 ]}, "summaryfilterId": "Удалить пользователя", { "operationIdtype": "deleteUserinteger", "producesexample": [0 } "application/json" } ]}, "parameters"ContactsArray_inner": [{ "type": "object", { "properties": { "nameid": "UID",{ "intype": "pathinteger", "descriptionexample": "UID пользователя", 1 }, "requireduid": true,{ "type": "integerstring", "formatexample": "int64132" } ], "responsesvalue": { "404type": {"string", "descriptionexample": "Пользователь не найден", test@gmail.com" }, "schematypeName": { "$reftype": "#/definitions/inline_response_404"string", }"example": "Email" } }, }, "securityTpIntervals_inner": [{ "type": "object", { "properties": { "KEYbegin": []{ }"type": "string", ] "example": "00:00:00" } }, "/users/{UID}/contacts": { "getend": { "tagstype": ["string", "example": "Users23:59:59" ]}, "summaryid": "Получить контакты пользователя по UID{ "type": "integer", "descriptionexample": "Возвращает контакты пользователя", 2 "operationId": "getUserContactsByUID"}, "producestarif": [{ "application/jsontype": "string" ]}, "parameterstrafficClasses": [{ {"type": "string" }, "nameday": "UID",{ "intype": "pathinteger", } "description": "UID пользователя в биллинге"} }, "Groups_inner": { "requiredtype": true"object", "properties": { "typeid": "integer", { "formattype": "int64integer", }"example": 53 ]}, "responsesname": { "200type": {"string", "descriptionexample": "Успешное выполнениеДолжники", "schema": {}, "$ref"descr": "#/definitions/ContactsArray"{ } "type": "string" }, "404domainId": { "descriptiontype": "Пользовательinteger" не найден", }, "schemadisableChgTp": { "$reftype": "#/definitions/inline_response_404"integer", }"example": 1 } }, }, "securityMsgsRepliesList_inner": [{ "type": "object", { "properties": { "KEYid": []{ } "type": "integer", ] "example": 2 }, "posttext": { "tagstype": ["string", "Users"example": "Reply text" ]}, "summaryaid": "Добавление{ контакта пользователю", "operationIdtype": "updateUserContact", "consumes": [integer", "application/json"example": 2 ]}, "producesadmin": [{ "application/json"type": "string", ], "parameters"example": ["abills" {}, "namedatetime": "UID", { "intype": "pathstring", "descriptionexample": "UID пользователь",2021-08-09 13:25:41" }, "requiredmainMsg": true,{ "type": "integer", "formatexample": "int64"40 }, } {}, "MsgsChapter_inner": { "intype": "bodyobject", "properties": { "nameid": "body",{ "requiredtype": true"integer", "schemaexample": {2 }, "$refname": "#/definitions/User"{ "type": } "string", "example": "Первый }раздел" ]}, "responsesresponsible": { "404type": {"integer", "descriptionexample": 1 "Пользователь не найден", }, "schemainnerChapter": { "$reftype": "#/definitions/inline_response_404"integer", }"example": 0 } }, "securityautoclose": [{ {"type": "integer", "KEYexample": []50 } ]} }, "putDistrictsArray_inner": { "tagstype": ["object", "Usersproperties" ],: { "summaryid": "Обновить{ информацию о пользователе", "operationIdtype": "updateUserConctactinteger", "consumesexample": [10 }, "application/json" "name": { ], "producestype": ["string", "application/jsonexample": "пос.Зуевка" ]}, "parameterscity": [{ { "type": "string", "nameexample": "UIDХарцызск", }, "inzip": "path", { "descriptiontype": "UID пользовательstring", }, "requiredstreetCount": true,{ "type": "integer", "formatexample": "int64"31 }, } {}, "in"StreetsArray_inner": "body",{ "name"type": "bodyobject", "descriptionproperties": "Pet{ object that needs to be added to the store", "id": { "requiredtype": true"integer", "schemaexample": {10 }, "$refstreetName": "#/definitions/User"{ }"type": "string", }"example": "ул.Цэемовская" ]}, "responsesdistrictId": { "400type": {"integer", "descriptionexample": "Invalid ID supplied"2 }, "404buildCount": { "descriptiontype": "Pet not found" }integer", "405example": {31 } "description": "Validation exception"} }, }"BuildsArray_inner": { }"type": "object", "securityproperties": [{ "id": { "KEYtype": []"integer", } "example": 10 ] }, "deletestreetName": { "tagstype": ["string", "Usersexample": "ул.Цэемовская" ]}, "summarystreetId": "Удалить пользователя", { "operationIdtype": "deleteUserContactinteger", "producesexample": [2 "application/json" ]}, "parametersnumber": [{ {"type": "string", "nameexample": "UID31", } "in": "path" } }, "PaymentTypesArray_inner": { "descriptiontype": "UID пользователяobject", "properties": { "requiredid": true,{ "type": "integer", "formatexample": "int64"10 } ], "responsesname": { "404type": { "string", "descriptionexample": "ПользовательCredit не найденcard", }, "schemafeesType": { "$reftype": "#/definitions/inline_response_404"integer", }"example": 0 }, },"color": { "securitytype": ["string" } { } }, "KEYUserPaymentsArray_inner": []{ }"type": "object", ]"properties": { } },"id": { "/users/contacts": { "posttype": {"integer", "tagsexample": [10 }, "Users" "sum": { ], "summarytype": "Получить контактыinteger", "descriptionexample": "Возвращает контакты пользователей"500 }, "operationIdregDate": "getContacts", { "producestype": ["string", "application/jsonexample": "2021-07-02 07:46:01" ]}, "parametersmethod": [{ {"type": "integer", "inexample": "body", 6 }, "nameinnerDescribe": "body",{ "descriptiontype": "Параметры для фильтрации контактов",string" } "required": true, } }, "schemaFeesTypesArray_inner": { "type": "object", "$refproperties": "#/definitions/Contacts"{ "id": { } "type": "integer", } ],"example": 10 "responses": {}, "200name": { "descriptiontype": "Успешное выполнениеstring", "schemaexample": {"Пеня" }, "$refsum": "#/definitions/ContactsArray"{ }"type": "integer", }"example": 500 }, "securitydefaultDescribe": [ { "KEYtype": []"string" } ]} }, }"UserFeesArray_inner": { }, "securityDefinitionstype": {"object", "KEYproperties": { "typeid": "apiKey",{ "nametype": "KEYinteger", "inexample": "header"10 } }, "definitions": { "Usersum": { "type": "objectinteger", "propertiesexample": {500 }, "loginregDate": { "type": "string", "example": "testUser2021-07-02 07:46:01" }, "passwordmethod": { "type": "stringinteger", "example": "123456"2 }, "createBilldsc": { "type": "integer"string", "example": "Internet: М/А Премиум до 100м (41) - Распределение абонплаты" } } }, "UserCreatedAbonTpsArray_inner": { "type": "object", "properties": { "preAddtpId": { "type": "integer", "example": 1 }, "totalname": { "type": "integerstring", "example": 0 "Test abon TP" }, "insertIdprice": { "type": "stringinteger", "example": "17"100 }, "uiduserPortal": { "type": "stringinteger", "example": "32"0 }, "affecteduserCount": { "type": "integer", "example": 110 }, "logindiscount": { "type": "stringinteger", "example": "testUser" } } }, "Contacts": {0 "type": "object", "properties": { }, "valuepaymentType": { "type": "stringinteger", "example": "test@gmail.com"0 }, "typeperiodAlignment": { "type": "stringinteger", "example": "_SHOW", 1 }, "descriptionnextAbonDate": "_SHOW{ - отобразить поле" }"type": "string", "typeNameexample": { "2021-10-01" }, "typedescription": "string",{ "exampletype": "_SHOWstring" } } }, "ContactsArrayAbonUsersArray_inner": { "type": "arrayobject", "itemsproperties": { "$reftpId": "#/definitions/ContactsArray_inner" { } }"type": "integer", "ApiResponse": { "typeexample": "object",1 "properties": { }, "codetpName": { "type": "integerstring", "formatexample": "int32Test abon TP" }, "typeprice": { "type": "string"integer", "example": 100 }, "messageserviceCount": { "type": "stringinteger", "example": }1 }, }, "inline_response_200date": { "type": "objectstring", "propertiesexample": {"2021-08-11" }, "loginnextAbon": { "type": "string", "example": "testuser2021-09-01" }, "siduid": { "type": "stringinteger", "example": "sW44EJZLyWDMeXAV"11135 }, "uidlogin": { "type": "string", "example": "56903433" } } }, "inlineOnlineSessionsArray_response_404inner": { "type": "object", "properties": { "errstrclientIpNum": { "type": "stringinteger", "example": "ERROR_NOT_EXIST"3232238092 }, "errnonasId": { "type": "integer", "example": 212 }, "duration": }{ }, "ContactsArray_innertype": { "string", "typeexample": "object838:59:59", "properties": { }, "idstatus": { "type": "integer", "example": 110 }, "uiduserName": { "type": "string", "example": "132userName" }, "valueclientIp": { "type": "string", "example": "test@gmail.com192.168.10.12" }, "typeNameacctSessionId": { "type": "string", "example": "EmailAkie6VpiYU" } } } } } |