diff --git a/apigee/afiliaciones-afiliado-pacs.json b/apigee/afiliaciones-afiliado-pacs.json new file mode 100644 index 0000000..70eba50 --- /dev/null +++ b/apigee/afiliaciones-afiliado-pacs.json @@ -0,0 +1,349 @@ +{ + "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 de afiliaciones y afiliados.", + "version": "1.0.0", + "title": "Afiliaciones afiliado pacs", + "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-afiliaciones-validador", + "description": "Consulta de afiliaciones a través del validador." + } + ], + "paths": { + "/v2/afiliacion/validador/personas/pacs": { + "get": { + "tags": [ + "cols-afiliaciones-validador" + ], + "summary": "Información basica del afiliado ", + "description": "Retorna la información detallada de un afiliado a la caja.", + "operationId": "validadorAfiliadoPersona", + "parameters": [ + + { + "name": "tipoId", + "in": "query", + "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numeroId", + "in": "query", + "description": "Numero de documento.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/validadorResponse" + } + } + } + }, + "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" + } + }, + "pacs": { + "type": "object", + "properties": { + "bp": { + "type": "string", + "description":"Identificador único en SAP de un Afiliado,Beneficiario, Empresa o Entidad." + }, + "tipoDocumento": { + "type":"string", + "description":"Tipo de documento" + }, + "numeroDocumento": { + "type":"integer", + "description":"Número de documento de la persona a cargo del Afiliado" + }, + "primerNombre": { + "type":"string", + "description":"Primer Nombre de la persona a cargo del Afiliado" + }, + "segundoNombre": { + "type":"string", + "description":"Segundo Nombre de la persona a cargo del Afiliado" + }, + "apellido": { + "type":"string", + "description":"Primer Apellido de la persona a cargo del Afiliado" + }, + "segundoApellido": { + "type":"string", + "description":"Segundo Apellido de la persona a cargo del Afiliado" + }, + "edad": { + "type":"integer", + "description":"Edad de la persona a cargo del afiliado" + }, + "genero": { + "type":"integer", + "description":"Edad de la persona a cargo del afiliado" + }, + "fechaNacimiento": { + "type":"string", + "format": "date-time", + "description":"Fecha de nacimiento" + }, + "relacion": { + "type":"object", + "properties":{ + "codigo":{ + "type":"string", + "description":"codigo" + }, + "descripcion":{ + "type":"string", + "description":"descripción" + }, + + } + }, + "fechaInicioVigencia":{ + "type":"string", + "format": "date-time", + "description":"Fecha de inicio de la vigencia de la empresa para casos donde su estado sea retirado." + }, + "fechaFinVigencia":{ + "type":"string", + "format": "date-time", + "description":"Fecha de fin de la vigencia de la empresa para casos donde su estado sea retirado." + }, + "fechaRegistroRetiro":{ + "type":"string", + "format": "date-time", + "description":" en el que se registra el retiro" + }, + "discapacidad":{ + "type":"integer", + "description":"Código de discapacidad" + }, + "fechaLimiteComprobanteNutricional":{ + "type":"string", + "format": "date-time", + "description":"Fecha límite" + }, + "documentacion":{ + "type":"object", + "properties":{ + "motivoBloqueo":{ + "type":"string", + "description":"tipo de bloqueo" + }, + "descripcionBloqueo":{ + "type":"string", + "description":"Descripción del bloqueo" + } + } + }, + "tarjeta":{ + "type":"object", + "properties":{ + "numero":{ + "type":"string", + "description":"Número de Tarjeta Amparada " + }, + "estado":{ + "type":"string", + "description":"ACTIVA o INACTIVA" + }, + "lote":{ + "type":"string", + "description":"Lote de la tarjeta" + } + } + }, + "cuotaMonetaria":{ + "type":"object", + "properties":{ + "motivoBloqueo":{ + "type":"string", + "description":"Motivo del salario" + }, + "salario":{ + "type":"string", + "description":"Salario" + } + } + }, + "nivelEducativo":{ + "type":"string", + "description":"Nivel educativo de la persona" + }, + "estado":{ + "type":"string", + "description":"Estado" + } + + }, + "xml": { + "name": "pacs" + } + }, + "validadorResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "estado":{ + "type":"string", + "description":"Estado del servicio" + }, + "mensaje":{ + "type":"string", + "description":"Mensaje del servicio" + }, + "data": { + "type": "array", + "items":{ + "$ref": "#/components/schemas/afiliadoValidador" + } + } + } + }, + "afiliadoValidador": { + "type": "object", + "properties": { + "afiliado": { + "$ref": "#/components/schemas/validador" + }, + "pacs":{ + "type": "array", + "items":{ + "$ref": "#/components/schemas/pacs" + } + } + } + }, + "validador": { + "type": "object", + "properties": { + "numeroDocumento":{ + "type":"string", + "description":"Número de documento del afiliado" + }, + "tipoDocumento":{ + "type":"string", + "description":"Número de documento del afiliado" + }, + "primerNombre":{ + "type":"string", + "description":"primer nombre del afiliado" + }, + "segundoNombre":{ + "type":"string", + "description":"segundo nombre del afiliado" + }, + "primerApellido":{ + "type":"string", + "description":"primer apellido del afiliado" + }, + "segundoApellido":{ + "type":"string", + "description":"Segundo apellido del afiliado" + }, + "fechaNacimiento":{ + "type":"string", + "format": "date-time", + "description":"Fecha de nacimiento del afiliado" + }, + "genero":{ + "type":"string", + "description":"Código de género del afiliado" + }, + "estadoCivil":{ + "type":"string", + "description":"Código de estado civil" + }, + "estado":{ + "type":"string", + "description":"Estado del Afiliado" + } + } + }, + }, + "requestBodies": { + }, + "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" + } + } + } + } + } + } +} \ No newline at end of file