Skip to content

S
swagger
Commit 83c1cf26 by Cristian_Camargo
Options

Update afiliaciones-afiliado.json, Agregado servicio de validador Empresa

parent de09025d
Showing with 452 additions and 0 deletions
apigee/afiliaciones-afiliado.json
...@@ -31,6 +31,10 @@ ...@@ -31,6 +31,10 @@
{ {
"name": "cols-afiliaciones-validador", "name": "cols-afiliaciones-validador",
"description": "Consulta de afiliaciones a través del validador." "description": "Consulta de afiliaciones a través del validador."
},
{
"name": "cols-afiliaciones-validadorempresas",
"description": "Consulta de afiliaciones para validar empresas."
} }
], ],
"paths": { "paths": {
...@@ -538,14 +542,462 @@ ...@@ -538,14 +542,462 @@
} }
] ]
} }
},
"/v2/afiliaciones/validadorempresas": {
"get": {
"tags": [
"cols-afiliaciones-validadorempresas"
],
"summary": "Información del afiliado ",
"description": "Retorna la información detallada de una empresa.",
"operationId": "validadorEmpresas",
"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/validadorEmpresaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
} }
}, },
},
"externalDocs": { "externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect", "description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect" "url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
}, },
"components": { "components": {
"schemas": { "schemas": {
"validadorEmpresaResponse": {
"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/afiliadoValidadorEmpresa"
}
}
}
},
"afiliadoValidadorEmpresa": {
"type": "object",
"properties": {
"contribuyente": {
"$ref": "#/components/schemas/validadorEmpresa"
}
}
},
"telefonoValidadorEmpresa": {
"type": "object",
"properties": {
"fijo":{
"type":"string",
"description":"Telefono fijo"
},
"celular":{
"type":"string",
"description":"Telefono celular"
},
}
},
"direccionValidadorEmpresa": {
"type": "object",
"properties": {
"pais":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion del pais"
},
"nombre":{
"type":"string",
"description":"Nombre del pais"
},
}
},
"departamento":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion del departamento"
},
"nombre":{
"type":"string",
"description":"Nombre del departamento"
},
}
},
"ciudad":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion de la ciudad"
},
"nombre":{
"type":"string",
"description":"Nombre de la ciudad"
},
}
},
"localidad":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion de la localidad"
},
"nombre":{
"type":"string",
"description":"Nombre de la localidad"
},
}
},
"direccionPrincipal":{
"type":"string",
"description":"Direccion principal"
},
"barrio":{
"type":"string",
"description":"Barrio"
},
"direccionSecundaria":{
"type":"string",
"description":"Direccion secundaria"
},
}
},
"representanteLegal":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion"
},
"tipoDocumento":{
"type":"string",
"description":"Tipo de documento del representanteLegal"
},
"numeroDocumento":{
"type":"string",
"description":"Numero de documento del representanteLegal"
},
"nombre":{
"type":"string",
"description":"Nombre del representanteLegal"
},
"primerNombre":{
"type":"string",
"description":"Primer nombre del representanteLegal"
},
"segundoNombre":{
"type":"string",
"description":"Segundo nombre del representanteLegal"
},
"primerApellido":{
"type":"string",
"description":"Primer apellido del representanteLegal"
},
"segundoApellido":{
"type":"string",
"description":"Segundo apellido del representanteLegal"
},
"idPosicion":{
"type":"string",
"description":"Numero de identificacion de la posicion del representanteLegal"
},
}
},
"contactoAdministrador":{
"type":"object",
"properties":{
"tipoDocumento":{
"type":"string",
"description":"Tipo de documento del contacto administrador"
},
"numeroDocumento":{
"type":"string",
"description":"Numero de documento del contacto administrador"
},
"nombre":{
"type":"string",
"description":"Nombre del contacto administrador"
},
}
},
"actividadEconomica":{
"type":"object",
"properties":{
"codigo":{
"type":"string",
"description":"Codigo de actividad economica"
},
"descripcion":{
"type":"string",
"description":"Descripcion de actividad economica"
},
"agrupacion":{
"type":"string",
"description":"Agrupacion de actividad economica"
},
}
},
"claseValidadorEmpresa":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Numero de identificacion de clase"
},
"descripcion":{
"type":"string",
"description":"Descripcion de clase"
}
}
},
"detalleAportantes":{
"type":"object",
"properties":{
"tipoContrato":{
"type":"string",
"description":"Tipo de contrato"
},
"descripcionContrato":{
"type":"string",
"description":"Descripcion del contrato"
},
"claseInterlocutor":{
"type":"string",
"description":"Clase de interlocutor"
},
"descripcionInterlocutor":{
"type":"string",
"description":"Descripcion de interlocutor"
},
"estado":{
"type":"object",
"properties":{
"estadoId":{
"type":"string",
"description":"Estado id"
},
"fechaInicio":{
"type":"string",
"description":"Fecha de inicio"
},
"fechaFin":{
"type":"string",
"description":"Fecha de fin"
},
}
},
"numeroCotizantes":{
"type":"string",
"description":"Numero de cotizantes"
},
"numeroConyuges":{
"type":"string",
"description":"Numero de conyugues"
},
"numeroPacs":{
"type":"string",
"description":"Numero de pacs"
},
"retiro":{
"type":"object",
"properties":{
"motivo":{
"type":"string",
"description":"Motivo de retiro"
},
"descripcion":{
"type":"string",
"description":"Descripcion de retiro"
}
}
},
"modalidad":{
"type":"object",
"properties":{
"nombre":{
"type":"string",
"description":"Nombre de modalidad"
},
"descripcion":{
"type":"string",
"description":"Descripcion de modalidad"
}
}
},
"pago":{
"type":"object",
"properties":{
"via":{
"type":"string",
"description":"Via de pago"
},
"descripcion":{
"type":"string",
"description":"Descripcion de pago"
}
}
},
"ultimoCicloPagado":{
"type":"string",
"description":"Ultimo ciclo pagado"
},
"fechaInicioAporte":{
"type":"string",
"description":"Fecha de inicio aporte"
},
"distribucionId":{
"type":"string",
"description":"Distribucion Id"
},
"pagoAportesId":{
"type":"string",
"description":"Id de pago de aportes"
}
}
},
"validadorEmpresa": {
"type": "object",
"properties": {
"nombre":{
"type":"string",
"description":"Nombre del contribuyente"
},
"numeroDocumento":{
"type":"string",
"description":"Número de documento del contribuyente"
},
"tipoDocumento":{
"type":"string",
"description":"Tipo de documento del contribuyente"
},
"telefono":{
"$ref": "#/components/schemas/telefonoValidadorEmpresa"
},
"direccion":{
"$ref": "#/components/schemas/direccionValidadorEmpresa"
},
"correoElectronico":{
"type":"string",
"description":"Correo electronico del contribuyente"
},
"sitioWebEmpresa":{
"type":"string",
"description":"Pagina web del contribuyente"
},
"representanteLegal":{
"$ref": "#/components/schemas/representanteLegal"
},
"contactoAdministrador":{
"$ref": "#/components/schemas/contactoAdministrador"
},
"nombreSujetoDerecho":{
"type":"string",
"description":"Nombre sujeto derecho"
},
"formaJuridica":{
"type":"string",
"description":"Forma juridica"
},
"actividadEconomica":{
"$ref": "#/components/schemas/actividadEconomica"
},
"clase":{
"$ref": "#/components/schemas/claseValidadorEmpresa"
},
"leyMiPyme":{
"type":"string",
"description":"leyMiPyme"
},
"fechaAfiliacion":{
"type":"string",
"description":"Fecha de afiliacion"
},
"idAlcaldia":{
"type":"string",
"description":"Numero de identificacion de alcaldia"
},
"idOficinaColsubsidio":{
"type":"string",
"description":"Numero de identificacion de oficina Colsubsidio"
},
"localidad":{
"type":"string",
"description":"Localidad"
},
"tipoPersona":{
"type":"string",
"description":"Tipo de persona"
},
"tipoContribuyente":{
"type":"string",
"description":"Tipo de contribuyente"
},
"fechaInicio":{
"type":"string",
"description":"Fecha de inicio"
},
"detalleAportantes": {
"type": "array",
"items":{
"$ref": "#/components/schemas/detalleAportantes"
}
}
}
},
"validadorEmpleadorResponse": { "validadorEmpleadorResponse": {
"type": "object", "type": "object",
"required": [ "required": [
......
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