{ "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 afiliados.", "version": "1.0.0", "title": "Recreacion y turismo afiliados", "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-afiliados", "description": "Informacion de afiliados." }, { "name": "cols-recreacionyturismo-gestionclientes", "description": "Servicios para el manejo de clientes y sus membresías" } ], "paths": { "/api/v1/recreacionyturismo/hoteles/gestionclientes/membresias":{ "put": { "tags": [ "cols-recreacionyturismo-gestionclientes" ], "summary": "Actualiza el estado de una membresía", "description": "Dado un número de cliente le actualiza el estaedo de su membresia", "operationId": "actualizarMembresia.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/actualizarMembresiaResponse" } } } }, "400": { "description": "Solicitud inválida" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/actualizarMembresiaRequestBody" } } }, "/v1/recreacionyturismo/hoteles/gestionclientes/membresias": { "get": { "tags": [ "cols-recreacionyturismo-gestionclientes" ], "summary": "Consultar las membresias teniendo en cuenta un id de cliente", "description": "Función para consultar las membresias", "operationId": "consultarMembresiasCliente.v1", "parameters": [ { "name": "numeroCliente", "in": "query", "required": true, "description": "Numero de identificacion del cliente.", "schema": { "type": "number", } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerMembresiasClienteResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/clientes": { "post": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Capacidad para inscribir una persona", "description": "Realiza la inscripción de una persona en el sistema con la información enviada", "operationId": "registrarDatosCliente.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registrarDatosClienteResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/registrarDatosClienteRequestBody" } }, "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Capacidad para consultar la inscripción de una persona", "description": "Según el documento ingresado, se busca la inscripción de una persona en el evento base.", "operationId": "consultaDatosCliente.v1", "parameters": [ { "name": "tipoId", "in": "query", "required": false, "description": "Tipo de documento de la persona que va a consultar.", "schema": { "$ref": "#/components/schemas/TipoDocumento" } }, { "name": "numId", "in": "query", "required": true, "description": "Documento de la persona que va a consultar.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarDatosClienteResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/afiliacion": { "post": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Inscribir afiliacion", "description": "Según el id se puede inscribir a una afiliación", "operationId": "inscribirMembresia.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inscribirMembresiaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/inscribirMembresiaRequestBody" } } }, "/v1/recreacionyturismo/afiliados/disponibilidad": { "post": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consultar disponibilidad de la practica libre", "description": "Consultar disponibilidad de la practica libre", "operationId": "disponibilidadPracticaLibre.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/disponibilidadPracticaLibreResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/disponibilidadPracticaLibreRequestBody" } } }, "/v1/recreacionyturismo/afiliados/reserva": { "post": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Inscripción de la persona al turno practica libre", "description": "Capacidad que permite la inscripción de una persona a un turno de practica libre, y lo asocia a una cotización.", "operationId": "reservarTurnoPracticaLibre.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reservarTurnoPracticaLibreResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/reservarTurnoPracticaLibreRequestBody" } }, "delete": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Borra un turno de práctica libre asociado a una persona.", "description": "Borra el turno completo desasociando todas las personas incluídas en él. NOTA: El turno tuvo que ser reservado por Tiquetera para ser cancelable.", "operationId": "cancelarReservaPracticaLibre.v1", "parameters": [ { "name": "numId", "in": "query", "description": "Numero de identificacion de la persona que reservo", "required": true, "schema": { "type": "string" } }, { "name": "idTurno", "in": "query", "description": "Numero de identificacion del turno ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelarReservaPracticaLibreResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] }, "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consultar la agenda de una persona y su grupo familiar", "description": "Función para buscar las actividades (Competencias en torneos, clases de escuelas, turnos de practica libre o citas médicas) que tenga entre un par de fechas seleccionadas según el documento del titular de la cuenta. Esta función también devolverá la agenda del grupo familiar de la persona buscada.", "operationId": "consultarReserva.v1", "parameters": [ { "name": "tipoId", "in": "query", "required": false, "description": "Tipo de documento de la persona que va a consultar la agenda", "schema": { "$ref": "#/components/schemas/TipoDocumento" } }, { "name": "numId", "in": "query", "required": true, "description": "Documento de la persona que va a consultar la agenda", "schema": { "type": "string" } }, { "name": "fechaInicio", "in": "query", "required": true, "description": "Fecha de inicio en la cual se quiere consultar la agenda.", "schema": { "type": "string", "format": "date-time", "example": "2018-07-21T08:00:00" } }, { "name": "fechaFin", "in": "query", "required": true, "description": "Fecha de fin en la cual se quiere consultar la agenda.", "schema": { "type": "string", "format": "date-time", "example": "2018-11-28T08:00:00" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarReservaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/pago/reserva": { "post": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Pagar reserva", "description": "Pagar reserva", "operationId": "pagarReserva.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagarReservaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/pagarReservaRequestBody" } } }, "/v1/recreacionyturismo/afiliados/cargo/reserva": { "put": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Cargo de reserva", "description": "Cargo de reserva", "operationId": "cargoReserva.v1", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cargoReservaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/cargoReservaRequestBody" } } }, "/v1/recreacionyturismo/afiliados/turno/persona": { "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consulta los turnos reservados por una persona", "description": "Consulta los turnos reservados por una persona", "operationId": "consultaTurnoPersona.v1", "parameters": [ { "name": "numId", "in": "query", "required": true, "description": "Numero de documento de identificacion de la persona que se consulta el turno.", "schema": { "type": "string", } }, { "name": "cancelable", "in": "query", "required": true, "description": "cancelable.", "schema": { "type": "boolean", } }, { "name": "activo", "in": "query", "required": true, "description": "Activo.", "schema": { "type": "boolean", } }, { "name": "fechaInicio", "in": "query", "required": false, "description": "Fecha de inicio la cual se quiere consultar.", "schema": { "type": "string", "format": "date-time", "example": "2018-07-21T08:00:00" } }, { "name": "fechaFin", "in": "query", "required": false, "description": "Fecha de fin la cual se quiere consultar.", "schema": { "type": "string", "format": "date-time", "example": "2018-07-21T08:00:00" } }, { "name": "idCentroEntrenamiento", "in": "query", "required": false, "description": "Numero de identificacion del centro de entrenamiento.", "schema": { "type": "integer", } }, ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaTurnoPersonaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/suscripciones": { "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consultar las suscripciones de una persona", "description": "Función para consultar las suscripciones vigentes o históricas de los planes de afiliación", "operationId": "consultaSuscripcionPersona.v1", "parameters": [ { "name": "numId", "in": "query", "required": true, "description": "Numero de documento de identificacion de la persona que se consulta la suscripcion.", "schema": { "type": "string", } }, { "name": "tipoId", "in": "query", "required": false, "description": "tipo de identificacion de la persona que se consulta la suscripcion.", "schema": { "$ref": "#/components/schemas/TipoDocumento" } }, { "name": "vencido", "in": "query", "required": false, "description": "Incluir suscripciones vencidas.", "schema": { "type": "boolean", } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaSuscripcionPersonaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/reserva/referencia": { "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consultar las reservas de los hoteles teniendo en cuenta un id de referencia", "description": "Función para consultar las reservas", "operationId": "consultarReservaporReferencia.v1", "parameters": [ { "name": "numeroReferencia", "in": "query", "required": true, "description": "Numero de documento de identificacion de la reserva.", "schema": { "type": "string", } }, { "name": "tipoReferencia", "in": "query", "required": false, "description": "tipo de referencia.", "schema": { "type": "string", } }, { "name": "estadoReserva", "in": "query", "required": false, "description": "estado de la reserva.", "schema": { "type": "string", } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerReservaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/recreacionyturismo/afiliados/reserva/documento": { "get": { "tags": [ "cols-recreacionyturismo-afiliados" ], "summary": "Consultar las reservas de los hoteles teniendo en cuenta un id de referencia", "description": "Función para consultar las reservas", "operationId": "consultarReservaPorDocumento.v1", "parameters": [ { "name": "numeroDocumento", "in": "query", "required": true, "description": "Numero de documento de identificacion.", "schema": { "type": "string", } }, { "name": "codigoCategoria", "in": "query", "required": true, "description": "codigo de categoria.", "schema": { "type": "string", } }, { "name": "estadoReserva", "in": "query", "required": false, "description": "estado de la reserva.", "schema": { "type": "string", } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerReservaDocResponse" } } } }, "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" } }, "consultarReserva": { "type": "object", "properties": { "reserva": { "type": "array", "items": { "$ref": "#/components/schemas/informacionReserva" } } } }, "informacionReserva":{ "type": "object", "description": "informacion de la reserva", "properties": { "estado": { "type": "string", "description": "estado de la reserva CHANGED " }, "id":{ "type": "string", "description": "identificador de la reserva " }, "canal":{ "type": "string", "description": "identificador de la reserva " }, "tarifa":{ "$ref": "#/components/schemas/informacionTarifa" }, "fechaAnticipo":{ "type": "string", "description": "Descripcion de la fecha de anticipo formato" }, "adultos":{ "type": "string", "description": "cantidad de adultos" }, "ninhos":{ "type": "string", "description": "cantidad de ninhos" }, "fechaInicio":{ "type": "string", "description": "Fecha de Inicio de la Reserva 2018-09-20T00:00:00.000Z" }, "fechaFin":{ "type": "string", "description": "Fecha de Fin de la Reserva 2018-09-20T00:00:00.000Z" }, "hotel":{ "$ref": "#/components/schemas/informacionHotel" }, "costo":{ "type":"number", "description":"Costo Total de la Reserva" }, "saldo":{ "type":"number", "description":"Saldo Pago de Cargos de la Reserva" }, "deposito":{ "type": "string", "description": "valor del deposito requerido" }, "titular":{ "$ref": "#/components/schemas/informacionTitular" } } }, "informacionTitular":{ "type": "object", "description": "informacion del titular de la reserva", "properties": { "id":{ "type": "string", "description": "id del titular" }, "nombre":{ "$ref": "#/components/schemas/nombre" }, "direccion":{ "$ref": "#/components/schemas/direccionTitular" }, "tipoMembresia":{ "type": "string", "description": "nombre de la membresia" }, "numero":{ "type": "number", "description": "numero de la membresia" } } }, "informacionHotel":{ "type": "object", "description": "informacion del hotel", "properties": { "codigo":{ "type": "string", "description": "codigo del hotel" }, "nombre":{ "type": "string", "description": "nombre del hotel" }, "habitaciones":{ "$ref": "#/components/schemas/habitaciones" } } }, "direccionTitular":{ "type": "object", "properties": { "tipo":{ "type":"string", "description":"tipo de direccion" }, "ciudad":{ "type":"number", "description":"ciudad" }, "estado":{ "type":"number", "description":"estado" }, "codigoPais":{ "type":"string", "description":"codigo de pais" } } }, "habitaciones":{ "type":"array", "items":{ "$ref":"#/components/schemas/habitacion" } }, "habitacion":{ "type":"object", "description":"informacion de la informacion", "properties":{ "tipo":{ "type":"string", "description":"tipo de habitacion" }, "descripcion":{ "type":"string", "description":"descripcion de la habitacion" }, "tarifa":{ "$ref":"#/components/schemas/tarifa" } } }, "tarifa":{ "type":"object", "description":"informacion de la informacion", "properties":{ "tipo":{ "type":"string", "description":"tipo de tarifa" }, "valor":{ "type":"string", "description":"Valor Tarifa de la habitacion" } } }, "informacionTarifa":{ "type":"object", "properties":{ "valor":{ "type": "string", "description": "Codigo Tarifa del Plan " }, "descripcion":{ "type": "string", "description": "Descripcion de la Tarifa " }, } }, "consultarReservaDocumento": { "type": "object", "properties": { "reserva": { "type": "array", "items": { "$ref": "#/components/schemas/informacionReservaDocumento" } } } }, "informacionReservaDocumento":{ "type": "object", "description": "informacion de la reserva", "properties": { "estado": { "type": "string", "description": "estado de la reserva CHANGED " }, "id":{ "type": "string", "description": "identificador de la reserva " }, "canal":{ "type": "string", "description": "identificador de la reserva " }, "tarifa":{ "$ref": "#/components/schemas/informacionTarifaDocumento" }, "fechaAnticipo":{ "type": "string", "description": "Descripcion de la fecha de anticipo formato" }, "adultos":{ "type": "string", "description": "cantidad de adultos" }, "ninhos":{ "type": "string", "description": "cantidad de ninhos" }, "fechaInicio":{ "type": "string", "description": "Fecha de Inicio de la Reserva 2018-09-20T00:00:00.000Z" }, "fechaFin":{ "type": "string", "description": "Fecha de Fin de la Reserva 2018-09-20T00:00:00.000Z" }, "hotel":{ "$ref": "#/components/schemas/informacionHotelDocumento" }, "costo":{ "type":"number", "description":"Costo Total de la Reserva" }, "saldo":{ "type":"number", "description":"Saldo Pago de Cargos de la Reserva" }, "deposito":{ "$ref":"#/components/schemas/deposito" }, "titular":{ "$ref": "#/components/schemas/informacionTitularDocumento" } } }, "informacionHotelDocumento":{ "type": "object", "description": "informacion del hotel", "properties": { "codigo":{ "type": "string", "description": "codigo del hotel" }, "nombre":{ "type": "string", "description": "nombre del hotel" }, "habitaciones":{ "$ref": "#/components/schemas/habitacionesDocumento" } } }, "habitacionesDocumento":{ "type":"array", "items":{ "$ref":"#/components/schemas/habitacionDocumento" } }, "habitacionDocumento":{ "type":"object", "description":"informacion de la informacion", "properties":{ "tipo":{ "type":"string", "description":"tipo de habitacion" }, "descripcionTipo":{ "type":"string", "description":"descripcion del tipo habitacion" }, "descripcion":{ "type":"string", "description":"descripcion de la habitacion" }, "textoDescripcion":{ "type":"string", "description":"descripcion mas detallada sobre la habitacion" }, "cantidad":{ "type":"number", "description":"cantidad de habitaciones" }, "tarifa":{ "$ref":"#/components/schemas/tarifaDocumento" } } }, "tarifaDocumento":{ "type":"object", "description":"informacion de la informacion", "properties":{ "tipo":{ "type":"string", "description":"tipo de tarifa" }, "valor":{ "type":"string", "description":"valor Tarifa de la habitacion" }, "fechaEfectiva":{ "type":"string", "description":"fecha apartir de la cual es efectiva la Tarifa" } } }, "informacionTarifaDocumento":{ "type":"object", "properties":{ "valor":{ "type": "string", "description": "Codigo Tarifa del Plan " }, "descripcion":{ "type": "string", "description": "Descripcion de la Tarifa " } } }, "deposito":{ "type":"object", "properties":{ "valor":{ "type": "number", "description": "valor del deposito " }, "modena":{ "type": "string", "description": "codigo de moneda" }, "fechaRequerido":{ "type": "string", "description": "fecha deposito requerido" } } }, "informacionTitularDocumento":{ "type": "object", "description": "informacion del titular de la reserva", "properties": { "id":{ "type": "string", "description": "id del titular" }, "nombre":{ "$ref": "#/components/schemas/nombre" },"profesion":{ "type": "string", "description": "profesion" },"fechaNacimiento":{ "type": "string", "description": "Fecha de nacimiento" }, "direccion":{ "$ref": "#/components/schemas/direccionTitularDocumento" }, "tipoMembresia":{ "type": "string", "description": "nombre de la membresia" }, "numero":{ "type": "number", "description": "numero de la membresia" } } }, "direccionTitularDocumento":{ "type": "object", "properties": { "tipo":{ "type":"string", "description":"tipo de direccion" }, "linea":{ "type":"string", "description":"linea de direccion" }, "ciudad":{ "type":"number", "description":"ciudad" }, "estado":{ "type":"number", "description":"estado" }, "codigoPais":{ "type":"string", "description":"codigo de pais" }, "codigoPostal":{ "type":"string", "description":"codigo Postal " } } }, "mensaje":{ "type": "object", "properties":{ "canal": { "type": "string", "description": "canal" }, "identificadorProceso": { "type": "string", "description": "Identificador de Proceso" }, "identificadorSesion": { "type": "string", "description": "Identificador de Session" }, "host": { "type": "string", "description": "host" }, "nombreOperacion": { "type": "string", "description": "Nombre de la operacion" }, "origenCliente": { "type": "string", "description": "Origen del Cliente" }, "usuario": { "type": "string", "description": "Usuario que realiza la operacion" }, "version": { "type": "string", "description": "Version" } } }, "resultadoCotizacion": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Estado de la cotización. Posibles Valores\n - 1) PAGO PENDIENTE > No ha sido pagada *nueva*\n - 2) PAGO REALIZADO > Ya ha sido pagada *facturada*\n - 3) RECHAZADA > El pago no ha sido exitoso *cancelada*\n - 4) CHECKOUT > En espera del medio de pago *en proceso de pago*" }, "descripcion": { "type": "string", "description": "Mensaje de la cotización" } }, "xml": { "name": "resultado" } }, "consultaSuscripcionPersonaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerSuscrpcion": { "type": "array", "items": { "$ref": "#/components/schemas/consultaSuscrpcion" } } } }, "consultaSuscrpcion": { "type": "object", "properties": { "suscripcion": { "type": "array", "items": { "$ref": "#/components/schemas/suscripcion" } } } }, "suscripcion": { "type": "object", "properties": { "id": { "type": "string", "description": "Id plan de afiliacion." }, "nombre": { "type": "string", "description": "Nombre de la suscripcion." }, "principal": { "type": "string", "description": "Principal" }, "habilitado": { "type": "string", "description": "Habilitado." }, "pagoCredito": { "type": "string", "description": "Pago a credito." }, "aplazamientos": { "$ref": "#/components/schemas/aplazamientos" }, "prestador": { "$ref": "#/components/schemas/prestador" }, "afiliacion": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliacion" } } } }, "afiliacion": { "type": "object", "properties":{ "fechaInicio": { "type": "string", "description": "fecha de inicio." }, "fechaFin": { "type": "string", "description": "Fecha de fin." }, "estado": { "type": "string", "description": "Estado." }, "entradas": { "type": "string", "description": "Entradas." }, "principal": { "type": "string", "description": "Principal." }, "validarAfiliacion": { "type": "string", "description": "Validar afiliacion." }, "aplazamientos": { "$ref": "#/components/schemas/aplazamientos" }, "centroEntrenamiento": { "$ref": "#/components/schemas/centroEntrenamiento" }, "prestador": { "$ref": "#/components/schemas/prestador" }, } }, "centroEntrenamiento": { "type": "object", "properties":{ "id": { "type": "string", "description": "Numero de identificacion del centro de entrenamiento." }, "nombre": { "type": "string", "description": "Nombre del centro de entrenamiento." } } }, "prestador": { "type": "object", "properties":{ "disponible": { "type": "string", "description": "Principal" } } }, "aplazamientos": { "type": "object", "properties": { "dias": { "type": "string", "description": "Dias de aplazamiento." }, "cantidad": { "type": "string", "description": "Cantidad de aplazamiento." }, "duracion": { "type": "string", "description": "Duracion de aplazamiento." } } }, "cargoReservaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "pagarReservaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "cargoReservaRequest": { "type": "object", "properties": { "canal": { "type": "string", "description": "Canal" }, "hotel": { "$ref": "#/components/schemas/hotelCargo" }, "reserva": { "$ref": "#/components/schemas/reservaCargo" }, "recaudador": { "$ref": "#/components/schemas/recaudadorCargo" } } }, "recaudadorCargo": { "type": "object", "properties": { "nombre": { "type": "string", "description": "Codigo del recaudador." }, "terminal": { "type": "object", "properties":{ "id": { "type": "string", "description": "Numero de identificacion del terminal." } } } } }, "reservaCargo": { "type": "object", "properties": { "id": { "type": "string", "description": "Numero de confirmacion de la reserva." }, "cargo": { "$ref": "#/components/schemas/cargo" } } }, "cargo": { "type": "object", "properties": { "cuenta": { "type": "string", "description": "Cuenta de cargo." }, "articulo": { "type": "string", "description": "Articulo del cargo." }, "descripcion": { "type": "string", "description": "Descripcion del cargo." }, "descripcionDetallada": { "type": "string", "description": "Descripcion detallada del cargo." }, "fecha": { "type": "string", "format": "date-time", "description": "Fecha del cargo." }, "total": { "type": "object", "properties": { "valor": { "type": "string", "description": "Valor total del cargo." } } } } }, "pagarReservaRequest": { "type": "object", "properties": { "fechaEjecucion": { "type": "string", "format": "date-time", "description": "Fecha de ejecucion" }, "canal": { "type": "string", "description": "Canal" }, "hotel": { "$ref": "#/components/schemas/hotel" }, "reserva": { "$ref": "#/components/schemas/reserva" }, "recaudador": { "$ref": "#/components/schemas/recaudador" } } }, "hotelCargo": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo de hotel." } } }, "recaudador": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo del recaudador." }, "canal": { "type": "string", "description": "Canal del recaudador." }, "ubicacion": { "type": "string", "description": "Ubicacion del recaudador." }, "jornada": { "type": "string", "description": "Jornada de pago." }, "convenio": { "type": "object", "properties":{ "codigo": { "type": "string", "description": "Codigo del convenio." } } }, "terminal": { "type": "object", "properties":{ "id": { "type": "string", "description": "Numero de identificacion del terminal." } } } } }, "pagoReserva": { "type": "object", "properties": { "fecha": { "type": "string", "format": "date-time", "description": "Fecha del recaudo." }, "total": { "type": "object", "properties": { "valor": { "type": "string", "description": "Valor total del recaudo.." } } }, "medio": { "type": "array", "items":{ "properties": { "id": { "type": "string", "description": "Referencia del medio de pago." }, "codigo": { "type": "string", "description": "Codigo del medio de pago." }, "valor": { "type": "string", "description": "Valor del medio de pago." } } } }, } }, "reserva": { "type": "object", "properties": { "id": { "type": "string", "description": "Numero de confirmacion de la reserva." }, "pago": { "$ref": "#/components/schemas/pagoReserva" } } }, "hotel": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo de hotel." }, "cadena": { "type": "string", "description": "Cadena de hotel." } } }, "consultaTurnoPersonaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaTurnoPersona": { "type": "array", "items":{ "$ref": "#/components/schemas/consultaTurnoPersona" } } } }, "consultaTurnoPersona": { "type": "object", "properties": { "turno": { "$ref": "#/components/schemas/turnoReservaPracticaLibre" } } }, "consultarReservaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerReserva": { "type": "array", "items":{ "$ref": "#/components/schemas/obtenerReserva" } } } }, "obtenerReserva": { "type": "object", "properties": { "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio del servicio" }, "fechaFin": { "type": "string", "format": "date-time", "description": "Fecha de fin del servicio" }, "asistencia": { "type": "string", "description": "asistencia" }, "sede": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre de sede" }, } }, "zona": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre de zona" }, "nombreEscenario": { "type": "string", "description": "Nombre de escenario" }, } }, "cliente": { "$ref": "#/components/schemas/cliente" }, "servicio": { "$ref": "#/components/schemas/servicio" } } }, "TipoDocumento": { "description": "Enumeración de tipos de documento soportados", "type": "string", "enum": [ "CC", "CE", "NIT", "TI", "PAS", "FN", "RC", "NUIP", "MSI", "CD", "PEP" ] }, "cancelarReservaPracticaLibreResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "disponibilidadPracticaLibreResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerDisponibilidad": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerDisponibilidad" } } } }, "obtenerDisponibilidad": { "type": "object", "properties": { "turno": { "$ref": "#/components/schemas/turnoPracticaLibre" } } }, "horario":{ "type": "object", "properties":{ "fechaInicio": { "type": "string", "description": "Fecha inicio 2018-10-19T00:00:00.000Z" }, "fechaFin": { "type": "string", "description": "Fecha final 2018-10-19T00:00:00.000Z" } } }, "reservaPracticaLibre": { "type": "object", "properties": { "id":{ "type": "number", "description":"" }, "horario": { "$ref": "#/components/schemas/horario" }, "tiquetera":{ "type": "string", "description":"" }, "cantidadUsos":{ "type": "number", "description":"" }, "cancelable":{ "type": "boolean", "description":"" } } }, "turnoPracticaLibre": { "type": "object", "properties": { "practicaLibre": { "type": "object", "properties": { "fechaInicio": { "type": "string", "description": "Fecha de inicio" }, "fechaFin": { "type": "string", "description": "Fecha de fin" }, "cantidadUsos": { "type": "string", "description": "Número de usos que require el turno" }, "participantes": { "type": "string", "description": "Número de personas máximas acompañantes para el turno" }, "cupos": { "type": "string", "description": "Cupos disponibles en el horario" }, "duracion": { "type": "string", "description": "Cantidad de minutos del turno" }, "zona": { "type": "array", "items": { "properties":{ "id": { "type": "string", "description": "Identificador de la zona" }, "nombre": { "type": "string", "description": "Nombre de la zona" }, "idEscenario": { "type": "string", "description": "Nombre del material" }, "nombreEscenario": { "type": "string", "description": "Identificador del escenario al que pertenece la zona" } } } } } } } }, "disponibilidadPracticaLibreRequest": { "type": "object", "properties": { "idCentroEntrenamiento": { "type": "string", "description": "Id del centro de entrenamiento" }, "disponibilidad": { "type": "object", "description": "Objeto que representa una búsqueda de disponibilidad en un rango de fechas para práctica libre.", "properties":{ "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio de búsqueda de la disponibilidad. Sujeto al mínimo del centro de entrenamiento con relación a la fecha actual." }, "fechaFin": { "type": "string", "format": "date-time", "description": "Fecha límite a la cual se le busca disponibilidad. Sujeto al maximo del centro de entrenamiento con relación a la fecha actual." }, "inmediato": { "type": "string", "description": "Indicador para buscar turnos que inicien en los próximos 5, 10 o 15 minutos" } } }, "turno": { "$ref": "#/components/schemas/turnoReservaPracticaLibreDisponibilidad" } } }, "reservarTurnoPracticaLibreResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultadoCotizacion" } }, "reservaPracticaLibre": { "type": "array", "items": { "$ref": "#/components/schemas/reservaPracticaLibre" } } } }, "reservarTurnoPracticaLibreRequest": { "type": "object", "properties": { "idCotizacion": { "type": "string", "description": "Id de cotizacion" }, "idCentroEntrenamiento": { "type": "string", "description": "Id del centro de entrenamiento" }, "turno": { "$ref": "#/components/schemas/turnoReservaPracticaLibre" } } }, "obtenerReservaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultarReserva": { "type": "array", "items": { "$ref": "#/components/schemas/consultarReserva" } } } }, "obtenerReservaDocResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultarReserva": { "type": "array", "items": { "$ref": "#/components/schemas/consultarReservaDocumento" } } } }, "turnoReservaPracticaLibreDisponibilidad": { "type": "object", "properties": { "practicaLibre": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador del turno de la practica libre" }, "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio" }, "fechaFin": { "type": "string", "format": "date-time", "description": "Fecha de fin" }, "tiquetera": { "type": "string", "description": "Parametro que informa si la practica libre se reserva a través de una tiquetera" }, "cantidadUsos": { "type": "string", "description": "Número de la cantidad de usos que se desean reservar" }, "cancelable": { "type": "string", "description": "Parametro que describe si el turno de practica libre es aún cancelable" }, "informacionPersonal": { "type": "object", "properties":{ "id": { "type": "string", "description": "Id de la persona" }, "edad": { "type": "string", "description": "Edad de la persona" }, "correoElectronico": { "type": "string", "description": "Correo electronico de la persona" }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "genero": { "$ref": "#/components/schemas/genero" }, "categoria": { "$ref": "#/components/schemas/categoria" } } }, "material": { "type": "array", "items": { "properties":{ "id": { "type": "string", "description": "Identificador o id del material" }, "tipo": { "type": "string", "description": "Tipo del material:\n * 1) Referencia\n * 2) Transporte\n * 3) Turno\n * 4) Articulo" }, "descripcion": { "type": "string", "description": "Nombre del material" } } } }, "zona": { "type": "array", "items": { "properties":{ "id": { "type": "string", "description": "Identificador de la zona" }, "nombre": { "type": "string", "description": "Nombre de la zona" }, "idEscenario": { "type": "string", "description": "Nombre del material" }, "nombreEscenario": { "type": "string", "description": "Identificador del escenario al que pertenece la zona" } } } }, } } } }, "turnoReservaPracticaLibre": { "type": "object", "properties": { "practicaLibre": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Identificador del turno de la practica libre" }, "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio" }, "fechaFin": { "type": "string", "format": "date-time", "description": "Fecha de fin" }, "tiquetera": { "type": "string", "description": "Parametro que informa si la practica libre se reserva a través de una tiquetera" }, "cantidadUsos": { "type": "string", "description": "Número de la cantidad de usos que se desean reservar" }, "cancelable": { "type": "string", "description": "Parametro que describe si el turno de practica libre es aún cancelable" }, "informacionPersonal": { "type": "object", "properties":{ "id": { "type": "string", "description": "Id de la persona" }, "edad": { "type": "string", "description": "Edad de la persona" }, "correoElectronico": { "type": "string", "description": "Correo electronico de la persona" }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "genero": { "$ref": "#/components/schemas/genero" }, "categoria": { "$ref": "#/components/schemas/categoria" } } }, "material": { "type": "array", "items": { "properties":{ "id": { "type": "string", "description": "Identificador o id del material" }, "tipo": { "type": "string", "description": "Tipo del material:\n * 1) Referencia\n * 2) Transporte\n * 3) Turno\n * 4) Articulo" }, "descripcion": { "type": "string", "description": "Nombre del material" } } } }, "zona": { "type": "array", "items": { "properties":{ "id": { "type": "string", "description": "Identificador de la zona" }, "nombre": { "type": "string", "description": "Nombre de la zona" }, "idEscenario": { "type": "string", "description": "Nombre del material" }, "nombreEscenario": { "type": "string", "description": "Identificador del escenario al que pertenece la zona" } } } }, } } }, } }, "inscribirMembresiaRequest": { "type": "object", "properties": { "idCentroEntrenamiento": { "type": "string", "description": "Id de centro de entrenamiento", }, "idCotizacion": { "type": "string", "description": "Id de cotizacion" }, "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio" }, "servicio": { "$ref": "#/components/schemas/servicio" }, "cliente": { "$ref": "#/components/schemas/cliente" } } }, "inscribirMembresiaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerCotizacion": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerCotizacion" } } } }, "registrarDatosClienteRequest": { "type": "object", "properties": { "cliente": { "$ref": "#/components/schemas/cliente" } } }, "actualizarMembresiaRequest": { "type": "object", "properties": { "membresia": { "$ref": "#/components/schemas/membresia" } } }, "consultarDatosClienteResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerCliente": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerCliente" } } } }, "registrarDatosClienteResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerCliente": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerCliente" } } } }, "actualizarMembresiaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "obtenerMembresiasClienteResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "membresiasCliente": { "type": "array", "items": { "$ref": "#/components/schemas/consultarMembresias" } } } }, "obtenerCliente": { "type": "object", "properties": { "fechaCreacion": { "type": "string", "format": "date-time", "description": "Fecha de creacion" }, "fechaActualizacion": { "type": "string", "format": "date-time", "description": "Fecha de actualizacion" }, "fechaSistema": { "type": "string", "format": "date-time", "description": "Fecha del sistema" }, "comentario": { "type": "string", "description": "Comentario" }, "regional": { "type": "string", "description": "Comentario regional" }, "request": { "type": "string", "description": "Request" }, "encontrado": { "type": "string", "description": "Encontrado" }, "cliente": { "$ref": "#/components/schemas/consultaCliente" }, "empresa": { "type": "array", "items":{ "$ref": "#/components/schemas/empresa" } } } }, "consultaCliente": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del cliente" }, "idDato ": { "type": "string", "description": "Id del dato" }, "idEvento": { "type": "string", "description": "Id del evento" }, "tipo": { "type": "string", "description": "Tipo" }, "fechaNacimiento": { "type": "string", "format": "date-time", "description": "Fecha de nacimiento cliente" }, "correoElectronico": { "type": "string", "description": "Correo electronico del cliente" }, "telefono": { "type": "string", "description": "Telefono del cliente" }, "carnet": { "type": "string", "description": "Carnet del cliente" }, "foto": { "type": "string", "description": "Foto del cliente" }, "estado": { "type": "string", "description": "Estado del cliente" }, "titular": { "type": "string", "description": "Titular" }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "genero": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Género de la persona: * 0) FEMENINO * 1) MASCULINO", "enum": [ 0, 1 ] }, "estado": { "type": "boolean", "description": "Estado del genero" }, } }, "categoria": { "$ref": "#/components/schemas/categoria" }, "direccion": { "type": "object", "properties": { "direccionPrincipal": { "type": "string", "description": "direccion principal" } } } } }, "empresa": { "type": "object", "properties": { "id": { "type": "string", "description": "Id de la empresa" }, "documento": { "type": "object", "properties": { "numero": { "type": "string", "description": "Numero de identificacion de la empresa" } } }, "nombre": { "type": "string", "description": "Numbre de la empresa" } } }, "documento": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de documento" }, "numero": { "type": "string", "description": "Número de identificación del documento" } }, "xml": { "name": "documento" } }, "genero": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Género de la persona: * 0) FEMENINO * 1) MASCULINO", "enum": [ 0, 1 ] }, } }, "categoria": { "type": "object", "properties": { "sigla": { "type": "string", "description": "Sigla de la categoria" } } }, "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" }, "completo": { "type": "string", "description": "Nombre completo" } }, "xml": { "name": "nombre" } }, "cliente": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del cliente" }, "fechaNacimiento": { "type": "string", "format": "date-time", "description": "Fecha de nacimiento del cliente" }, "correoElectronico": { "type": "string", "description": "Correo electronico del cliente" }, "telefono": { "type": "string", "description": "Telefono del cliente" }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "genero": { "$ref": "#/components/schemas/genero" }, "categoria": { "$ref": "#/components/schemas/categoria" } } }, "membresia": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador de la membresia" }, "estado": { "type": "string", "description": "
Tipos de estado
Id Descripción
ACTIVO Activa la membresía
INACTIVO Inactiva la membresía
" } } }, "consultarMembresias": { "type": "object", "properties": { "id": { "type": "string", "description":"Id de identificacion de la membresia." }, "tipo": { "type": "string", "description":"Tipo de la membresia." }, "estado": { "type": "string", "description":"Estado de la membresia." } } }, "consultaCotizacionIdResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultadoCotizacion" } }, "obtenerCotizacion": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerCotizacion" } } } }, "obtenerCotizacion": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/afiliado" }, "cotizacion": { "$ref": "#/components/schemas/cotizacion" }, "transaccion": { "$ref": "#/components/schemas/transaccion" }, "logs": { "type": "array", "items":{ "$ref": "#/components/schemas/logs" } } } }, "logs": { "type": "object", "description": "Cambio realizado en la cotización en un instante de tiempo", "properties": { "tipo": { "type": "string", "description": "Tipo de modificación que se realiza Tipo:\n * 1) CREACION\n * 2) ACTUALIZACION\n * 3) INFORMATIVO\n * 4) PRUEBAS" }, "descripcion": { "type": "string", "description": "Descripción del log" } } }, "transaccion": { "type": "object", "description": "Propiedades de la transacción de pago de una cotización", "properties": { "id": { "type": "string", "description": "El id de la transacción enviado por el sistema de pago." }, "fecha": { "type": "string", "format": "date-time", "description": "Fecha en la que se completó la transacción de pago" }, "canal": { "type": "string", "description": "Identificador del canal de pago - 1) Caja - 2) Módulos - 3) Web - 4) App - 5) IVR - 6) Interno", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "idCaja": { "type": "string", "description": "Identificador de la máquina que hizo el pago (Módulo, Caja). En caso de transacción en línea se usará algún identificador del proveedor de pago." }, "idCajero": { "type": "string", "description": "Identificador del cajero quien realiza la cotización en el sistema Hércules (Normalmente la cédula o código de máquina)" }, "pago": { "type": "object", "properties":{ "id": { "type": "string", "description": "Consecutivo generado por el medio de pago" }, "medio": { "type": "string", "description": "Código del medio de pago" }, "valor": { "type": "string", "description": "Valor pagado con este medio de pago" } } } } }, "cotizacion": { "type": "object", "description": "Información de una cotización. Las cotizaciones se componen de Ítems de Cotización que indican los servicios a adquirir. Los Ítems tiene diferntes tipos dependiendo del servicio que se adquirió. Además las Cotizaciones tienen un log de auditoría y una Transacción de pago asociada que incluye la forma de pago detallada", "properties": { "id": { "type": "string", "description": "Id de la cotización en Hércules" }, "factura": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador de la Cotización en el sistema facturador. ( Por ejemplo Número de Factura o de la Orden de Venta)" }, "idSecundario": { "type": "string", "description": "Identificador secundario de la Cotización en el sistema facturador. (Por ejemplo Número de Factura Empresarial)" } } }, "idParticipacionOrganizacion": { "type": "string", "description": "Id de la ParticipacionOrganizacion en Hércules de la cotización (uso interno)" }, "fechaCreacion": { "type": "string", "format": "date-time", "description": "Fecha de creación de la cotización" }, "fechaActualizacion": { "type": "string", "format": "date-time", "description": "Fecha de actualización de la cotización" }, "fechaExpiracion": { "type": "string", "format": "date-time", "description": "Fecha de expiración de la cotización" }, "usuario": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del usuario en Hércules que realiza la cotización (si se hace por servicio sería el client_id)" }, "nombre": { "type": "object", "properties":{ "completo": { "type": "string", "description": "Nombre del usuario que reqliza la cotización" }, } } } }, "empresa": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre de la organización o empresa" }, } }, "proveedor": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre del proveedor de pago de la cotización" }, } }, "costo": { "type": "object", "properties":{ "reversion": { "type": "string", "description": "Suma del total de las reversiones de cada ítem" }, "base": { "type": "string", "description": "Valor de la base del IVA en la cotización" }, "iva": { "type": "string", "description": "Valor total del IVA en la cotización" }, "total": { "type": "object", "properties":{ "valor": { "type": "string", "description": "Suma del total de cada ítem en la cotización. Total Pagado" }, } } } }, "articulo": { "type": "array", "items":{ "$ref": "#/components/schemas/articulo" } } } }, "articulo": { "type": "object", "description": "Hace referencia al servicio que se quiere inscribit, a la persona, y el valor de la inscripción al servicio ", "properties": { "id": { "type": "string", "description": "Numero de identificacion del articulo" }, "tipo": { "type": "string", "description": "Tipo del ítem (INSCRIPCION = 1, MATRICULA = 2, MATERIAL = 3, AFILIACION = 4, RESERVA_TURNO = 5, CITA = 6)", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "cantidad": { "type": "string", "description": "Cantidad del ítem adquirida" }, "descripcion": { "type": "string", "description": "Descripción del ítem" }, "centroBeneficio": { "type": "string", "description": "Código del centro de beneficios (Centro de Beneficios SAP)" }, "persona": { "type": "object", "properties":{ "nombre": { "type": "object", "properties":{ "completo": { "type": "string", "description": "Nombre de la persona asociada al ítem" } } }, "documento": { "type": "object", "properties":{ "numero": { "type": "string", "description": "NNúmero de documento de la persona asociada al ítem" } } }, } }, "categoria": { "type": "object", "properties":{ "sigla": { "type": "string", "description": "Nombre de la categoría de precio" } } }, "costo": { "type": "object", "properties": { "nombre": { "type": "string", "description": "Nombre del precio aplicado." }, "codigo": { "type": "string", "description": "Código del precio según la tabla de productos enviada. Id Material en SAP" }, "base": { "type": "string", "description": "Valor base del ítem sin impuesto." }, "impuesto": { "type": "string", "description": "Valor del impuesto aplicado sobre el valor" }, "total": { "type": "object", "properties":{ "valor": { "type": "string", "description": "Valor total de la suma del valor más el impuesto" } } } } }, "servicio": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre del titular que realizó la cotización" }, "costo": { "$ref": "#/components/schemas/costoServicioCotizacion" } } }, "descuento": { "type": "array", "description": "Lista de descuentos aplicados al ítem", "items":{ "$ref": "#/components/schemas/descuento" } } } }, "descuento": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador del descuento" }, "tipo": { "type": "string", "description": "Parametro para saber el tipo del descuento.\nLos tipos son los siguientes:\n - 0) CONVENIO: Los convenios son aquellos que no tienen recobro por subsidio a la demanda.\n - 1) DESCUENTO\n - 2) MERCADEO\n\nUn ítem de cotización puede tener a lo sumo tres descuentos, uno de cada tipo entre: convenio, no convenio y mercadeo.", "enum": [ 0, 1, 2 ], }, "codigo": { "type": "string", "description": "Código de descuento a aplicar (en caso de escritura) o aplicado (en caso de lectura), puede ser un código único o un código repetible (Cupón)" }, "nombre": { "type": "string", "description": "Nombre del descuento" }, "mercadeo": { "type": "string", "description": "Parámetro que indica que el precio fue modificado por un sistema externo con autorización para cambiar precios." }, "total": { "type": "object", "properties":{ "valor": { "type": "string", "description": "Valor final con el descuento aplicado al valor del ítem consultado." } } } } }, "costoServicioCotizacion": { "type": "object", "properties": { "base": { "type": "string", "description": "Valor de la base (Sin IVA) del precio" }, "iva": { "type": "string", "description": "Valor del IVA para el precio" }, "fechaInicioVigencia": { "type": "string", "format": "date-time", "description": "Fecha de inicio de la vigencia del precio" }, "fechaFinVigencia": { "type": "string", "format": "date-time", "description": "Fecha de fin de la vigencia del precio" }, "categoria": { "type": "object", "properties":{ "sigla": { "type": "string", "description": "Nombre de la categoría de precio" } } }, "total": { "type": "object", "properties":{ "valor": { "type": "string", "description": "Valor total (incluye IVA) del precio" } } } } }, "afiliado": { "type": "object", "properties": { "telefono": { "type": "string", "description": "Número de telefono del titular" }, "correoElectronico": { "type": "string", "description": "Correo electrónico del titular de la cotización" }, "nombre": { "type": "object", "properties": { "completo": { "type": "string", "description": "Nombre del titular que realizó la cotización" } } }, "documento": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de documento del titular de la cotización", "enum": [ "CC", "CE", "NIT", "TI", "PAS", "FN", "RC", "NUIP", "MSI", "CD", "PEP" ] }, "numero": { "type": "string", "description": "Número de documento de una persona" } } }, "direccion": { "type": "object", "properties": { "direccionPrincipal": { "type": "string", "description": "Dirección del titular" } } } } }, "consultaCatalogoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerServicios": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerServicios" } } } }, "obtenerServicios": { "type": "object", "properties": { "servicio": { "type": "array", "items":{ "$ref": "#/components/schemas/servicio" } }, "opcionesAplicadas": { "type": "array", "items":{ "$ref": "#/components/schemas/opcionesAplicadas" } } } }, "opcionesAplicadas": { "type": "object", "description": "Objeto que contiene la información de las opciones utilizadas para buscar los servicios. Los tipos de opción pueden ser los siguientes:\n * 1) Documento\n * 2) Antiguedad\n * 3) Clasificación\n * 4) Área (Deporte)\n * 5) Sede\n * 6) Días (Entre Semana / Fin de Semana)\n * 7) Horario (Mañana / Tarde / Noche)\n * 8) Nivel (Prueba)\n * 9) Servicio (Prueba Campeonato)\n * 10) Segmento (Edad)", "properties":{ "valor": { "type": "string", "description": "Valor para la opción seleccionada" }, "tipo": { "type": "string", "description": "Nombre del tipo de la opción" }, "opcion": { "type": "string", "description": "Nombre de la opción" }, "atributos": { "type": "object", "description": "Características adicionales de la opción" }, } }, "servicio": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del servicio" }, "idDetalle": { "type": "string", "description": "Id del detalle del servicio" }, "tipo": { "type": "string", "description": "Tipo de servicio que puede existir, los tipos pueden ser los siguientes:\n * 1 ) Escuela\n * 2 ) Practica Libre\n * 3 ) Plan Afiliación\n * 4 ) Cita\n * 5 ) Material" }, "nombre": { "type": "string", "description": "Nombre del servicio" }, "nombreAbreviado": { "type": "string", "description": "Nombre corto del servicio con un tamaño máximo de 25 caracteres" }, "tiempoFijo": { "type": "string", "description": "Indicador que muestra si los usos aumentan el tiempo o solo el valor (Servicio tipo 2)" }, "edadMinima": { "type": "string", "description": "Edad mínima con la cual se pueden registrar los participantes (Servicio tipo 2)" }, "edadMaxima": { "type": "string", "description": "Edad máxima con la cual se pueden registrar los participantes (Servicio tipo 2)" }, "numeroSesiones": { "type": "string", "description": "Número de sesiones del beneficio principal plan de afiliación (Servicio tipo 3)" }, "tiempo": { "type": "string", "description": "Tiempo de duración en días del beneficio principal del plan de afiliación (Servicio tipo 3) " }, "cupos": { "type": "string", "description": "Cantidad de cupos disponibles para el servicio" }, "pruebaTorneo": { "type": "string", "description": "Flag que indica si este servicio habilita pruebas para inscripción a torneo (Servicio tipo 1)." }, "descripcion": { "type": "string", "description": "Descripcion del servicio." }, "fechaInicio": { "type": "string", "format": "date-time", "description": "Fecha de inicio (Servicio tipo 1)." }, "fechaFin": { "type": "string", "format": "date-time", "description": "Fecha de fin (Servicio tipo 1)." }, "beneficios": { "type": "array", "description": "Lista del beneficio principal y secundarios del plan de afiliación (Servicio tipo 3).", "items":{ "type": "object", "properties":{ "id": { "type": "string", "description": "Id del beneficio" }, "numeroSesiones": { "type": "string", "description": "Cantidad de usos máximos del beneficio" }, "tiempo": { "type": "string", "description": "Tiempo en días de la vigencia del beneficio" }, "principal": { "type": "string", "description": "Indicador que muestra cuál es el beneficio principal del plan de afiliación" }, "area": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre del area" }, } }, "sede": { "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre de la sede" }, } }, "centroEntrenamiento": { "type": "object", "description": "Objeto que contiene toda la información del centro de entrenamiento", "properties":{ "id": { "type": "string", "description": "Id del centro de entrenamiento" }, "nombre": { "type": "string", "description": "Nombre del centro de entrenamiento" } } }, "prestador": { "type": "object", "properties":{ "disponible": { "type": "string", "description": "Parametro que describe si el plan de afiliación tiene médico (Servicio tipo 3)" } } }, } } }, "dias": { "type": "array", "description": "Se devolvera los dias que su valor sea 'true' (Servicio tipo 1-3), los posibles pueden ser los siguientes:\n * lunes\n * martes\n * miercoles\n * jueves\n * viernes\n * entreSemana\n * finSemana", "format": "string", "enum": [ lunes, martes, miercoles, jueves, viernes, entreSemana, finSemana ], "items":{ } }, "genero": { "type": "object", "properties":{ "descripcion": { "type": "string", "description": "Género que aplica al centro de entrnamiento (Servicio tipo 2)" } } }, "turno": { "type": "object", "properties":{ "grupal": { "type": "string", "description": "Indicador que muestra si el turno aplica para varias personas al tiempo (Servicio tipo 2)" }, "personas": { "type": "string", "description": "Cantidad de personas máximas por turno (Servicio tipo 2)" }, "inmediato": { "type": "string", "description": "Indicador que muestra si puede tener inicio inmediato el turno (dentro de los siguientes 5, 10 o 15 min) (Servicio tipo 2)" }, "intervalo": { "type": "string", "description": "Duración en minutos de cada cuanto se puede obtener turnos (Servicio tipo 2)" }, "duracion": { "type": "string", "description": "Duración en minutos del turno (Servicio tipo 2)" }, "reserva": { "type": "string", "description": "Requiere reservar todos los turnos al momento de comprar. Por ejemplo para un pasadía (Servicio tipo 3)" } } }, "prestador": { "type": "object", "properties":{ "disponible": { "type": "string", "description": "Parametro que describe si el plan de afiliación tiene médico" } } }, "centroEntrenamiento": { "type": "object", "description": "Objeto que contiene toda la información del centro de entrenamiento", "properties":{ "id": { "type": "string", "description": "Id del centro de entrenamiento (Servicio tipo 2-3-4)" }, "nombre": { "type": "string", "description": "Nombre del centro de entrenamiento (Servicio tipo 2-3-4) " } } }, "inscripcion": { "type": "object", "properties":{ "fechaInicioAntiguos": { "type": "string", "format": "date-time", "description": "Fecha inicio de inscripcion para antiguos (Servicio tipo 1)." }, "fechaFinAntiguos": { "type": "string", "format": "date-time", "description": "Fecha fin de inscripcion para antiguos (Servicio tipo 1)." }, "fechaInicioNuevos": { "type": "string", "format": "date-time", "description": "Fecha inicio de inscripcion para nuevos (Servicio tipo 1)." }, "fechaFinNuevos": { "type": "string", "format": "date-time", "description": "Fecha fin de inscripcion para nuevos (Servicio tipo 1)." }, } }, "area": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador del área asociada al servicio tipo escuela (Servicio tipo 1)" }, "nombre": { "type": "string", "description": "Nombre del área (Servicio tipo 1)" } } }, "nivel": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador del nivel asociado al servicio tipo escuela (Servicio tipo 1)" }, "nombre": { "type": "string", "description": "Nombre del nivel (Servicio tipo 1)" } } }, "categoria": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador de la categoria asociada a servicio tipo escuela (Servicio tipo 1)" }, "nombre": { "type": "string", "description": "Nombre de la categoría de edad (Servicio tipo 1)" } } }, "ciclo": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador del ciclo de inscripción del servicio (Servicio tipo 1)" }, "nombre": { "type": "string", "description": "Nombre del ciclo de inscripción (Servicio tipo 1)" } } }, "sede": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador de la sede del servicio de tipo escuela (Servicio tipo 1)" }, "nombre": { "type": "string", "description": "Nombre de la sede del servicio (Servicio tipo 1)" } } }, "material": { "type": "object", "properties":{ "id": { "type": "string", "description": "Identificador o id del material (Servicio tipo 5)" }, "tipo": { "type": "string", "description": "Tipo del material (Servicio tipo 5):\n * 1) Referencia\n * 2) Transporte\n * 3) Turno\n * 4) Articulo" }, "descripcion": { "type": "string", "description": "Nombre del material (Servicio tipo 5)" } } }, "atributo": { "type": "array", "items":{ "type": "object", "properties":{ "tipo": { "type": "string", "description": "Tipo de atributo en especifico, estos tipos de atributos se sacan de la lista enumerada en el objeto" }, "valor": { "type": "string", "description": "Valor de atributo" } } } }, "costo": { "type": "array", "items":{ "type": "object", "properties":{ "nombre": { "type": "string", "description": "Nombre del precio" }, "iva": { "type": "string", "description": "Valor del IVA para el precio" }, "base": { "type": "string", "description": "Valor de la base (Sin IVA) del precio" }, "fechaInicioVigencia": { "type": "string", "format": "date-time", "description": "Fecha de inicio de la vigencia del precio" }, "fechaFinVigencia": { "type": "string", "format": "date-time", "description": "Fecha de fin de la vigencia del precio" }, "categoria": { "type": "object", "properties":{ "sigla": { "type": "string", "description": "Nombre de la categoría de precio" } } }, "total": { "type": "object", "properties":{ "valor": { "type": "string", "description": "Valor total (incluye IVA) del precio" } } } } } } } } }, "requestBodies": { "cargoReservaRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cargoReservaRequest" } } }, "description": "Informacion para registrar clientes", "required": true }, "pagarReservaRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagarReservaRequest" } } }, "description": "Informacion para registrar clientes", "required": true }, "registrarDatosClienteRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registrarDatosClienteRequest" } } }, "description": "Informacion para registrar clientes", "required": true }, "actualizarMembresiaRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/actualizarMembresiaRequest" } } }, "description": "Informacion para registrar clientes", "required": true }, "inscribirMembresiaRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inscribirMembresiaRequest" } } }, "description": "Información de la fórmula médica", "required": true }, "reservarTurnoPracticaLibreRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reservarTurnoPracticaLibreRequest" } } }, "description": "Información de la fórmula médica", "required": true }, "disponibilidadPracticaLibreRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/disponibilidadPracticaLibreRequest" } } }, "description": "Información de la fórmula médica", "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" } } } } } } }