Skip to content

Latest commit

 

History

History
789 lines (542 loc) · 24.4 KB

LegacyLowstockContactApi.md

File metadata and controls

789 lines (542 loc) · 24.4 KB
Raw

infoplus.LegacyLowstockContactApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
addLegacyLowstockContact POST /beta/legacyLowstockContact Create a legacyLowstockContact
addLegacyLowstockContactAudit PUT /beta/legacyLowstockContact/{legacyLowstockContactId}/audit/{legacyLowstockContactAudit} Add new audit for a legacyLowstockContact
addLegacyLowstockContactFile POST /beta/legacyLowstockContact/{legacyLowstockContactId}/file/{fileName} Attach a file to a legacyLowstockContact
addLegacyLowstockContactFileByURL POST /beta/legacyLowstockContact/{legacyLowstockContactId}/file Attach a file to a legacyLowstockContact by URL.
addLegacyLowstockContactTag PUT /beta/legacyLowstockContact/{legacyLowstockContactId}/tag/{legacyLowstockContactTag} Add new tags for a legacyLowstockContact.
deleteLegacyLowstockContact DELETE /beta/legacyLowstockContact/{legacyLowstockContactId} Delete a legacyLowstockContact
deleteLegacyLowstockContactFile DELETE /beta/legacyLowstockContact/{legacyLowstockContactId}/file/{fileId} Delete a file for a legacyLowstockContact.
deleteLegacyLowstockContactTag DELETE /beta/legacyLowstockContact/{legacyLowstockContactId}/tag/{legacyLowstockContactTag} Delete a tag for a legacyLowstockContact.
getDuplicateLegacyLowstockContactById GET /beta/legacyLowstockContact/duplicate/{legacyLowstockContactId} Get a duplicated a legacyLowstockContact by id
getLegacyLowstockContactByFilter GET /beta/legacyLowstockContact/search Search legacyLowstockContacts by filter
getLegacyLowstockContactById GET /beta/legacyLowstockContact/{legacyLowstockContactId} Get a legacyLowstockContact by id
getLegacyLowstockContactFiles GET /beta/legacyLowstockContact/{legacyLowstockContactId}/file Get the files for a legacyLowstockContact.
getLegacyLowstockContactTags GET /beta/legacyLowstockContact/{legacyLowstockContactId}/tag Get the tags for a legacyLowstockContact.
updateLegacyLowstockContact PUT /beta/legacyLowstockContact Update a legacyLowstockContact

addLegacyLowstockContact

LegacyLowstockContact addLegacyLowstockContact(body)

Create a legacyLowstockContact

Inserts a new legacyLowstockContact using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var body = new infoplus.LegacyLowstockContact(); // LegacyLowstockContact | LegacyLowstockContact to be inserted.


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

Parameters

Name Type Description Notes
body LegacyLowstockContact LegacyLowstockContact to be inserted.

Return type

LegacyLowstockContact

Authorization

api_key

HTTP request headers

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

addLegacyLowstockContactAudit

addLegacyLowstockContactAudit(legacyLowstockContactId, legacyLowstockContactAudit)

Add new audit for a legacyLowstockContact

Adds an audit to an existing legacyLowstockContact.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to add an audit to

var legacyLowstockContactAudit = "legacyLowstockContactAudit_example"; // String | The audit to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addLegacyLowstockContactAudit(legacyLowstockContactId, legacyLowstockContactAudit, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to add an audit to
legacyLowstockContactAudit String The audit to add

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

addLegacyLowstockContactFile

addLegacyLowstockContactFile(legacyLowstockContactId, fileName)

Attach a file to a legacyLowstockContact

Adds a file to an existing legacyLowstockContact.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to add a file to

