device-management-api
v1.0.0
Published
Complete specification of Device Management API
Downloads
2
Readme
device-management-api
DeviceManagementApi - JavaScript client for device-management-api Complete specification of Device Management API This SDK is automatically generated by the Swagger Codegen project:
- API version: 1
- Package version: 1
- Build date: 2016-05-30T13:28:32.272Z
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
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 device-management-api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/device-management-api then install it via:
npm install YOUR_USERNAME/device-management-api --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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var DeviceManagementApi = require('device-management-api');
var api = new DeviceManagementApi.RestcontrollerApi()
var restDevice = new DeviceManagementApi.DeviceModel(); // {DeviceModel} information of a device
var authorization = "authorization_example"; // {String} Authorization token
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.addDeviceUsingPUT(restDevice, authorization, callback);
Documentation for API Endpoints
All URIs are relative to https://localhost:8080/dm-webapp
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DeviceManagementApi.RestcontrollerApi | addDeviceUsingPUT | PUT /dm/api/device | Add a new device DeviceManagementApi.RestcontrollerApi | addServiceUsingPUT | PUT /dm/api/admin/service | Add a service DeviceManagementApi.RestcontrollerApi | addSimUsingPUT | PUT /dm/api/sim | Add a new sim DeviceManagementApi.RestcontrollerApi | associateDeviceEquipmentUsingPUT | PUT /dm/api/associateDeviceEquipment | Associate a device to an equipment DeviceManagementApi.RestcontrollerApi | associateDeviceSimUsingPUT | PUT /dm/api/associateDeviceSim | Associate a device to a sim DeviceManagementApi.RestcontrollerApi | deleteDeviceUsingDELETE | DELETE /dm/api/device/{pImei} | Delete a device DeviceManagementApi.RestcontrollerApi | deleteServiceUsingDELETE | DELETE /dm/api/admin/service/{pName} | Delete a service DeviceManagementApi.RestcontrollerApi | deleteSimUsingDELETE | DELETE /dm/api/sim/{pNumeroSim} | Delete a sim DeviceManagementApi.RestcontrollerApi | deviceNotAssociateToEquipmentUsingGET | GET /dm/api/deviceNotAssociateToEquipment | Get the list of device not associate to an equipment DeviceManagementApi.RestcontrollerApi | deviceNotAssociateToSimUsingGET | GET /dm/api/deviceNotAssociateToSim | Get the list of device not associate to a sim DeviceManagementApi.RestcontrollerApi | deviceTypeUsingGET | GET /dm/api/deviceType | Get the list of deviceType DeviceManagementApi.RestcontrollerApi | dissociateDeviceEquipmentUsingPUT | PUT /dm/api/dissociateDeviceEquipment | Dissociate a device and an equipment DeviceManagementApi.RestcontrollerApi | dissociateDeviceSimUsingPUT | PUT /dm/api/dissociateDeviceSim | Dissociate a device and a sim DeviceManagementApi.RestcontrollerApi | getAuthoritiesUsingGET | GET /dm/api/authorities | Get the authorities of the current user DeviceManagementApi.RestcontrollerApi | getCommandHistoryUsingGET | GET /dm/api/commandHistory/{pImei} | Get the commands history of one device DeviceManagementApi.RestcontrollerApi | getDeviceUsingGET | GET /dm/api/device/{pImei} | Get the information of one device DeviceManagementApi.RestcontrollerApi | getDeviceUsingGET1 | GET /dm/api/device | Get the list of all devices for the connected user DeviceManagementApi.RestcontrollerApi | getServiceUsingGET | GET /dm/api/admin/service | Get the list of service DeviceManagementApi.RestcontrollerApi | getSimUsingGET | GET /dm/api/sim/{pNumeroSim} | Get the information of one sim DeviceManagementApi.RestcontrollerApi | getSimUsingGET1 | GET /dm/api/sim | Get the list of all sim for the connected user DeviceManagementApi.RestcontrollerApi | getUserUsingGET | GET /dm/api/user | Get the username of the current user DeviceManagementApi.RestcontrollerApi | sendSMSUsingPUT | PUT /dm/api/sendCommand | Send a SMS DeviceManagementApi.RestcontrollerApi | simNotAssociateUsingGET | GET /dm/api/simNotAssociate | Get the list of sim not associate to a device DeviceManagementApi.RestcontrollerApi | updateDeviceUsingPUT | PUT /dm/api/device/{pImei} | Modify a device DeviceManagementApi.RestcontrollerApi | updateSimUsingPUT | PUT /dm/api/sim/{pNumeroSim} | Modify a sim DeviceManagementApi.SmscontrollerApi | receiveSMSUsingPOST | POST /dm/sms/receiveSms | Receive a SMS
Documentation for Models
- DeviceManagementApi.CollectionGrantedAuthority
- DeviceManagementApi.CommandHistoryModel
- DeviceManagementApi.DeviceEqiuipmentAssociationModel
- DeviceManagementApi.DeviceModel
- DeviceManagementApi.DeviceSimAssociationModel
- DeviceManagementApi.GrantedAuthority
- DeviceManagementApi.ServiceModel
- DeviceManagementApi.SimModel
- DeviceManagementApi.SmsModel
Documentation for Authorization
All endpoints do not require authorization.