Skip to content

Latest commit

 

History

History
218 lines (152 loc) · 5.19 KB

BinchaveresourceApi.md

File metadata and controls

218 lines (152 loc) · 5.19 KB

Pier.BinchaveresourceApi

All URIs are relative to http://localhost/

Method HTTP request Description
alterarBinChaveUsingPUT PUT /api/bins-chaves/{id} alterarBinChave
consultarUsingGET10 GET /api/bins-chaves/{id} consultar
listarBinChaveUsingGET GET /api/bins-chaves listarBinChave
salvarUsingPOST4 POST /api/bins-chaves salvar

alterarBinChaveUsingPUT

Object alterarBinChaveUsingPUT(id, request, login)

alterarBinChave

Example

var Pier = require('Pier');

var apiInstance = new Pier.BinchaveresourceApi()

var id = 789; // {Integer} id

var request = new Pier.BinChaveUpdate(); // {BinChaveUpdate} request

var login = "login_example"; // {String} login


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.alterarBinChaveUsingPUT(id, request, login, callback);

Parameters

Name Type Description Notes
id Integer id
request BinChaveUpdate request
login String login

Return type

Object

Authorization

No authorization required

HTTP reuqest headers

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

consultarUsingGET10

Object consultarUsingGET10(id)

consultar

Example

var Pier = require('Pier');

var apiInstance = new Pier.BinchaveresourceApi()

var id = 789; // {Integer} id


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

Parameters

Name Type Description Notes
id Integer id

Return type

Object

Authorization

No authorization required

HTTP reuqest headers

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

listarBinChaveUsingGET

Object listarBinChaveUsingGET(opts)

listarBinChave

Example

var Pier = require('Pier');

var apiInstance = new Pier.BinchaveresourceApi()

var opts = { 
  'sort': ["sort_example"], // {[String]} {{{global_menssagem_sort_sort}}}
  'page': 56, // {Integer} {{{global_menssagem_sort_page_value}}}
  'limit': 56, // {Integer} {{{global_menssagem_sort_limit}}}
  'id': 789, // {Integer} 
  'idTipoChave': 789, // {Integer} 
  'idBin': 789, // {Integer} 
  'chave': "chave_example", // {String} 
  'checkValue': "checkValue_example", // {String} 
  'validade': "validade_example", // {String} 
  'flagDescriptografado': true, // {Boolean} 
  'label': "label_example" // {String} 
};

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

Parameters

Name Type Description Notes
sort [String] {{{global_menssagem_sort_sort}}} [optional]
page Integer {{{global_menssagem_sort_page_value}}} [optional]
limit Integer {{{global_menssagem_sort_limit}}} [optional]
id Integer [optional]
idTipoChave Integer [optional]
idBin Integer [optional]
chave String [optional]
checkValue String [optional]
validade String [optional]
flagDescriptografado Boolean [optional]
label String [optional]

Return type

Object

Authorization

No authorization required

HTTP reuqest headers

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

salvarUsingPOST4

Object salvarUsingPOST4(binChavePersist, login)

salvar

Example

var Pier = require('Pier');

var apiInstance = new Pier.BinchaveresourceApi()

var binChavePersist = new Pier.BinChavePersist(); // {BinChavePersist} binChavePersist

var login = "login_example"; // {String} login


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

Parameters

Name Type Description Notes
binChavePersist BinChavePersist binChavePersist
login String login

Return type

Object

Authorization

No authorization required

HTTP reuqest headers

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