Commit 93b7e07a by Cristian_Camargo

Add new file

parent b3f43a45
{
"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 empleador",
"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/empleador": {
"get": {
"tags": [
"cols-afiliaciones-validador"
],
"summary": "Información basica del afiliado y empleador",
"description": "Retorna la información de un afiliado a la caja y el empleador.",
"operationId": "validadorAfiliadoPersona",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "<table border='1' width='10px'> <thead> <tr> <td colspan='2'><center>Tipos de identificación</center></td> </tr> </thead> <tr> <th>TipoID</th> <th>Descripción</th> </tr> <tr> <td>CO1C</td> <td>Cédula</td> </tr> <tr> <td>CO1N</td> <td>Nit</td> </tr> <tr> <td>CO1E</td> <td>Cédula de extranjería</td> </tr> <tr> <td>CO1T</td> <td>Tarjeta de identidad</td> </tr> <tr> <td>CO1L</td> <td>Registro Civil</td> </tr> <tr> <td>CO1P</td> <td>Pasaporte</td> </tr> <tr> <td>CO1D</td> <td>Carnet Diplomático</td> </tr> <tr> <td>CO1S</td> <td>Sin identificación del exterior</td> </tr> <tr> <td>CO1V</td> <td>Permiso Especial de Permanencia</td> </tr> <tr> <td>CO1X</td> <td>Tarjeta de extranjería</td> </tr> </table>",
"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": {
"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": {
"type": "array",
"items":{
"$ref": "#/components/schemas/companias"
}
},
},
"xml": {
"name": "empleador"
}
},
"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"
}
},
"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"
},
"empleadores":{
"$ref": "#/components/schemas/empleadorValidacion"
}
}
},
"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"
},
"afiliacion":{
"$ref": "#/components/schemas/afiliacion"
}
}
},
},
"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
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