prepay-service-api v1.0.0
prepay-service-api
PrepayServiceApi - JavaScript client for prepay-service-api RESTful风格的接口文档,内容详细,极大的减少了前后端的沟通成本,同时确保代码与文档保持高度一致,极大的减少维护文档的时间。 This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.jkjn.cn/
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install prepay-service-api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var PrepayServiceApi = require('prepay-service-api');
var api = new PrepayServiceApi.HandleDataFromCollectorControllerApi()
var opts = {
'json': "json_example" // {String} json
};
api.commandJKJNCallbackUsingPOST(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
PrepayServiceApi.HandleDataFromCollectorControllerApi | commandJKJNCallbackUsingPOST | POST /xml/meter/command/callback/jkjn | 国家电网,json格式 |
PrepayServiceApi.HandleDataFromCollectorControllerApi | commandStateGridCallbackUsingPOST | POST /xml/meter/command/callback/stateGrid | 国家电网,json格式 |
PrepayServiceApi.HandleDataFromCollectorControllerApi | receiveJKJNXMLUsingPOST | POST /xml/meter/data/original/jkjn | JKJN xml格式 |
PrepayServiceApi.HandleDataFromCollectorControllerApi | receiveStateGridXMLUsingPOST | POST /xml/meter/data/original/stateGrid | 国家电网,json格式 |
PrepayServiceApi.PpsAuthRolePermissionRefApi | addRolePermissionRef | POST /ppsAuthRolePermissionRef/addRolePermissionRef | 新增角色、角色与权限关联 |
PrepayServiceApi.PpsAuthRolePermissionRefApi | disableRolePermissionRef | PUT /ppsAuthRolePermissionRef/disableRolePermissionRef/{roleId} | 禁用/启用角色、角色与权限关联 |
PrepayServiceApi.PpsAuthRolePermissionRefApi | getRoleList | GET /ppsAuthRolePermissionRef/getRoleList | 查询角色列表 |
PrepayServiceApi.PpsAuthRolePermissionRefApi | getRolePermissionRefList | GET /ppsAuthRolePermissionRef/getRolePermissionRefList | 查询角色、角色与权限关联列表 |
PrepayServiceApi.PpsAuthRolePermissionRefApi | updateRolePermissionRef | PUT /ppsAuthRolePermissionRef/updateRolePermissionRef/{roleId} | 修改角色、角色与权限关联 |
PrepayServiceApi.PpsAuthUserApi | addAuthUser | POST /ppsAuthUser/addAuthUser | 新增管理员 |
PrepayServiceApi.PpsAuthUserApi | disableAuthUser | PUT /ppsAuthUser/disableAuthUser/{authUserId} | 禁用/启用管理员 |
PrepayServiceApi.PpsAuthUserApi | updateAuthUserInfo | PUT /ppsAuthUser/updateAuthUserInfo/{authUserId} | 修改管理员信息 |
PrepayServiceApi.PpsAuthUserApi | updateAuthUserPassword | PUT /ppsAuthUser/updateAuthUserPassword/{authUserId} | 修改管理员密码 |
PrepayServiceApi.PpsConfigPriceTemplateApi | addPriceTemplate | POST /ppsConfigPriceTemplate/addPriceTemplate | 新增价格模板 |
PrepayServiceApi.PpsConfigPriceTemplateApi | disablePriceTemplate | PUT /ppsConfigPriceTemplate/disablePriceTemplate/{templateId} | 禁用/启用价格模板 |
PrepayServiceApi.PpsConfigPriceTemplateApi | getPriceTemplateList | GET /ppsConfigPriceTemplate/getPriceTemplateList | 查询价格模板List |
PrepayServiceApi.PpsConfigPriceTemplateApi | updatePriceTemplate | PUT /ppsConfigPriceTemplate/updatePriceTemplate/{templateId} | 修改价格模板 |
PrepayServiceApi.PpsDataMeterOriginalApi | getMeterOriginalData | GET /meter/original/data | 获取表计读数 |
PrepayServiceApi.PpsHardwareCollectorApi | deleteCollectorByIds | DELETE /collector/batch/delete/{ids} | 批量删除采集器 |
PrepayServiceApi.PpsHardwareCollectorApi | getCollectorById | GET /collector/detail/{id} | 唯一查 |
PrepayServiceApi.PpsHardwareCollectorApi | getCollectorPageList | GET /collector/list | 采集器-列表 |
PrepayServiceApi.PpsHardwareCollectorApi | insertCollector | POST /collector/add | 新增 |
PrepayServiceApi.PpsHardwareCollectorApi | updateCollectorById | PUT /collector/update | 更新 |
PrepayServiceApi.PpsHardwareCollectorSyncApi | getCollectorSyncPageList | GET /collectorSync/list | 记录-列表 |
PrepayServiceApi.PpsHardwareMeterApi | deleteMeterByIds | DELETE /meter/batch/delete/{ids} | 批量删除采集器 |
PrepayServiceApi.PpsHardwareMeterApi | getMeterById | GET /meter/detail/{id} | 唯一查 |
PrepayServiceApi.PpsHardwareMeterApi | getMeterPageList | GET /meter/list | 采集器-列表 |
PrepayServiceApi.PpsHardwareMeterApi | insertMeter | POST /meter/add | 新增 |
PrepayServiceApi.PpsHardwareMeterApi | updateMeterById | PUT /meter/update | 更新 |
PrepayServiceApi.PpsHardwareMeterChangedApi | getMeterChangePageList | GET /meterChanged/list | 记录-列表 |
PrepayServiceApi.PpsHardwareMeterParamApi | deleteMeterParamByIds | DELETE /meterParam/batch/delete/{ids} | 批量删除采集器 |
PrepayServiceApi.PpsHardwareMeterParamApi | getMeterParamById | GET /meterParam/detail/{id} | 唯一查 |
PrepayServiceApi.PpsHardwareMeterParamApi | getMeterParamPageList | GET /meterParam/list | 采集器-列表 |
PrepayServiceApi.PpsHardwareMeterParamApi | insertMeterParam | POST /meterParam/add | 新增 |
PrepayServiceApi.PpsHardwareMeterParamApi | updateMeterParamById | PUT /meterParam/update | 更新 |
PrepayServiceApi.PpsLocationCompanyApi | getEnergylineListByCompanyId | GET /ppsLocationCompany/getEnergylineListByCompanyId | 查询公司下线路列表 |
PrepayServiceApi.PpsLocationCompanyApi | getFeeCodeList | GET /ppsLocationCompany/getFeeCodeList | 查询收费项目List |
PrepayServiceApi.PpsLocationCompanyApi | getZoneareaListByCompanyId | GET /ppsLocationCompany/getZoneareaListByCompanyId | 查询公司下台区列表 |
PrepayServiceApi.PpsLocationDetailpartApi | addDetailpart | POST /ppsLocationDetailpart/addDetailpart | 新增部位 |
PrepayServiceApi.PpsLocationDetailpartApi | getDetailpartList | GET /ppsLocationDetailpart/getDetailpartList/{zoneareaId} | 根据台区查询部位List |
PrepayServiceApi.PpsLocationDetailpartApi | updateDetailpart | PUT /ppsLocationDetailpart/updateDetailpart | 修改部位 |
PrepayServiceApi.PpsLocationEnergylineApi | addEnergyline | POST /ppsLocationEnergyline/addEnergyline | 新增条线 |
PrepayServiceApi.PpsLocationEnergylineApi | getZoneareaListByEnergylineId | GET /ppsLocationEnergyline/getZoneareaListByEnergylineId/{energylineId} | 查询条线下台区列表 |
PrepayServiceApi.PpsLocationEnergylineApi | setEnergylineMainPowerMeter | PUT /ppsLocationEnergyline/setEnergylineMainPowerMeter/{energylineId} | 设置条线总表 |
PrepayServiceApi.PpsLocationEnergylineApi | updateEnergylineInfo | PUT /ppsLocationEnergyline/updateEnergylineInfo/{energylineId} | 修改条线信息 |
PrepayServiceApi.PpsLocationZoneareaApi | addZonearea | POST /ppsLocationZonearea/addZonearea | 新增台区 |
PrepayServiceApi.PpsLocationZoneareaApi | setZoneareaMainPowerMeter | PUT /ppsLocationZonearea/setZoneareaMainPowerMeter/{zoneareaId} | 设置台区总表 |
PrepayServiceApi.PpsLocationZoneareaApi | updateZoneareaInfo | PUT /ppsLocationZonearea/updateZoneareaInfo/{zoneareaId} | 修改台区信息 |
PrepayServiceApi.PpsLoginApi | exit | POST /ppsLogin/exit | 退出 |
PrepayServiceApi.PpsLoginApi | login | POST /ppsLogin/login | 登录 |
PrepayServiceApi.PpsPayBillApi | getPayBillDetailList | GET /ppsPayBill/getPayBillDetailList/{billTotalId} | 查询明细账单 |
PrepayServiceApi.PpsPayBillApi | getPayBillTotalList | GET /ppsPayBill/getPayBillTotalList | 查询汇总账单 |
PrepayServiceApi.PpsPayBillApi | manualGenerateBill | POST /ppsPayBill/manualGenerateBill | 手工生成账单 |
PrepayServiceApi.PpsPayUserApi | addPayUser | POST /ppsPayUser/addPayUser | 新增付费用户 |
PrepayServiceApi.PpsPayUserApi | disablePayUser | PUT /ppsPayUser/disablePayUser/{payUserId} | 禁用/启用付费用户 |
PrepayServiceApi.PpsPayUserApi | getPayUserList | GET /ppsPayUser/getPayUserList | 查询付费用户list |
PrepayServiceApi.PpsPayUserApi | updatePayUser | PUT /ppsPayUser/updatePayUser/{payUserId} | 修改付费用户 |
PrepayServiceApi.PpsPayUserRechargeApi | getPayUserRechargeList | GET /ppsPayUserRecharge/getPayUserRechargeList/{payUserId} | 查询充值记录 |
PrepayServiceApi.PpsPayUserRechargeApi | pcRecharge | POST /ppsPayUserRecharge/pcRecharge | PC端充值 |
PrepayServiceApi.PpsPayUserRemainingAmountApi | getPayUserRemainingAmountList | GET /ppsPayUserRemainingAmount/getPayUserRemainingAmountList/{payUserId} | 查询余额变更记录 |
Documentation for Models
- PrepayServiceApi.InnerPermission
- PrepayServiceApi.InnerPriceTemplate
- PrepayServiceApi.PagePpsDataMeterOriginal
- PrepayServiceApi.PagePpsHardwareCollector
- PrepayServiceApi.PagePpsHardwareCollectorSync
- PrepayServiceApi.PagePpsHardwareMeter
- PrepayServiceApi.PagePpsHardwareMeterChanged
- PrepayServiceApi.PagePpsHardwareMeterParam
- PrepayServiceApi.PpsAuthRolePermissionRefDto
- PrepayServiceApi.PpsAuthRolePermissionRefVo
- PrepayServiceApi.PpsAuthRoleVo
- PrepayServiceApi.PpsAuthUserDto
- PrepayServiceApi.PpsConfigPriceTemplateDto
- PrepayServiceApi.PpsConfigPriceTemplateVo
- PrepayServiceApi.PpsDataMeterOriginal
- PrepayServiceApi.PpsDataMeterOriginalDto
- PrepayServiceApi.PpsHardwareCollector
- PrepayServiceApi.PpsHardwareCollectorDto
- PrepayServiceApi.PpsHardwareCollectorSync
- PrepayServiceApi.PpsHardwareCollectorVo
- PrepayServiceApi.PpsHardwareMeter
- PrepayServiceApi.PpsHardwareMeterChanged
- PrepayServiceApi.PpsHardwareMeterDto
- PrepayServiceApi.PpsHardwareMeterParam
- PrepayServiceApi.PpsHardwareMeterParamDto
- PrepayServiceApi.PpsHardwareMeterParamVo
- PrepayServiceApi.PpsHardwareMeterVo
- PrepayServiceApi.PpsLocationCompanyVo
- PrepayServiceApi.PpsLocationDetailpartDto
- PrepayServiceApi.PpsLocationDetailpartVo
- PrepayServiceApi.PpsLocationEnergylineDto
- PrepayServiceApi.PpsLocationEnergylineVo
- PrepayServiceApi.PpsLocationZoneareaDto
- PrepayServiceApi.PpsLocationZoneareaVo
- PrepayServiceApi.PpsPayBillDetailVo
- PrepayServiceApi.PpsPayBillTotalVo
- PrepayServiceApi.PpsPayUserDto
- PrepayServiceApi.PpsPayUserRechargeVo
- PrepayServiceApi.PpsPayUserRemainingAmountVo
- PrepayServiceApi.PpsPayUserVo
- PrepayServiceApi.R
- PrepayServiceApi.RListPpsAuthRolePermissionRefVo
- PrepayServiceApi.RListPpsAuthRoleVo
- PrepayServiceApi.RListPpsConfigPriceTemplateVo
- PrepayServiceApi.RListPpsLocationCompanyVo
- PrepayServiceApi.RListPpsLocationDetailpartVo
- PrepayServiceApi.RListPpsLocationEnergylineVo
- PrepayServiceApi.RListPpsPayBillDetailVo
- PrepayServiceApi.RListPpsPayBillTotalVo
- PrepayServiceApi.RListPpsPayUserRechargeVo
- PrepayServiceApi.RListPpsPayUserRemainingAmountVo
- PrepayServiceApi.RListPpsPayUserVo
- PrepayServiceApi.RListstring
- PrepayServiceApi.RPagePpsDataMeterOriginal
- PrepayServiceApi.RPagePpsHardwareCollector
- PrepayServiceApi.RPagePpsHardwareCollectorSync
- PrepayServiceApi.RPagePpsHardwareMeter
- PrepayServiceApi.RPagePpsHardwareMeterChanged
- PrepayServiceApi.RPagePpsHardwareMeterParam
- PrepayServiceApi.RPpsHardwareCollectorVo
- PrepayServiceApi.RPpsHardwareMeterParamVo
- PrepayServiceApi.RPpsHardwareMeterVo
Documentation for Authorization
All endpoints do not require authorization.
6 years ago