{
"openapi": "3.0.0",
"servers": [
{
"description": "Calidad",
"url": "https://colsubsidio-test.apigee.net/api"
},
{
"description": "Producción",
"url": "https://colsubsidio-prod.apigee.net/api"
}
],
"info": {
"description": "Información de los servicios del producto EPS salud.",
"version": "2.0.0",
"title": "EPS Salud",
"termsOfService": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger",
"contact": {
"email": "operacionesti@colsubsidio.com"
},
"license": {
"name": "Colsubsidio",
"url": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger"
}
},
"tags": [
{
"name": "cols-salud-afiliado",
"description": "Afiliados de salud"
},
{
"name": "cols-salud-cita",
"description": "Administración de citas"
},
{
"name": "cols-salud-eps",
"description": "EPSs"
},
{
"name": "cols-salud-ips",
"description": "IPSs"
},
{
"name": "cols-salud-multa",
"description": "Manejo de multas de las citas en salud"
},
{
"name": "cols-salud-paciente",
"description": "Pacientes de salud"
}
],
"paths": {
"/v2/salud/afiliados": {
"get": {
"tags": [
"cols-salud-afiliado"
],
"summary": "Validador paciente",
"description": "Obtener información de los afiliados de salud.",
"operationId": "validadorPaciente",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "asociado",
"in": "query",
"description": "Es un asociado o no
1 - Sí
0 - No",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cesan",
"in": "query",
"description": "Empresa en la que tiene la cesantías",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/validadorPacienteResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
}
},
"externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
},
"components": {
"schemas": {
"resultado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del resultado"
},
"descripcion": {
"type": "string",
"description": "Descripción del resultado"
}
},
"xml": {
"name": "resultado"
}
},
"documento": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de documento"
},
"numero": {
"type": "string",
"description": "Número de identificación del documento"
}
},
"xml": {
"name": "documento"
}
},
"nombre": {
"type": "object",
"properties": {
"primero": {
"type": "string",
"description": "Primer nombre"
},
"segundo": {
"type": "string",
"description": "Segundo nombre"
},
"primerApellido": {
"type": "string",
"description": "Primer apellido"
},
"segundoApellido": {
"type": "string",
"description": "Segundo apellido"
}
},
"xml": {
"name": "nombre"
}
},
"categoria": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código de la categoría"
}
},
"xml": {
"name": "categoria"
}
},
"tipo": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del tipo"
}
},
"xml": {
"name": "tipo"
}
},
"estado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del estado"
}
},
"xml": {
"name": "estado"
}
},
"convenio": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del convenio"
},
"estado": {
"type": "string",
"description": "Estado del convenio"
},
"nombre": {
"type": "string",
"description": "Nombre del convenio"
},
"clase": {
"type": "string",
"description": "Clase del convenio"
}
},
"xml": {
"name": "convenio"
}
},
"eps": {
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"type": "string",
"description": "Nombre de la EPS"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
}
},
"xml": {
"name": "eps"
}
},
"afiliado": {
"type": "object",
"properties": {
"fechaComprobacion": {
"type": "string",
"description": "Fecha de comprobación",
"format": "date-time"
},
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"$ref": "#/components/schemas/nombre"
},
"categoria": {
"$ref": "#/components/schemas/categoria"
},
"tipo": {
"$ref": "#/components/schemas/tipo"
},
"estado": {
"$ref": "#/components/schemas/estado"
},
"semanasCotizadas": {
"type": "integer",
"description": "Semanas cotizadas"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
},
"eps": {
"$ref": "#/components/schemas/eps"
}
},
"xml": {
"name": "afiliado"
}
},
"validadorPacienteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"afiliado": {
"$ref": "#/components/schemas/afiliado"
}
}
}
},
"securitySchemes": {
"apigee_auth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://colsubsidio-test.apigee.net/oauth/client_credential/accesstoken?grant_type=client_credentials",
"scopes": {
"write:apigee": "Permisos de escritura",
"read:apigee": "Permisos de lectura"
}
}
}
}
}
}
}