{ "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 vivienda.", "version": "1.0.0", "title": "Vivienda subsidio", "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-vivienda-subsidio", "description": "Consulta de subsidio." } ], "paths": { "/v2/vivienda/subsidios": { "get": { "tags": [ "cols-vivienda-subsidio" ], "summary": "Consulta de certificado.", "description": "Obtener certificado de subsidio familiar.", "operationId": "obtenerSubFamiliar", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tpo de identificacion.", "required": true, "schema": { "type": "string" } }, { "name": "numId", "in": "query", "description": "Numero de identificacion.", "required": true, "schema": { "type": "string" } }, { "name": "cartaId", "in": "query", "description": "Id de carta.", "required": false, "schema": { "type": "string" } }, { "name": "canal", "in": "query", "description": "Canal.", "required": true, "schema": { "type": "string" } }, { "name": "periodo", "in": "query", "description": "Periodo.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenersubFamiliarResponse" } } } }, "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" } }, "subsidioFamiliar": { "type": "object", "properties": { "certificado": { "type": "string", "description": "Certificado de subsidio familiar." } }, "xml": { "name": "subsidioFamiliar" } }, "obtenerSubFamiliar": { "type": "object", "properties": { "subsidioFamiliar": { "$ref": "#/components/schemas/subsidioFamiliar" } }, "xml": { "name": "subsidioFamiliar" } }, "obtenersubFamiliarResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerCertificado": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerSubFamiliar" } } } } }, "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" } } } } } } }