consultas-pila-web-api

ConsultasPilaWebApi - JavaScript client for consultas-pila-web-api Consultas historicas de seguridad social This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.3.0
• Package version: 1.3.0
• Build date: 2016-07-14T21:42:49.519Z
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install consultas-pila-web-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/consultas-pila-web-api then install it via:

    npm install YOUR_USERNAME/consultas-pila-web-api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var ConsultasPilaWebApi = require('consultas-pila-web-api');

var api = new ConsultasPilaWebApi.ConsultaIndividualApi()

var tipoDocumento = "tipoDocumento_example"; // {String} Tipo de documento del aportante. [CC,CE,NI]

var numeroDocumento = 3.4; // {Number} Número de documento del aportante (sin puntos, ni comas, ni caracteres especiales).

var contentType = "contentType_example"; // {String} Formato en el cual se espera obtener la respuesta de la consulta

var opts = { 
  'historico': 3.4, // {Number} Número de meses a buscar, no > 24 por defecto 24
  'user': "user_example", // {String} Usuario que realiza la petición. si no se envia se marca como 'default'.
  'ip': "ip_example" // {String} Ip origen de la petición. si no se envia se obtendra del request.
};

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

Documentation for API Endpoints

All URIs are relative to https://consultaspila.achcolombia.com.co

Class	Method	HTTP request	Description
ConsultasPilaWebApi.ConsultaIndividualApi	consultasIndividualesPersonasJuridicasTipoDocumentonumeroDocumentoGet	GET /consultas/individuales/personas/juridicas/{tipoDocumento}{numeroDocumento}	Consulta Individual persona juridica
ConsultasPilaWebApi.ConsultaIndividualApi	consultasIndividualesPersonasNaturalesTipoDocumentonumeroDocumentoGet	GET /consultas/individuales/personas/naturales/{tipoDocumento}{numeroDocumento}	Consulta individual persona natural
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasJuridicasPost	POST /consultas/masivas/personas/juridicas/	Consulta masiva de personas juridicas
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasJuridicasUuidEstadoGet	GET /consultas/masivas/personas/juridicas/{uuid}/estado	Consulta estado consulta masiva de personas juridicas
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasJuridicasUuidGet	GET /consultas/masivas/personas/juridicas/{uuid}	Consulta resultado consulta masiva de personas juridicas
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasNaturalesPost	POST /consultas/masivas/personas/naturales/	Consulta masiva de personas naturales
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasNaturalesUuidEstadoGet	GET /consultas/masivas/personas/naturales/{uuid}/estado	Consulta estado consulta masiva de personas naturales
ConsultasPilaWebApi.ConsultaMasivaApi	consultasMasivasPersonasNaturalesUuidGet	GET /consultas/masivas/personas/naturales/{uuid}	Consulta resultado consulta masiva de personas naturales
ConsultasPilaWebApi.EstadisticasYTarifacinApi	estadisticasHistoricosEntidadGet	GET /estadisticas/historicos/{entidad}	Consulta historicos de consultas realizadas para las entidades

Documentation for Models

• ConsultasPilaWebApi.Consulta
• ConsultasPilaWebApi.ConsultaConResultadJuridica
• ConsultasPilaWebApi.ConsultaConResultadoNatural
• ConsultasPilaWebApi.ConsultaMasiva
• ConsultasPilaWebApi.Error
• ConsultasPilaWebApi.EstadoConsultaMasiva
• ConsultasPilaWebApi.HistoricoConsulta
• ConsultasPilaWebApi.PersonaJuridica
• ConsultasPilaWebApi.PersonaNatural
• ConsultasPilaWebApi.ResultadoConsultaMasivaJuridica
• ConsultasPilaWebApi.ResultadoConsultaMasivaNatural

Documentation for Authorization

All endpoints do not require authorization.