Datos publicados por IPS

Información general del servicio

Descripción
Este servicio expone datos referentes a los asegurados inscriptos en los registros del IPS.

Observaciones
Servicio de uso exclusivo para instituciones públicas.

Proveedor
Instituto de Previsión Social (IPS).

Ambiente de Publicación
Producción

Mecanismo de autorización
Presentar Formulario de Solicitud del SII firmado por la máxima autoridad al MITIC y una nota para el productor, informando sobre el uso que se le dará a sus datos.

Tipo de servicio

REST: http://[IP:PUERTO]/frontend-ips/api/swagger.json 
REST: http://[IP:PUERTO]/ips-rest/api/swagger.json

Documentación

Parámetros de cabecera

Authorization String (header)* requerido
Accept String (header)* requerido

Métodos

Método 1

http://[IP:PUERTO]/frontend-ips/api/ips/findEmpresasXFechaInscripcion/{fechaInscripcionIni}/{fechaInscripcionFin}

Parámetros

fechaInscripcionIni String (path) * requerido
fechaInscripcionFin String (path) * requerido

Respuesta

Modelo

RetornoEmpresasXFechaInscripcion{
   lstEmpresas    [ListaEmpresas{
                   des_actpri    string
                   des_emplea    string
                   des_sucurs    string
                   des_tipemp    string
                   dig_verificador    integer
                   fec_iniact    string
                   fec_inscri    string
                   ide_emplea    integer
                   ind_estemp    string
                   ind_tipemp    string
                   nro_patron    string
                   nro_ruc       string
                   }]
   returnCode       integer
   returnMessage    string
}

Método 2

http://[IP:PUERTO]/frontend-ips/api/ips/findEmpresasXFechaInactivacion/{fechaInactivacionIni}/{fechaInactivacionFin}

Parámetros

fechaInactivacionIni string (path) * requerido
fechaInactivacionFin string (path) * requerido

Respuesta

Modelo

RetornoEmpresasXFechaInactivacion{
    lstEmpresas    [ListaEmpresas{
            des_actpri    string
            des_emplea    string
            des_sucurs    string
            des_tipemp    string
            dig_verificador    integer
            fec_iniact    string
            fec_inscri    string
            ide_emplea    integer
            ind_estemp    string
            ind_tipemp    string
            nro_patron    string
            nro_ruc       string
            }]
    returnCode       integer
    returnMessage    string
}

Método 3

http://[IP:PUERTO]/frontend-ips/api/ips/findDatosAsegurado/{nroDocumento}

Parámetros

nroDocumento string (path) * requerido

Respuesta

Modelo

RetornoDatosAsegurado{
    lstDatosAsegurado    [DatosAsegurado{
                aporteJubilacion                string
                cantidadBeneficiariosActivos    integer
                empleador                       string
                estado                          string
                fechaInscripcion                string
                mesesAporte                     integer
                numeroCI                        string
                tipoAsegurado                   string
                vigente                         string
                }]
    returnCode    integer
    returnMessage string
}

Método 4

http://[IP:PUERTO]/frontend-ips/api/ips/findDatosSalario/{nroDocumento}

Parámetros

nroDocumento string (path) * requerido

Respuesta

Modelo

RetornoDatosSalario{
    lstDatosSalario    [DatosSalario{
            empleador    string
            fecha        string
            mesesAporte  integer
            numeroCI     string
            salario      integer
            }]
    returnCode    integer
    returnMessage string
}

Método 5

http://[IP:PUERTO]/frontend-ips/api/ips/findConstanciaInscripcionPatronal

Parámetros de Entrada

nroRuc string (query param) * requerido
codZona integer (query param) * requerido
codActivi integer (query param) * requerido
nroEmplea integer (query param) * requerido

Respuesta

Modelo

RetornoDatosAOP{
    lstDatosAOP    [ListaDatosAOP{
            des_actpri    string
            des_emplea    string
            des_sucurs    string
            des_tipemp    string
            dig_verificador    integer
            fec_iniact    string
            fec_inscri    string
            ide_emplea    integer
            ind_tipemp    string
            nro_patron    string
            nro_ruc       string
            usu_ultmod    string
            }]
    returnCode    integer
    returnMessage string
}

Método 6

http://[IP:PUERTO]/ips-rest/api/ips/findListaEmpleadosByRUC/{ruc}/{pagina}

Parámetros de Entrada

ruc string (path)* requerido
pagina integer (path)* requerido

Respuesta

Modelo

IPSResult{
    [asegurados{
    apellido    string
    nombre      string
    nroCedula   string
    tipoSeguro  string
    }]
    [empleadores{
    desEmpleador   string
    nroPatronal    string
    ultimoPeriodo  string
    }]
    cantPaginas integer
    mensaje     string    
}

