Skip to content

Mc2IdManager.IdentificationsApi

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

Method HTTP request Description
deleteIdentification DELETE /v1/db/identifications/{code} Delete an identification
getIdentification GET /v1/db/identifications/{code} Get an identification
getIdentifications GET /v1/db/identifications Get identification list

deleteIdentification

ModelEmpty deleteIdentification(code)

Delete an identification

Delete an identification with the provided code.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.IdentificationsApi();

var code = "code_example"; // String | code is the identification code to delete


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

Parameters

Name Type Description Notes
code String code is the identification code to delete

Return type

ModelEmpty

Authorization

No authorization required

HTTP request headers

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

getIdentification

IdentificationsGetIdentificationResponse getIdentification(code)

Get an identification

Get an identification by code.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.IdentificationsApi();

var code = "code_example"; // String | code is the identification code to get


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

Parameters

Name Type Description Notes
code String code is the identification code to get

Return type

IdentificationsGetIdentificationResponse

Authorization

No authorization required

HTTP request headers

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

getIdentifications

IdentificationsGetIdentificationsResponse getIdentifications(opts)

Get identification list

Get a list with all identifications. Can use query model to filter results.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.IdentificationsApi();

var opts = { 
  'page': 789, // Number | page of the list.
  'start': 789, // Number | start offset of the list.
  'limit': 789, // Number | limit number of record per fetch.
  'sort': "sort_example", // String | sort is for sorting records. JSON encoded, ex: [{\"property\":\"name\",\"direction\":\"ASC\"}].
  'filter': "filter_example" // String | filter is for filtering records. JSON encoded, ex: [{\"property\":\"#search\",\"value\":\"test value\",\"type\":\"string\",\"operator\":\"like\"}].
};

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

Parameters

Name Type Description Notes
page Number page of the list. [optional]
start Number start offset of the list. [optional]
limit Number limit number of record per fetch. [optional]
sort String sort is for sorting records. JSON encoded, ex: [{\"property\":\"name\",\"direction\":\"ASC\"}]. [optional]
filter String filter is for filtering records. JSON encoded, ex: [{\"property\":\"#search\",\"value\":\"test value\",\"type\":\"string\",\"operator\":\"like\"}]. [optional]

Return type

IdentificationsGetIdentificationsResponse

Authorization

No authorization required

HTTP request headers

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