diff --git a/apigee/afiliaciones-afiliado.json b/apigee/afiliaciones-afiliado.json index e4d7b11..b890a0f 100644 --- a/apigee/afiliaciones-afiliado.json +++ b/apigee/afiliaciones-afiliado.json @@ -35,7 +35,7 @@ "tags": [ "cols-afiliaciones-afiliado" ], - "summary": "Consulta de la persona afiliada.", + "summary": "Consulta de afiliado como trabajador dependiente.", "description": "Obtener informacion de una persona afiliada y sus beneficiarios.", "operationId": "obtenerAfiliadoDep", "parameters": [ @@ -108,6 +108,40 @@ ] } ] + }, + "post": { + "tags": [ + "cols-afiliaciones-afiliado" + ], + "summary": "Crear afiliado como trabajador dependiente.", + "description": "Afiliar a trabajador dependiente y sus beneficiarios.", + "operationId": "crearAfiliadoDep", + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearAfiliadoResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/crearAfiliadoRequestBody" + } } }, "/v1/afiliaciones/afiliado/retiro": { @@ -115,8 +149,8 @@ "tags": [ "cols-afiliaciones-afiliado" ], - "summary": "Consulta de la perdona retirada.", - "description": "Obtener informacion de una persona retirada.", + "summary": "Consulta del afiliado retirado.", + "description": "Obtener informacion de un afiliado retirado.", "operationId": "retiroAfiliadoDep", "parameters": [ { @@ -188,6 +222,102 @@ ] } ] + }, + "delete": { + "tags": [ + "cols-afiliaciones-afiliado" + ], + "summary": "Retiro de afiliado.", + "description": "Retirar afiliado.", + "operationId": "retirarAfiliadoDep", + "parameters": [ + { + "name": "tipoIdEmp", + "in": "query", + "description": "Tipo de documento de identificacion de empleador, ejemplo: CO1N.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numIdEmp", + "in": "query", + "description": "Numero de documento del empleador, ejemplo: 860523408.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "digVerifica", + "in": "query", + "description": "Digito de verificacion, ejemplo: 6", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tipoId", + "in": "query", + "description": "Tipo de documento de identificacion, ejemplo: CO1C.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numId", + "in": "query", + "description": "Numero de identificacion del documento.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fechaRet", + "in": "query", + "description": "Fecha de retiro del afiliado en formato ISO 8601 sin guiones. AAAAMMDD.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "motivoRet", + "in": "query", + "description": "Motivo de retiro del afiliado.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/retirarAfiliadoDepResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] } } }, @@ -258,6 +388,7 @@ "properties": { "fecha": { "type": "string", + "format": "date-time", "description": "Fecha de nacimiento." } }, @@ -277,6 +408,77 @@ "name": "nacimiento" } }, + "contrato": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de contrato." + }, + "horasDiaria": { + "type": "string", + "description": "Horas diarias del empleo." + }, + "horasMes": { + "type": "string", + "description": "Horas mensuales del empleo." + }, + "fechaIngreso": { + "type": "string", + "format": "date-time", + "description": "Fecha de ingreso al empleo." + } + }, + "xml": { + "name": "contrato" + } + }, + "salario": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de salario." + }, + "basico": { + "type": "string", + "description": "Salario basico." + } + }, + "xml": { + "name": "salario" + } + }, + "ingresos": { + "type": "object", + "properties": { + "salario": { + "$ref": "#/components/schemas/salario" + } + }, + "xml": { + "name": "ingresos" + } + }, + "empleo": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de actividad." + }, + "ingresos": { + "$ref": "#/components/schemas/ingresos" + }, + "contrato": { + "$ref": "#/components/schemas/contrato" + } + }, + "xml": { + "name": "empleo" + } + }, + "empleador": { "type": "object", "properties": { @@ -286,6 +488,10 @@ "digitoVerificacion": { "type": "string", "description": "Digito de verificacion." + }, + "agrupacion": { + "type": "string", + "description": "Agrupacion." } }, "xml": { @@ -330,12 +536,78 @@ "subsidio": { "type": "string", "description": "Subsidio." + }, + "discapacidad": { + "type": "string", + "description": "Discapacidad." } + }, "xml": { "name": "beneficiario" } }, + "afiliadoRequest": { + "type": "object", + "properties": { + "empleador": { + "$ref": "#/components/schemas/empleador" + }, + "nombre": { + "$ref": "#/components/schemas/nombre" + }, + "documento": { + "$ref": "#/components/schemas/documento" + }, + "nacimiento": { + "$ref": "#/components/schemas/nacimiento" + }, + "genero": { + "$ref": "#/components/schemas/genero" + }, + "direccion": { + "$ref": "#/components/schemas/direccion" + }, + "empleo": { + "$ref": "#/components/schemas/empleo" + }, + "estadoCivil": { + "type": "string", + "description": "Estado civil del afiliado." + }, + "telefono": { + "type": "string", + "description": "Telefono fijo del afiliado." + }, + "celular": { + "type": "string", + "description": "Celular del afiliado." + }, + "correoElectronico": { + "type": "string", + "description": "Correo electronico del afiliado." + }, + "nacionalidad": { + "type": "string", + "description": "Nacionalidad del afiliado." + }, + "fechaAfiliacion": { + "type": "string", + "format": "date-time", + "description": "Fecha de afiliacion." + }, + "beneficiario": { + "type": "array", + "items": { + "$ref": "#/components/schemas/beneficiario" + } + } + }, + "xml": { + "name": "afiliado" + } + }, + "afiliado": { "type": "object", "properties": { @@ -515,6 +787,7 @@ }, "fechaRetiro": { "type": "string", + "format": "date-time", "description": "Fecha de retiro de afiliado." }, "motivoRetiro": { @@ -537,6 +810,48 @@ "name": "retiroAfiliadoDep" } }, + "crearAfiliadoRequest": { + "type": "object", + "properties": { + "afiliado": { + "$ref": "#/components/schemas/afiliadoRequest" + } + } + }, + "crearAfiliadoResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + } + } + }, + "retirarAfiliadoDepResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + } + } + }, "retiroAfiliadoDepResponse": { "type": "object", "required": [ @@ -561,7 +876,19 @@ } } }, - "requestBodies": {}, + "requestBodies": { + "crearAfiliadoRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearAfiliadoRequest" + } + } + }, + "description": "Request para la creacion de un afiliado dependiente.", + "required": true + } + }, "securitySchemes": { "apigee_auth": { "type": "oauth2",