Add new file

apigee/afiliaciones-afiliado.json

+{
+  "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",
+    "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-afiliado",
+      "description": "Consulta de los servicios de afiliaciones."
+    }
+  ],
+  "paths": {
+    "/v1/afiliaciones/afiliado": {
+      "get": {
+        "tags": [
+          "cols-afiliaciones-afiliado"
+        ],
+        "summary": "Consulta de la persona afiliada.",
+        "description": "Obtener informacion de una persona afiliada y sus beneficiarios.",
+        "operationId": "obtenerAfiliadoDep",
+        "parameters": [
+          {
+            "name": "tipoId",
+            "in": "query",
+            "description": "Tipo de documento de identificacion, ejemplo: CO1C.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "numId",
+            "in": "query",
+            "description": "Numero de documento.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Operación exitosa",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/obtenerAfiliadoResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Estado inválido"
+          }
+        },
+        "security": [
+          {
+            "apigee_auth": [
+              "write:apigee",
+              "read:apigee"
+            ]
+          }
+        ]
+      }
+    },
+    "/v1/afiliaciones/afiliado/retiro": {
+      "get": {
+        "tags": [
+          "cols-afiliaciones-afiliado"
+        ],
+        "summary": "Consulta de la perdona retirada.",
+        "description": "Obtener informacion de una persona retirada.",
+        "operationId": "retiroAfiliadoDep",
+        "parameters": [
+          {
+            "name": "tipoId",
+            "in": "query",
+            "description": "Tipo de documento de identificacion, ejemplo: CO1C.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "numId",
+            "in": "query",
+            "description": "Numero de documento.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Operación exitosa",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/retiroAfiliadoDepResponse"
+                }
+              }
+            }
+          },
+          "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"
+        }
+      },
+      "documento": {
+        "type": "object",
+        "properties": {
+          "tipo": {
+            "type": "string",
+            "description": "Tipo de documento de identificacion."
+          },
+          "numero": {
+            "type": "string",
+            "description": "Numero de documento de identificacion."
+          }
+        },
+        "xml": {
+          "name": "documento"
+        }
+      },
+      "nombre": {
+        "type": "object",
+        "properties": {
+          "primero": {
+            "type": "string",
+            "description": "Primer nombre."
+          },
+          "segundo": {
+            "type": "string",
+            "description": "Segundo nombre."
+          },
+          "primerApellido": {
+            "type": "string",
+            "description": "Primer apellido."
+          },
+          "segundoApellido": {
+            "type": "string",
+            "description": "Segundo apellido."
+          }
+        },
+        "xml": {
+          "name": "nombre"
+        }
+      },
+      "nacimiento": {
+        "type": "object",
+        "properties": {
+          "fecha": {
+            "type": "string",
+            "description": "Fecha de nacimiento."
+          }
+        },
+        "xml": {
+          "name": "nacimiento"
+        }
+      },
+      "genero": {
+        "type": "object",
+        "properties": {
+          "codigo": {
+            "type": "string",
+            "description": "Codigo del genero."
+          }
+        },
+        "xml": {
+          "name": "nacimiento"
+        }
+      },
+      "empleador": {
+        "type": "object",
+        "properties": {
+          "documento": {
+            "$ref": "#/components/schemas/documento"
+          },
+          "digitoVerificacion": {
+            "type": "string",
+            "description": "Digito de verificacion."
+          }
+        },
+        "xml": {
+          "name": "empleador"
+        }
+      },
+      "beneficiario": {
+        "type": "object",
+        "properties": {
+          "tipo": {
+            "type": "string",
+            "description": "Tipo de beneficiario. Valores posibles: conyugue, hijo."
+          },
+          "documento": {
+            "$ref": "#/components/schemas/documento"
+          },
+          "nombre": {
+            "$ref": "#/components/schemas/nombre"
+          },
+          "nacimiento": {
+            "$ref": "#/components/schemas/nacimiento"
+          },
+          "genero": {
+            "$ref": "#/components/schemas/genero"
+          },
+          "estadoCivil": {
+            "type": "string",
+            "description": "Estado civil de conyugue."
+          },
+          "convivencia": {
+            "type": "string",
+            "description": "Convivencia."
+          },
+          "ocupacion": {
+            "type": "string",
+            "description": "Ocupacion de conyugue."
+          },
+          "parentesco": {
+            "type": "string",
+            "description": "Parentesco."
+          },
+          "subsidio": {
+            "type": "string",
+            "description": "Subsidio."
+          }
+        },
+        "xml": {
+          "name": "beneficiario"
+        }
+      },
+      "afiliado": {
+        "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"
+          },
+          "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."
+          },
+          "beneficiario": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/beneficiario"
+            }
+          }
+        },
+        "xml": {
+          "name": "afiliado"
+        }
+      },
+      "departamento": {
+        "type": "object",
+        "properties": {
+          "codigo": {
+            "type": "string",
+            "description": "Codigo del departamento."
+          }
+        },
+        "xml": {
+          "name": "departamento"
+        }
+      },
+      "ciudad": {
+        "type": "object",
+        "properties": {
+          "codigo": {
+            "type": "string",
+            "description": "Codigo de la ciudad."
+          }
+        },
+        "xml": {
+          "name": "ciudad"
+        }
+      },
+      "direccion": {
+        "type": "object",
+        "properties": {
+          "departamento": {
+            "$ref": "#/components/schemas/departamento"
+          },
+          "ciudad": {
+            "$ref": "#/components/schemas/ciudad"
+          },
+          "direccionPrincipal": {
+            "type": "string",
+            "description": "direccion principal del afiliado."
+          }
+        },
+        "xml": {
+          "name": "direccion"
+        }
+      },
+      "obtenerAfiliadoDep": {
+        "type": "object",
+        "properties": {
+          "afiliado": {
+            "$ref": "#/components/schemas/afiliado"
+          }
+        },
+        "xml": {
+          "name": "obtenerAfiliado"
+        }
+      },
+      "obtenerAfiliadoResponse": {
+        "type": "object",
+        "required": [
+          "resultado"
+        ],
+        "properties": {
+          "resultado": {
+            "type": "array",
+            "xml": {
+              "name": "resultado"
+            },
+            "items": {
+              "$ref": "#/components/schemas/resultado"
+            }
+          },
+          "obtenerAfiliado": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/obtenerAfiliadoDep"
+            }
+          }
+        }
+      },
+      "natural": {
+        "type": "object",
+        "properties": {
+          "nombre": {
+            "$ref": "#/components/schemas/nombre"
+          }
+        },
+        "xml": {
+          "name": "natural"
+        }
+      },
+      "empleadorRetiro": {
+        "type": "object",
+        "properties": {
+          "natural": {
+            "$ref": "#/components/schemas/natural"
+          },
+          "documento": {
+            "$ref": "#/components/schemas/documento"
+          },
+          "digitoVerificacion": {
+            "type": "string",
+            "description": "Digito de verificacion."
+          },
+          "nombre": {
+            "type": "string",
+            "description": "Nombre de empresa."
+          }
+        },
+        "xml": {
+          "name": "empleadorRetiro"
+        }
+      },
+      "afiliadoRetiro": {
+        "type": "object",
+        "properties": {
+          "empleadorRetiro": {
+            "$ref": "#/components/schemas/empleadorRetiro"
+          },
+          "documento": {
+            "$ref": "#/components/schemas/documento"
+          },
+          "nombre": {
+            "$ref": "#/components/schemas/nombre"
+          },
+          "fechaRetiro": {
+            "type": "string",
+            "description": "Fecha de retiro de afiliado."
+          },
+          "motivoRetiro": {
+            "type": "string",
+            "description": "Motivo de retiro de afiliado."
+          }
+        },
+        "xml": {
+          "name": "afiliado"
+        }
+      },
+      "retiroAfiliadoDep": {
+        "type": "object",
+        "properties": {
+          "afiliado": {
+            "$ref": "#/components/schemas/afiliadoRetiro"
+          }
+        },
+        "xml": {
+          "name": "retiroAfiliadoDep"
+        }
+      },
+      "retiroAfiliadoDepResponse": {
+        "type": "object",
+        "required": [
+          "resultado"
+        ],
+        "properties": {
+          "resultado": {
+            "type": "array",
+            "xml": {
+              "name": "resultado"
+            },
+            "items": {
+              "$ref": "#/components/schemas/resultado"
+            }
+          },
+          "obtenerAfiliado": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/retiroAfiliadoDep"
+            }
+          }
+        }
+      }
+    },
+    "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