1.0.0 • Published 8 years ago

device-management-api v1.0.0

Weekly downloads
3
License
-
Repository
-
Last release
8 years ago

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

ClassMethodHTTP requestDescription
DeviceManagementApi.RestcontrollerApiaddDeviceUsingPUTPUT /dm/api/deviceAdd a new device
DeviceManagementApi.RestcontrollerApiaddServiceUsingPUTPUT /dm/api/admin/serviceAdd a service
DeviceManagementApi.RestcontrollerApiaddSimUsingPUTPUT /dm/api/simAdd a new sim
DeviceManagementApi.RestcontrollerApiassociateDeviceEquipmentUsingPUTPUT /dm/api/associateDeviceEquipmentAssociate a device to an equipment
DeviceManagementApi.RestcontrollerApiassociateDeviceSimUsingPUTPUT /dm/api/associateDeviceSimAssociate a device to a sim
DeviceManagementApi.RestcontrollerApideleteDeviceUsingDELETEDELETE /dm/api/device/{pImei}Delete a device
DeviceManagementApi.RestcontrollerApideleteServiceUsingDELETEDELETE /dm/api/admin/service/{pName}Delete a service
DeviceManagementApi.RestcontrollerApideleteSimUsingDELETEDELETE /dm/api/sim/{pNumeroSim}Delete a sim
DeviceManagementApi.RestcontrollerApideviceNotAssociateToEquipmentUsingGETGET /dm/api/deviceNotAssociateToEquipmentGet the list of device not associate to an equipment
DeviceManagementApi.RestcontrollerApideviceNotAssociateToSimUsingGETGET /dm/api/deviceNotAssociateToSimGet the list of device not associate to a sim
DeviceManagementApi.RestcontrollerApideviceTypeUsingGETGET /dm/api/deviceTypeGet the list of deviceType
DeviceManagementApi.RestcontrollerApidissociateDeviceEquipmentUsingPUTPUT /dm/api/dissociateDeviceEquipmentDissociate a device and an equipment
DeviceManagementApi.RestcontrollerApidissociateDeviceSimUsingPUTPUT /dm/api/dissociateDeviceSimDissociate a device and a sim
DeviceManagementApi.RestcontrollerApigetAuthoritiesUsingGETGET /dm/api/authoritiesGet the authorities of the current user
DeviceManagementApi.RestcontrollerApigetCommandHistoryUsingGETGET /dm/api/commandHistory/{pImei}Get the commands history of one device
DeviceManagementApi.RestcontrollerApigetDeviceUsingGETGET /dm/api/device/{pImei}Get the information of one device
DeviceManagementApi.RestcontrollerApigetDeviceUsingGET1GET /dm/api/deviceGet the list of all devices for the connected user
DeviceManagementApi.RestcontrollerApigetServiceUsingGETGET /dm/api/admin/serviceGet the list of service
DeviceManagementApi.RestcontrollerApigetSimUsingGETGET /dm/api/sim/{pNumeroSim}Get the information of one sim
DeviceManagementApi.RestcontrollerApigetSimUsingGET1GET /dm/api/simGet the list of all sim for the connected user
DeviceManagementApi.RestcontrollerApigetUserUsingGETGET /dm/api/userGet the username of the current user
DeviceManagementApi.RestcontrollerApisendSMSUsingPUTPUT /dm/api/sendCommandSend a SMS
DeviceManagementApi.RestcontrollerApisimNotAssociateUsingGETGET /dm/api/simNotAssociateGet the list of sim not associate to a device
DeviceManagementApi.RestcontrollerApiupdateDeviceUsingPUTPUT /dm/api/device/{pImei}Modify a device
DeviceManagementApi.RestcontrollerApiupdateSimUsingPUTPUT /dm/api/sim/{pNumeroSim}Modify a sim
DeviceManagementApi.SmscontrollerApireceiveSMSUsingPOSTPOST /dm/sms/receiveSmsReceive a SMS

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.