Método 7

http://[IP:PUERTO]/frontend-ips/api/ips/findDatosAseguradoPatronal/{numeroRuc}

Parámetros de Entrada

numeroRuc string (path param) * requerido

Respuesta

Modelo

"RetornoDatosAseguradoPatronal": {
    "type": "object",
    "properties": {
        "lstDatosAseguradoPatronal": {
            "type": "array",
            "items": {
                "DatosAseguradoPatronal": {
                    "type": "object",
                    "properties": {
                        "apellido": {
                            "type": "string"
                        },
                        "fechaEntrada": {
                            "type": "string"
                        },
                        "nombre": {
                            "type": "string"
                        },
                        "numeroCedula": {
                            "type": "string"
                        },
                        "numeroPatronal": {
                            "type": "string"
                        },
                        "razonSocial": {
                            "type": "string"
                        },
                        "remuneracion": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "returnCode": {
            "type": "integer",
            "format": "int32"
        },
        "returnMessage": {
            "type": "string"
        }
    }
}

Método 8

http://[IP:PUERTO]/frontend-ips/api/ips/findDatosAseguradoFecha?fechaDesde=&fechaHasta=&pagina=1

Parámetros de Entrada

fechaDesde string (query param) * requerido
fechaHasta integer (query param) * requerido
pagina integer (query param) * requerido

Respuesta

Modelo

"WsDatosAseguradoFechaResponse": {
    "type": "object",
    "properties": {
        "retornoDatosAseguradoFecha": {
            "RetornoDatosAseguradoFecha": {
                "type": "object",
                "properties": {
                    "datosAseguradoFecha": {
                        "type": "array",
                        "items": {
                            "DatosAseguradoFecha": {
                                "type": "object",
                                "properties": {
                                    "aporteJubilacion": {
                                        "type": "string"
                                    },
                                    "callePrincipal": {
                                        "type": "string"
                                    },
                                    "calleSecundaria": {
                                        "type": "string"
                                    },
                                    "correo": {
                                        "type": "string"
                                    },
                                    "departamento": {
                                        "type": "string"
                                    },
                                    "empleador": {
                                        "type": "string"
                                    },
                                    "estado": {
                                        "type": "string"
                                    },
                                    "fechaEntrada": {
                                        "type": "string",
                                        "format": "date-time"
                                    },
                                    "fechaInscripcion": {
                                        "type": "string",
                                        "format": "date-time"
                                    },
                                    "fechaSalida": {
                                        "type": "string",
                                        "format": "date-time"
                                    },
                                    "fechaVigencia": {
                                        "type": "string",
                                        "format": "date-time"
                                    },
                                    "localidad": {
                                        "type": "string"
                                    },
                                    "mesesAporte": {
                                        "type": "integer",
                                        "format": "int32"
                                    },
                                    "nroPatronal": {
                                        "type": "string"
                                    },
                                    "numeroCI": {
                                        "type": "string"
                                    },
                                    "remuneracion": {
                                        "type": "string"
                                    },
                                    "ruc": {
                                        "type": "string"
                                    },
                                    "telefono": {
                                        "type": "string"
                                    },
                                    "tipoAsegurado": {
                                        "type": "string"
                                    },
                                    "vigente": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    },
                    "returnCode": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "returnMessage": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

Método 9

http://[IP:PUERTO]/ips-rest/api/ips/estadoPatronal/{ruc}

Parámetros

ruc String (path param) * requerido

Respuesta

Modelo

"EstadoPatronalResult": {
    "type": "object",
    "properties": {
        "id_consulta": {
            "type": "integer",
            "format": "int32"
        },
        "data": {
            "type": "object",
            "properties": {
                "estado": {
                    "type": "string"
                },
                "fecha_de_emi": {
                    "type": "string"
                },
                "empresas": {
                    "type": "array",
                    "items": {
                        "Empresa": {
                            "type": "object",
                            "properties": {
                                "actividad": {
                                    "type": "string"
                                },
                                "id_emplea": {
                                    "type": "string"
                                },
                                "fecha_de_inscrip": {
                                    "type": "string"
                                },
                                "ruc": {
                                    "type": "string"
                                },
                                "cant_de_emplea": {
                                    "type": "string"
                                },
                                "nombre": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "http_response": {
            "HTTP_Response": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string"
                    },
                    "code": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

Nivel de calidad del servicio

 

Disponibilidad
99,99%

Tiempo de respuesta
menos de 1 segundo

Volumen de carga máx.

Fecha de Actualización
20/09/18 01:34:p. m.