Skip to content

Mc2IdManager.DevicesApi

All URIs are relative to http://127.0.0.1:46841/api

Method HTTP request Description
deleteCapture DELETE /v1/devices/capture Cancel capture
getCapabilities GET /v1/devices/capabilities Device capabilities
getCapture GET /v1/devices/capture Capture image
getCount GET /v1/devices/count Count readers
getDescriptions GET /v1/devices/descriptions Device descriptions

deleteCapture

ModelEmpty deleteCapture(opts)

Cancel capture

Cancel a capture process that is initiated.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.DevicesApi();

var opts = { 
  'index': "index_example" // String | index is the device position.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteCapture(opts, callback);

Parameters

Name Type Description Notes
index String index is the device position. [optional]

Return type

ModelEmpty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCapabilities

DevicesGetCapabilitiesResponse getCapabilities(opts)

Device capabilities

List of capabilities for devices connected.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.DevicesApi();

var opts = { 
  'index': "index_example" // String | index is the device position.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCapabilities(opts, callback);

Parameters

Name Type Description Notes
index String index is the device position. [optional]

Return type

DevicesGetCapabilitiesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCapture

DevicesGetCaptureResponse getCapture(opts)

Capture image

Capture an image from a device.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.DevicesApi();

var opts = { 
  'index': "index_example" // String | index is the device position.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCapture(opts, callback);

Parameters

Name Type Description Notes
index String index is the device position. [optional]

Return type

DevicesGetCaptureResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getCount

DevicesGetCountResponse getCount()

Count readers

Count the number of readers connected to computer.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.DevicesApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCount(callback);

Parameters

This endpoint does not need any parameter.

Return type

DevicesGetCountResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getDescriptions

DevicesGetDescriptionsResponse getDescriptions(opts)

Device descriptions

List of description for devices connected.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.DevicesApi();

var opts = { 
  'index': "index_example" // String | index is the device position.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDescriptions(opts, callback);

Parameters

Name Type Description Notes
index String index is the device position. [optional]

Return type

DevicesGetDescriptionsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json