{ "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 del producto recreacion y turismo hoteles.", "version": "1.0.0", "title": "Recreacion y turismo hoteles", "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-recreacionyturismo-reservashoteles", "description": "Informacion de reserva de hoteles." } ], "paths": { "/v1/recreacionyturismo/reservashoteles/estado": { "put": { "tags": [ "cols-recreacionyturismo-reservashoteles" ], "summary": "Cambio de estado de reserva", "description": "Cambio de estado de reserva", "operationId": "cambiarEstadoReservaHotel.v1", , "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cambiarEstadoReservaHotelResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] , "requestBody": { "$ref": "#/components/requestBodies/cambioEstadoReservaBody" } } }, "/v1/recreacionyturismo/reservashoteles/partida": { "post": { "tags": [ "cols-recreacionyturismo-reservashoteles" ], "summary": "Consulta de reserva", "description": "Consulta de reserva", "operationId": "consultaReservaPartida.v1", , "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaReservaPartidaHotelResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] , "requestBody": { "$ref": "#/components/requestBodies/consultaPartidaBody" } } }, "/v1/recreacionyturismo/reservashoteles/recaudo": { "put": { "tags": [ "cols-recreacionyturismo-reservashoteles" ], "summary": "Realiza el recaudo de la reserva", "description": "Realiza el recaudo de la reserva", "operationId": "notificacionRecaudo.v1", , "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificacionReservaHotelResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] , "requestBody": { "$ref": "#/components/requestBodies/notificacionRecaudoBody" } } }, }, "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" } }, "documentoPartida" : { "type": "object", "properties": { "tipo" : { "type": "string", "description": "tipo identificacion" }, "numero" : { "type": "string", "description": "numero de identificacion" } } }, "documentoPartidaResponse" : { "type": "object", "properties": { "tipo" : { "type": "string", "description": "tipo identificacion" }, "numero" : { "type": "string", "description": "numero de identificacion" } } }, "nombrePartida" : { "type": "object", "properties": { "primero" : { "type": "string", "description": "nombres" }, "primerApellido" : { "type": "string", "description": "numero apellidos" }, "completo" : { "type": "string", "description": "nombre completo" } } }, "consultaPartidaRequest": { "type": "object", "properties": { "codigoSistemaLegado": { "type": "string", "description": "codigo de sistema legado", "required":true }, "tipoConsulta": { "type": "string", "description": "tipo Consulta", "required":true }, "recaudador": { "$ref": "#/components/schemas/recaudadorPartida" }, "numeroTarjetaMultiservicio": { "type": "string", "description": "numero de la tarjeta multiservicio" }, "documento":{ "$ref": "#/components/schemas/documentoPartida" }, "consultaReferencia":{ "$ref": "#/components/schemas/consultaPartida" } } }, "notificacionRecaudoRequest": { "type": "object", "properties": { "codigoSistemaLegado": { "type": "string", "description": "codigo de sistema legado", "required":true }, "recaudador": { "$ref": "#/components/schemas/recaudadorPartida" }, "obligacion": { "type": "array", "items": { "$ref": "#/components/schemas/obligacionNotificacionRequest" } }, "mediosPago": { "type": "array", "items": { "$ref": "#/components/schemas/medioPagoNotificacion" } } } }, "recaudadorPartida" : { "type": "object", "properties": { "codigo" : { "type": "string", "description": "codigo recaudador" }, "canal" : { "type": "string", "description": "canal recaudador" }, "numeroLocalizacion" : { "type": "string", "description": "numero de localizacion" }, "jornadaPago" : { "type": "string", "description": "jornada Pago" }, "numeroConvenio" :{ "type": "string", "description": "numero de convenio" }, "terminal" : { "type": "string", "description": "terminal" } } }, "elementosReferenciaPartida" : { "type": "object", "description":"
Posibles Id
primero: es el equivalente a Referencia Unica
segundo: es el equivalente a Referencia2
", "properties": { "id" : { "type": "string", "description": "identificacion" }, "valor" : { "type": "string", "description": "valor" } } }, "elementosReferenciaNotificacion" : { "type": "object", "description":"
Posibles Id
primero: es el equivalente a Referencia Unica
segundo: es el equivalente a Referencia2
", "properties": { "id" : { "type": "string", "description": "identificacion" }, "valor" : { "type": "string", "description": "valor" } } }, "elementosReferenciaNotificacionRecaudo" : { "type": "object", "description":"
Posibles Id
primero: es el equivalente a Valor Facturado
segundo: es el equivalente a Valor Recaudado
", "properties": { "id" : { "type": "string", "description": "identificacion" }, "valor" : { "type": "string", "description": "valor" } } } , "medioPagoNotificacion" : { "type": "object", "properties": { "codigo" : { "type": "string", "description": "codigo" }, "valor" : { "type": "string", "description": "valor" }, "referencia" : { "type": "string", "description": "referencia" } } }, "consultaPartida" : { "type": "object", "properties": { "referencia": { "type": "array", "items": { "$ref": "#/components/schemas/elementosReferenciaPartida" } }, "tipoMoneda": { "type": "string", "description": "tipo de moneda" }, "valorFactura": { "type": "string", "description": "valor de factura" }, "valorRecaudar": { "type": "string", "description": "valor a recaudar" }, "fechaVencimientoObligacion": { "type": "string", "format": "date-time", "description": "fecha de vencimiento de la obligacion" } } }, "Partida" : { "type": "object", "properties": { "documento":{ "$ref": "#/components/schemas/documentoPartidaResponse" }, "nombre": { "$ref": "#/components/schemas/nombrePartida" }, "obligacion": { "type": "array", "items": { "$ref": "#/components/schemas/obligacionPartidaResponse" } } } }, "cambiarEstadoReservaHotelResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "cambiarEstado": { "type": "array", "items": { "properties":{ "codigoConfirmacion": { "type": "string", "description": "codigo de confirmacion" } } } } } }, "obligacionPartidaResponse": { "type": "object", "properties": { "tipo": { "type": "string", "description": "tipo de obligacion" }, "referencia": { "type": "array", "items": { "$ref": "#/components/schemas/elementosReferenciaPartida" } }, "valorRecaudo": { "type": "array", "items": { "$ref": "#/components/schemas/elementosReferenciaPartida" } }, "concepto": { "type": "string", "description": "valor recaudo" }, "fechaVencimiento": { "type": "string", "format": "date-time", "description": "fecha de vencimiento" }, "estado": { "type": "string", "description": "estado" } } }, "obligacionNotificacionRequest": { "type": "object", "properties": { "tipo": { "type": "string", "description": "tipo de obligacion" }, "referencia": { "type": "array", "items": { "$ref": "#/components/schemas/elementosReferenciaNotificacion" } }, "valorRecaudo": { "type": "array", "items": { "$ref": "#/components/schemas/elementosReferenciaNotificacionRecaudo" } }, "tipoCanje": { "type": "string", "description": "tipo de canje" }, "fechaVencimiento": { "type": "string", "format": "date-time", "description": "fecha de vencimiento" }, "tipoMoneda": { "type": "string", "description": "tipo de moneda" }, "tipoPago": { "type": "string", "description": "tipo de pago" } } }, "consultaReservaPartidaHotelResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaPartida": { "type": "array", "items": { "properties":{ "partida": { "$ref": "#/components/schemas/Partida" } } } } } }, "notificacionReservaHotelResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaPartida": { "type": "array", "items": { "properties":{ "codigoConfirmacion":{ "type": "string", "description": "codigo del hotel" } } } } } }, "cambioEstadoReservaRequest": { "type": "object", "properties": { "codigoCadena": { "type": "string", "description": "codigo de la cadena hotelera" }, "codigoHotel": { "type": "string", "description": "codigo del hotel" }, "numeroReserva": { "type": "string", "description": "codigo de reserva" }, "tipoGarantia": { "type": "string", "description": "tipo de garantia establecida para la reserva" } } } }, "requestBodies": { "cambioEstadoReservaBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cambioEstadoReservaRequest" } } }, "description": "Informacion para registrar clientes", "required": true }, "consultaPartidaBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaPartidaRequest" } } }, "description": "Informacion para consultar reservas", "required": true }, "notificacionRecaudoBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificacionRecaudoRequest" } } }, "description": "Informacion para actualizar recaudos de reservas", "required": true } }, "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" } } } } } } }