Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7
Info

DESCRIPCIÓN DE LA API

...

  • Para la funcionalidad siempre se debe enviar por Header el X-API-KEY

  • El X-API-KEY lo proporciona wekall, no se mostrara en esta documentación por temas de seguridad. es obligatorio enviarlo por headers.

  • Documentación de uso: https://documenter.getpostman.com/view/7191077/UyxhmmbD

Info

USO DE LA API

URL: https://l1h5vjm2c7.execute-api.us-east-1.amazonaws.com/master/sfapi/

...

Info

STATUS: 400

Code Block
{
            status: false,
            code: 100,
            message: "typeDocument or document must not be empty"
}
Info

STATUS: 500

Code Block
{
                status: false,
                code: 102,
                message: err.message
            }
Info

Significado de los code

Code Block
{
  "100": "Documento o tipo de documento vacio",
  "101": "Error al crear el token",
  "102": "Error al traer el afiliado",
  "103": "Error de authorizacion de token"
  "104": "Llamada no existe en la BD"
}     

Errores Conocidos

  • No se conocen errores por ahora.

Info

Potabilidad

  • W_ESTADOPORTABILIDAD: Contiene los estado de la portabilidad:

    • En solicitud

    • En Tramite

    • Cancelada

    • Activa

    • Terminada

    • Vencida

    • Null

  • W_FECVENCIMIENTOPORTABILIDAD: Fecha de vencimiento de la portabilidad o Null

  • ESTAENPORTABILIDAD: Muestra si el afiliado esta en portabilidad, muestra “SI“ y “NO“

  • DEPARTAMENTOPORTABILIDADDESCRIPCION: Muestra el nombre del departamento de la portabilidad o Null

  • DEPARTAMENTOPORTABILIDAD: Muestra el numero del departamento de la portabilidad o Null

  • CIUDADPORTABILIDADDESCRIPCION: Muestra el nombre de la ciudad de la portabilidad o Null

  • CIUDADPORTABILIDAD: Muestra el numero de la ciudad de la portabilidad o Null

Nota: para validar si el afiliado tiene portabilidad se debe validar con:

  • ESTAENPORTABILIDAD

Ejemplo de JSON con portabilidad:

Code Block
{
    "status": true,
    "code": 200,
    "data": {
        "W_TELEFONOIPSPRIMARIA": null,
        "W_TELEFONOIPSMEDICAMENTO": null,
        "W_NOMBREIPSPRIMARIA": "Ese hospital san francisco",
        "W_NOMBREIPSMEDICAMENTO": null,
        "W_FECVENCIMIENTOPORTABILIDAD": "2022/05/12",
        "W_ESTADOPORTABILIDAD": "En Solicitud",
        "W_DIRECCIONIPSPRIMARIA": "Calle 7 número 23 61",
        "W_DIRECCIONIPSMEDICAMENTO": "Calle 7 número 23 61",
        "TIPO_POBLACIONDESCRIPCION": "Población con SISBEN",
        "TIPO_POBLACION": "5",
        "TIPO_IDENTIFICACION": "CC",
        "TELEFONO": "3167774483",
        "SUCURSALPORTABILIDAD": "76",
        "SUCURSALAFILIADO": "76",
        "SEXO": "M",
        "SEGUNDO_NOMBRE": "LUIS",
        "SEGUNDO_APELLIDO": "HOYOS",
        "REGIMEN": "Subsidiado",
        "RC_CORREOELECTRONICO": "jlcastrillon9@gmail.com",
        "RC_CODTIPOAFILIADODESCRIPCION": "Cabeza de Familia",
        "RC_CODTIPOAFILIADO": "F",
        "RC_CODNIVELEDUCATIVODESCRIPCION": "No definido",
        "RC_CODNIVELEDUCATIVO": "1",
        "RC_CODESTADOCIVILDESCRIPCION": "No Aplica",
        "RC_CODESTADOCIVIL": "ND",
        "RC_CLASEAFILIACIONDESCRIPCION": null,
        "RC_CLASEAFILIACION": null,
        "razonSocialOficinaConsultaAfiliado": null,
        "razonSocialOficinaAsignada": null,
        "RANGO": "",
        "PRIMER_NOMBRE": "JOSE",
        "PRIMER_APELLIDO": "CASTRILLON",
        "oficinaIdAsignada": null,
        "oficinaEntregaNoPossConsultaAfiliado": null,
        "oficinaEntregaNoPossAsignada": null,
        "OFICINA_DISPENSACION": "E.S.E. HOSPITAL SAN FRANCISCO",
        "NUMERO_IDENTIFICACION": "98652453",
        "NIVEL_SISBEN": "1",
        "nitOficinaConsultaAfiliado": null,
        "nitOficinaAsignada": null,
        "NITOFICINA_DISPENSACION": "800201197",
        "IPSENTREGAMEDICAMENTOS": null,
        "IPS_ASIGNADA": "E.S.E. HOSPITAL SAN FRANCISCO",
        "FICHA_SISBEN": "9278",
        "FECHA_NACIMIENTO": "1978/04/04",
        "FECHA_AFILIACION": "2017/09/10",
        "ESTAENPORTABILIDAD": "SI",
        "ESTADO": "AC",
        "errorId": 5,
        "ERROR": "El afiliado no tiene oficina dispensacion medicamento asignada.",
        "DIRECCION": "B/11 DE NOVIEMBRE",
        "DESCRIPCIONDEPARTAMENTO": "CÓRDOBA",
        "DESCRIPCIONCIUDAD": "CIÉNAGA DE ORO",
        "DEPARTAMENTOPORTABILIDADDESCRIPCION": "HUILA",
        "DEPARTAMENTOPORTABILIDAD": "41",
        "DEPARTAMENTO": "23",
        "CIUDADPORTABILIDADDESCRIPCION": "PALERMO",
        "CIUDADPORTABILIDAD": "524",
        "CIUDAD": "189",
        "CELULAR": "3167774483",
        "CARNET": "23189149227"
    }
}