var fileName = "fileName_example"; // String | Name of file


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addLegacyLowstockContactFile(legacyLowstockContactId, fileName, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to add a file to
fileName String Name of file

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

addLegacyLowstockContactFileByURL

addLegacyLowstockContactFileByURL(body, legacyLowstockContactId)

Attach a file to a legacyLowstockContact by URL.

Adds a file to an existing legacyLowstockContact by URL.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var body = new infoplus.RecordFile(); // RecordFile | The url and optionly fileName to be used.

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to add an file to


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addLegacyLowstockContactFileByURL(body, legacyLowstockContactId, callback);

Parameters

Name Type Description Notes
body RecordFile The url and optionly fileName to be used.
legacyLowstockContactId Number Id of the legacyLowstockContact to add an file to

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

addLegacyLowstockContactTag

addLegacyLowstockContactTag(legacyLowstockContactId, legacyLowstockContactTag)

Add new tags for a legacyLowstockContact.

Adds a tag to an existing legacyLowstockContact.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to add a tag to

var legacyLowstockContactTag = "legacyLowstockContactTag_example"; // String | The tag to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addLegacyLowstockContactTag(legacyLowstockContactId, legacyLowstockContactTag, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to add a tag to
legacyLowstockContactTag String The tag to add

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

deleteLegacyLowstockContact

deleteLegacyLowstockContact(legacyLowstockContactId)

Delete a legacyLowstockContact

Deletes the legacyLowstockContact identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to be deleted.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteLegacyLowstockContact(legacyLowstockContactId, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to be deleted.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

deleteLegacyLowstockContactFile

deleteLegacyLowstockContactFile(legacyLowstockContactId, fileId)

Delete a file for a legacyLowstockContact.

Deletes an existing legacyLowstockContact file using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to remove file from

var fileId = 56; // Number | Id of the file to delete


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteLegacyLowstockContactFile(legacyLowstockContactId, fileId, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to remove file from
fileId Number Id of the file to delete

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

deleteLegacyLowstockContactTag

deleteLegacyLowstockContactTag(legacyLowstockContactId, legacyLowstockContactTag)

Delete a tag for a legacyLowstockContact.

Deletes an existing legacyLowstockContact tag using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to remove tag from

var legacyLowstockContactTag = "legacyLowstockContactTag_example"; // String | The tag to delete


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteLegacyLowstockContactTag(legacyLowstockContactId, legacyLowstockContactTag, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to remove tag from
legacyLowstockContactTag String The tag to delete

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

getDuplicateLegacyLowstockContactById

LegacyLowstockContact getDuplicateLegacyLowstockContactById(legacyLowstockContactId)

Get a duplicated a legacyLowstockContact by id

Returns a duplicated legacyLowstockContact identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to be duplicated.


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

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to be duplicated.

Return type

LegacyLowstockContact

Authorization

api_key

HTTP request headers

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

getLegacyLowstockContactByFilter

[LegacyLowstockContact] getLegacyLowstockContactByFilter(opts)

Search legacyLowstockContacts by filter

Returns the list of legacyLowstockContacts that match the given filter.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var opts = { 
  'filter': "filter_example", // String | Query string, used to filter results.
  'page': 56, // Number | Result page number.  Defaults to 1.
  'limit': 56, // Number | Maximum results per page.  Defaults to 20.  Max allowed value is 250.
  'sort': "sort_example" // String | Sort results by specified field.
};

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

Parameters

Name Type Description Notes
filter String Query string, used to filter results. [optional]
page Number Result page number. Defaults to 1. [optional]
limit Number Maximum results per page. Defaults to 20. Max allowed value is 250. [optional]
sort String Sort results by specified field. [optional]

Return type

[LegacyLowstockContact]

Authorization

api_key

HTTP request headers

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

getLegacyLowstockContactById

LegacyLowstockContact getLegacyLowstockContactById(legacyLowstockContactId)

Get a legacyLowstockContact by id

Returns the legacyLowstockContact identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to be returned.


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

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to be returned.

Return type

LegacyLowstockContact

Authorization

api_key

HTTP request headers

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

getLegacyLowstockContactFiles

getLegacyLowstockContactFiles(legacyLowstockContactId)

Get the files for a legacyLowstockContact.

Get all existing legacyLowstockContact files.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to get files for


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getLegacyLowstockContactFiles(legacyLowstockContactId, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to get files for

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

getLegacyLowstockContactTags

getLegacyLowstockContactTags(legacyLowstockContactId)

Get the tags for a legacyLowstockContact.

Get all existing legacyLowstockContact tags.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var legacyLowstockContactId = 56; // Number | Id of the legacyLowstockContact to get tags for


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getLegacyLowstockContactTags(legacyLowstockContactId, callback);

Parameters

Name Type Description Notes
legacyLowstockContactId Number Id of the legacyLowstockContact to get tags for

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

updateLegacyLowstockContact

updateLegacyLowstockContact(body)

Update a legacyLowstockContact

Updates an existing legacyLowstockContact using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new infoplus.LegacyLowstockContactApi();

var body = new infoplus.LegacyLowstockContact(); // LegacyLowstockContact | LegacyLowstockContact to be updated.


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

Parameters

Name Type Description Notes
body LegacyLowstockContact LegacyLowstockContact to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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