Api Wekall-Coosalud

1 DESCRIPCIÓN DE LA API
2 ALERTA DE USO
3 USO DE LA API
- 3.1 Endpoint: getClient
  - 3.1.1 Respuesta:
4 Significado de los code
5 Errores Conocidos
6 Potabilidad

DESCRIPCIÓN DE LA API

La api Wekall-Coosalud cuenta con 1 servicio el cual es traer la información del afiliado

ALERTA DE USO

Para la funcionalidad siempre se debe enviar por Header el X-API-KEY
El X-API-KEY es obligatorio enviarlo por headers.
Documentación de uso: https://documenter.getpostman.com/view/7191077/UyxhmmbD

USO DE LA API

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

Endpoint: getClient

Descripción: Trae la información del afiliado, se envía el Tipo de documento y el documento
Método: POST
Headers
- X-API-KEY: Api Key de la organización
Body:
- typeDocument: Tipo de documento
- document: Numero de documento

{
    "typeDocument": "CC",
    "document": "9146767"
}

Respuesta:

{
    "status": true,
    "code": 200,
    "data": {
        "W_TELEFONOIPSPRIMARIA": "3182090225",
        "W_TELEFONOIPSMEDICAMENTO": null,
        "W_NOMBREIPSPRIMARIA": "EVE DISTRIBUCIONES S.A.S EVEDISA",
        "W_NOMBREIPSMEDICAMENTO": null,
        "W_FECVENCIMIENTOPORTABILIDAD": null,
        "W_ESTADOPORTABILIDAD": null,
        "W_DIRECCIONIPSPRIMARIA": "Calle 30 # 20 -192",
        "W_DIRECCIONIPSMEDICAMENTO": null,
        "TIPO_POBLACIONDESCRIPCION": "Población con SISBEN",
        "TIPO_POBLACION": "5",
        "TIPO_IDENTIFICACION": "CC",
        "TELEFONO": "3017343783",
        "SUCURSALPORTABILIDAD": null,
        "SUCURSALAFILIADO": "13",
        "SEXO": "M",
        "SEGUNDO_NOMBRE": "ANTONIO",
        "SEGUNDO_APELLIDO": "MARTINEZ",
        "REGIMEN": "Contributivo",
        "RC_CORREOELECTRONICO": "edanroma@hotmail.com",
        "RC_CODTIPOAFILIADODESCRIPCION": "Cotizante",
        "RC_CODTIPOAFILIADO": "C",
        "RC_CODNIVELEDUCATIVODESCRIPCION": "No definido",
        "RC_CODNIVELEDUCATIVO": "1",
        "RC_CODESTADOCIVILDESCRIPCION": "Soltero(a)",
        "RC_CODESTADOCIVIL": "SO",
        "RC_CLASEAFILIACIONDESCRIPCION": null,
        "RC_CLASEAFILIACION": null,
        "razonSocialOficinaConsultaAfiliado": null,
        "razonSocialOficinaAsignada": null,
        "RANGO": "C",
        "PRIMER_NOMBRE": "EDUAR",
        "PRIMER_APELLIDO": "RODRIGUEZ",
        "oficinaIdAsignada": null,
        "oficinaEntregaNoPossConsultaAfiliado": null,
        "oficinaEntregaNoPossAsignada": null,
        "OFICINA_DISPENSACION": "EVE DISTRIBUCIONES S.A.S EVEDISA",
        "NUMERO_IDENTIFICACION": "9146767",
        "NIVEL_SISBEN": "1",
        "nitOficinaConsultaAfiliado": null,
        "nitOficinaAsignada": null,
        "NITOFICINA_DISPENSACION": "891409291",
        "IPSENTREGAMEDICAMENTOS": null,
        "IPS_ASIGNADA": "PROVIDA FARMACEUTICA SAS",
        "FICHA_SISBEN": "9999",
        "FECHA_NACIMIENTO": "1980/07/15",
        "FECHA_AFILIACION": "2019/08/01",
        "ESTAENPORTABILIDAD": "NO",
        "ESTADO": "AC",
        "errorId": 5,
        "ERROR": "El afiliado no tiene oficina dispensacion medicamento asignada.",
        "DIRECCION": "PUENTE HONDA, OASIS CALATRAVA L1A-1 (CERCA A CLUB CAMPESTRE)",
        "DESCRIPCIONDEPARTAMENTO": "BOLÍVAR",
        "DESCRIPCIONCIUDAD": "TURBACO",
        "DEPARTAMENTOPORTABILIDADDESCRIPCION": null,
        "DEPARTAMENTOPORTABILIDAD": null,
        "DEPARTAMENTO": "13",
        "CIUDADPORTABILIDADDESCRIPCION": null,
        "CIUDADPORTABILIDAD": null,
        "CIUDAD": "836",
        "CELULAR": "3017343783",
        "CARNET": "13001032735"
    }
}

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

No se conocen errores por ahora.

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: