idManager.TagsApi¶

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

Method	HTTP request	Description
createTag	POST /v1/identifications/{code}/tags	Create a new tag
deleteTag	DELETE /v1/identifications/{code}/tags/{index}	Delete a tag
deleteTags	DELETE /v1/identifications/{code}/tags	Delete tags
getTag	GET /v1/identifications/{code}/tags/{index}	Get a tag
getTags	GET /v1/identifications/{code}/tags	Get tag list
updateTag	PUT /v1/identifications/{code}/tags/{index}	Update a tag

createTag¶

TagsCreateTagResponse createTag(code, body)

Create a new tag

Create a new tag, will be added at the end of the list.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

var code = "code_example"; // String | code is the identification code of the tag

var body = new idManager.IdManagermodelTag(); // IdManagermodelTag | tag to update


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

Parameters¶

Name	Type	Description	Notes
code	String	code is the identification code of the tag
body	IdManagermodelTag	tag to update

Return type¶

TagsCreateTagResponse

Authorization¶

No authorization required

HTTP request headers¶

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

deleteTag¶

ModelEmpty deleteTag(code, index)

Delete a tag

Delete a tag for the requested code and index. Indexes will be reorganized.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

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

var index = 789; // Number | index is the internal position


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

Parameters¶

Name	Type	Description	Notes
code	String	code is the identification code of the tag to delete
index	Number	index is the internal position

Return type¶

ModelEmpty

Authorization¶

No authorization required

HTTP request headers¶

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

deleteTags¶

ModelEmpty deleteTags(code)

Delete tags

Delete all tags for the requested code.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

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


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

Parameters¶

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

Return type¶

ModelEmpty

Authorization¶

No authorization required

HTTP request headers¶

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

getTag¶

TagsGetTagResponse getTag(code, index)

Get a tag

Get a tag by code and index.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

var code = "code_example"; // String | code is the identification code of the tag

var index = 789; // Number | index is the internal position


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

Parameters¶

Name	Type	Description	Notes
code	String	code is the identification code of the tag
index	Number	index is the internal position

Return type¶

TagsGetTagResponse

Authorization¶

No authorization required

HTTP request headers¶

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

getTags¶

TagsGetTagsResponse getTags(code)

Get tag list

Get a list with all tags by code.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

var code = "code_example"; // String | code is the identification code of the tag


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

Parameters¶

Name	Type	Description	Notes
code	String	code is the identification code of the tag

Return type¶

TagsGetTagsResponse

Authorization¶

No authorization required

HTTP request headers¶

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

updateTag¶

TagsUpdateTagResponse updateTag(code, index, body)

Update a tag

Update a tag with a selected index.

Example¶

var idManager = require('idmanager');

var apiInstance = new idManager.TagsApi();

var code = "code_example"; // String | code is the identification code of the tag

var index = 789; // Number | index is the internal position

var body = new idManager.IdManagermodelTag(); // IdManagermodelTag | tag to update


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

Parameters¶

Name	Type	Description
code	String	code is the identification code of the tag
index	Number	index is the internal position
body	IdManagermodelTag	tag to update

Return type¶

TagsUpdateTagResponse

Authorization¶

No authorization required

HTTP request headers¶

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