Skip to content

S
swagger
Commit 8c124453 by Cristian_Camargo
Options

Update afiliaciones-afiliado.json

parent 22cb08ef
Showing with 528 additions and 1 deletions
apigee/afiliaciones-afiliado.json
...@@ -27,6 +27,10 @@ ...@@ -27,6 +27,10 @@
{ {
"name": "cols-afiliaciones-afiliado", "name": "cols-afiliaciones-afiliado",
"description": "Consulta de los servicios de afiliaciones." "description": "Consulta de los servicios de afiliaciones."
},
{
"name": "cols-afiliaciones-validador",
"description": "Consulta de afiliaciones a través del validador."
} }
], ],
"paths": { "paths": {
...@@ -319,6 +323,60 @@ ...@@ -319,6 +323,60 @@
} }
] ]
} }
},
"/v2/afiliacion/validador": {
"get": {
"tags": [
"cols-afiliaciones-validador"
],
"summary": "Información del afiliado ",
"description": "Retorna la información detallada de un afiliado a la caja.",
"operationId": "validadorAfiliado",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de documento de identificacion, ejemplo: CO1C.",
"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": { "externalDocs": {
...@@ -498,6 +556,87 @@ ...@@ -498,6 +556,87 @@
"name": "empleador" "name": "empleador"
} }
}, },
"companias":{
"type":"object",
"properties":{
"bp":{
"type":"integer",
"description":"Código de SAP"
},
"tipoDocumento":{
"type":"string",
"description":"Tipo de documento"
},
"numberoDocumento":{
"type":"integer",
"description":"Tipo de documento"
},
"nombre":{
"type":"string",
"description":"Razón social de la empresa"
},
"tipoAportante":{
"type":"string",
"description":"Descripcion del Tipo de contribuyente DIAN. Ejemplo:Gran Contribuyente "
},
"claserAportante":{
"type":"string",
"description":"Código que determina la clase de aporte"
},
"fechaInicioActividad":{
"type":"string",
"description":"Fecha de ingreso de actividades"
},
"estado":{
"type":"string",
"description":"Código que determina el estado de la actividad"
},
"fechaIngresoAfiliado":{
"type":"string",
"description":"Fecha de ingreso del afiliado a la empresa"
},
"fechaInicioVigencia":{
"type":"string",
"description":"Fecha de afiliación de la empresa a la caja"
},
"fechaFinVigencia":{
"type":"string",
"description":"Fecha de fin de la vigencia de la empresa para casos donde su estado sea retirado."
},
"salario":{
"type":"string",
"description":"Salario que está devengando en la empresa especifica."
},
"sucursal":{
"type":"string",
"description":"Sucursal de la compañia."
},
"localidad":{
"type":"string",
"description":"Localidad de la compañia."
},
"empresaPrincipal":{
"type":"string",
"description":"Marca con la cual se identifica si la empresa es el principal empleador del afiliado"
},
}
},
"empleadorValidacion": {
"type": "object",
"properties": {
"empleadoresConcurrentes": {
"type":"integer",
"description":"Número de empleadores"
},
"companias": {
"$ref": "#/components/schemas/companias"
},
},
"xml": {
"name": "empleador"
}
},
"beneficiario": { "beneficiario": {
"type": "object", "type": "object",
"properties": { "properties": {
...@@ -547,6 +686,141 @@ ...@@ -547,6 +686,141 @@
"name": "beneficiario" "name": "beneficiario"
} }
}, },
"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":"integer",
"description":"Fecha de nacimiento"
},
"relacion": {
"type":"object",
"properties":{
"codigo":{
"type":"string",
"description":"codigo"
},
"descripcion":{
"type":"string",
"description":"descripción"
},
}
},
"fechaInicioVigencia":{
"type":"string",
"description":"Fecha de inicio de la vigencia de la empresa para casos donde su estado sea retirado."
},
"fechaFinVigencia":{
"type":"string",
"description":"Fecha de fin de la vigencia de la empresa para casos donde su estado sea retirado."
},
"fechaRegistroRetiro":{
"type":"string",
"description":" en el que se registra el retiro"
},
"discapacidad":{
"type":"integer",
"description":"Código de discapacidad"
},
"fechaLimiteComprobanteNutricional":{
"type":"integer",
"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": "beneficiario"
}
},
"afiliadoRequest": { "afiliadoRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
...@@ -654,6 +928,12 @@ ...@@ -654,6 +928,12 @@
"items": { "items": {
"$ref": "#/components/schemas/beneficiario" "$ref": "#/components/schemas/beneficiario"
} }
},
"pacs":{
"type":"array",
"items":{
"$ref": "#/components/schemas/pacs"
}
} }
}, },
"xml": { "xml": {
...@@ -736,6 +1016,7 @@ ...@@ -736,6 +1016,7 @@
} }
} }
}, },
"natural": { "natural": {
"type": "object", "type": "object",
"properties": { "properties": {
...@@ -799,6 +1080,141 @@ ...@@ -799,6 +1080,141 @@
"name": "afiliado" "name": "afiliado"
} }
}, },
"afiliacion": {
"type": "object",
"properties": {
"fechaAfiliacion": {
"type":"string",
"description":"fecha de afiliación"
},
"categoria": {
"type":"string",
"description":"Categoría"
},
"grupo": {
"type":"string",
"description":"Grupo"
},
"tipoSalario": {
"type":"string",
"description":"Tipo de salario"
},
"salario": {
"type":"string",
"description":"salario"
},
"salarioOtros": {
"type":"string",
"description":"salario"
},
"fechaRetiro": {
"type":"string",
"description":"Fecha del retiro"
},
"tipoCargo": {
"type":"string",
"description":"Tipo de cargo"
},
"horasLaboradas": {
"type":"string",
"description":"Horas laboradas"
},
"tipoTrabajador": {
"type":"string",
"description":"Tipo de trabajador"
}
},
"xml": {
"name": "afiliado"
}
},
"cuotaMonetaria": {
"type": "object",
"properties": {
"tieneCuotaMonetaria": {
"type":"string",
"description":"fecha de afiliación"
},
"lugarEntrega": {
"type":"string",
"description":"Categoría"
},
"valorUltimoSubsidio": {
"type":"string",
"description":"Grupo"
},
"monto": {
"type":"string",
"description":"Tipo de salario"
}
},
"xml": {
"name": "afiliado"
}
},
"tarjetaMultiservicios": {
"type": "object",
"properties": {
"lote": {
"type":"string",
"description":"fecha de afiliación"
},
"numeroTarjeta": {
"type":"string",
"description":"Categoría"
},
"serialProximidad": {
"type":"string",
"description":"Grupo"
},
"gp": {
"type":"integer",
"description":"Tipo de salario"
},
"estado": {
"type":"integer",
"description":"Tipo de salario"
},
"fechaEntrega ": {
"type":"integer",
"description":"Tipo de salario"
},
"fechaExpedicion ": {
"type":"integer",
"description":"Tipo de salario"
},
"causaCambio": {
"type":"integer",
"description":"Tipo de salario"
},
"ultimoMesPagado": {
"type":"integer",
"description":"Tipo de salario"
},
"motivoBloqueo": {
"type":"integer",
"description":"Tipo de salario"
},
"metodoPago": {
"type":"object",
"properties":{
"id":{
"type":"integer",
"description":"id del método de pago"
},
"nombre":{
"type":"string",
"description":"Nombre del método de pago"
}
}
}
},
"xml": {
"name": "afiliado"
}
},
"retiroAfiliadoDep": { "retiroAfiliadoDep": {
"type": "object", "type": "object",
"properties": { "properties": {
...@@ -874,7 +1290,118 @@ ...@@ -874,7 +1290,118 @@
} }
} }
} }
} },
"validadorResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"data": {
"$ref": "#/components/schemas/validador"
}
}
},
"validador": {
"type": "object",
"properties": {
"bp":{
"type":"integer",
"description":"Identificador único del SAP"
},
"numeroDocumento":{
"type":"integer",
"description":"Número de documento del afiliado"
},
"tipoDocumento":{
"type":"integer",
"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",
"description":"Fecha de nacimiento del afiliado"
},
"edad":{
"type":"integer",
"description":"Fecha de nacimiento del afiliado"
},
"genero":{
"type":"integer",
"description":"Código de género del afiliado"
},
"estadoCivil":{
"type":"integer",
"description":"Código de estado civil"
},
"personasACargo":{
"type":"integer",
"description":"Número de personas a cargo"
},
"nivelEducativo":{
"type":"string",
"description":"Nivel educativo de la persona"
},
"telefono":{
"type":"integer",
"description":"Teléfono de la persona"
},
"motivoRetiro":{
"type":"string",
"description":"Descripción del motivo de Retiro"
},
"direccion":{
"$ref": "#/components/schemas/direccion"
},
"estado":{
"type":"string",
"description":"Estado del Afiliado"
},
"afiliacion":{
"$ref": "#/components/schemas/afiliacion"
},
"empleadores":{
"$ref": "#/components/schemas/empleadorValidacion"
},
"pacs":{
"$ref": "#/components/schemas/pacs"
},
"cuotaMonetaria":{
"$ref": "#/components/schemas/cuotaMonetaria"
},
"tarjetaMultiservicios":{
"$ref": "#/components/schemas/tarjetaMultiservicios"
}
}
},
}, },
"requestBodies": { "requestBodies": {
"crearAfiliadoRequestBody": { "crearAfiliadoRequestBody": {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment