Skip to content

S
swagger
Commit f34ac9d0 by Cristian_Camargo
Options

Update recreacionyturismo-afiliados.json

parent a3e50420
Showing with 184 additions and 38 deletions
apigee/recreacionyturismo-afiliados.json
...@@ -223,8 +223,81 @@ ...@@ -223,8 +223,81 @@
] ]
} }
] ]
},
"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": "path",
"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"
]
}
]
} }
}, }
}, },
"externalDocs": { "externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect", "description": "Encontrar más información en EnterpriseArchitect",
...@@ -264,6 +337,68 @@ ...@@ -264,6 +337,68 @@
"name": "resultado" "name": "resultado"
} }
}, },
"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"
},
"cliente": {
"$ref": "#/components/schemas/cliente"
},
"servicio": {
"$ref": "#/components/schemas/servicio"
}
}
},
"TipoDocumento": {
"description": "Enumeración de tipos de documento soportados",
"type": "string",
"example": "CC",
"enum": [
"CC",
"CE",
"NIT",
"TI",
"PAS",
"FN",
"RC",
"NUIP",
"MSI",
"CD",
"PEP"
]
},
"cancelarReservaPracticaLibreResponse": { "cancelarReservaPracticaLibreResponse": {
"type": "object", "type": "object",
"required": [ "required": [
...@@ -382,10 +517,12 @@ ...@@ -382,10 +517,12 @@
"properties":{ "properties":{
"fechaInicio": { "fechaInicio": {
"type": "string", "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." "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": { "fechaFin": {
"type": "string", "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." "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": { "inmediato": {
...@@ -450,10 +587,12 @@ ...@@ -450,10 +587,12 @@
}, },
"fechaInicio": { "fechaInicio": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de inicio" "description": "Fecha de inicio"
}, },
"fechaFin": { "fechaFin": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de fin" "description": "Fecha de fin"
}, },
"tiquetera": { "tiquetera": {
...@@ -556,6 +695,7 @@ ...@@ -556,6 +695,7 @@
}, },
"fechaInicio": { "fechaInicio": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de inicio" "description": "Fecha de inicio"
}, },
"servicio": { "servicio": {
...@@ -790,6 +930,7 @@ ...@@ -790,6 +930,7 @@
}, },
"fecha": { "fecha": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha en la que se completó la transacción de pago" "description": "Fecha en la que se completó la transacción de pago"
}, },
"canal": { "canal": {
...@@ -853,14 +994,17 @@ ...@@ -853,14 +994,17 @@
}, },
"fechaCreacion": { "fechaCreacion": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de creación de la cotización" "description": "Fecha de creación de la cotización"
}, },
"fechaActualizacion": { "fechaActualizacion": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de actualización de la cotización" "description": "Fecha de actualización de la cotización"
}, },
"fechaExpiracion": { "fechaExpiracion": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de expiración de la cotización" "description": "Fecha de expiración de la cotización"
}, },
"usuario": { "usuario": {
...@@ -1096,10 +1240,12 @@ ...@@ -1096,10 +1240,12 @@
}, },
"fechaInicioVigencia": { "fechaInicioVigencia": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de inicio de la vigencia del precio" "description": "Fecha de inicio de la vigencia del precio"
}, },
"fechaFinVigencia": { "fechaFinVigencia": {
"type": "string", "type": "string",
"format": "date-time",
"description": "Fecha de fin de la vigencia del precio" "description": "Fecha de fin de la vigencia del precio"
}, },
"total": { "total": {
...@@ -1253,23 +1399,23 @@ ...@@ -1253,23 +1399,23 @@
}, },
"tiempoFijo": { "tiempoFijo": {
"type": "string", "type": "string",
"description": "Indicador que muestra si los usos aumentan el tiempo o solo el valor" "description": "Indicador que muestra si los usos aumentan el tiempo o solo el valor (Servicio tipo 2)"
}, },
"edadMinima": { "edadMinima": {
"type": "string", "type": "string",
"description": "Edad mínima con la cual se pueden registrar los participantes" "description": "Edad mínima con la cual se pueden registrar los participantes (Servicio tipo 2)"
}, },
"edadMaxima": { "edadMaxima": {
"type": "string", "type": "string",
"description": "Edad máxima con la cual se pueden registrar los participantes" "description": "Edad máxima con la cual se pueden registrar los participantes (Servicio tipo 2)"
}, },
"numeroSesiones": { "numeroSesiones": {
"type": "string", "type": "string",
"description": "Número de sesiones del beneficio principal plan de afiliación" "description": "Número de sesiones del beneficio principal plan de afiliación (Servicio tipo 3)"
}, },
"tiempo": { "tiempo": {
"type": "string", "type": "string",
"description": "Tiempo de duración en días del beneficio principal del plan de afiliación" "description": "Tiempo de duración en días del beneficio principal del plan de afiliación (Servicio tipo 3) "
}, },
"cupos": { "cupos": {
"type": "string", "type": "string",
...@@ -1277,21 +1423,21 @@ ...@@ -1277,21 +1423,21 @@
}, },
"pruebaTorneo": { "pruebaTorneo": {
"type": "string", "type": "string",
"description": "Flag que indica si este servicio habilita pruebas para inscripción a torneo." "description": "Flag que indica si este servicio habilita pruebas para inscripción a torneo (Servicio tipo 1)."
}, },
"fechaInicio": { "fechaInicio": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha de inicio." "description": "Fecha de inicio (Servicio tipo 1)."
}, },
"fechaFin": { "fechaFin": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha de fin." "description": "Fecha de fin (Servicio tipo 1)."
}, },
"beneficios": { "beneficios": {
"type": "array", "type": "array",
"description": "Lista del beneficio principal y secundarios del plan de afiliación.", "description": "Lista del beneficio principal y secundarios del plan de afiliación (Servicio tipo 3).",
"items":{ "items":{
"type": "object", "type": "object",
"properties":{ "properties":{
...@@ -1348,7 +1494,7 @@ ...@@ -1348,7 +1494,7 @@
"properties":{ "properties":{
"disponible": { "disponible": {
"type": "string", "type": "string",
"description": "Parametro que describe si el plan de afiliación tiene médico" "description": "Parametro que describe si el plan de afiliación tiene médico (Servicio tipo 3)"
} }
} }
}, },
...@@ -1357,7 +1503,7 @@ ...@@ -1357,7 +1503,7 @@
}, },
"dias": { "dias": {
"type": "array", "type": "array",
"description": "Se devolvera los dias que su valor sea 'true', los posibles pueden ser los siguientes:\n * lunes\n * martes\n * miercoles\n * jueves\n * viernes\n * entreSemana\n * finSemana", "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", "format": "string",
"enum": [ "enum": [
lunes, lunes,
...@@ -1376,7 +1522,7 @@ ...@@ -1376,7 +1522,7 @@
"properties":{ "properties":{
"descripcion": { "descripcion": {
"type": "string", "type": "string",
"description": "Género que aplica al centro de entrnamiento" "description": "Género que aplica al centro de entrnamiento (Servicio tipo 2)"
} }
} }
}, },
...@@ -1385,27 +1531,27 @@ ...@@ -1385,27 +1531,27 @@
"properties":{ "properties":{
"grupal": { "grupal": {
"type": "string", "type": "string",
"description": "Indicador que muestra si el turno aplica para varias personas al tiempo" "description": "Indicador que muestra si el turno aplica para varias personas al tiempo (Servicio tipo 2)"
}, },
"personas": { "personas": {
"type": "string", "type": "string",
"description": "Cantidad de personas máximas por turno" "description": "Cantidad de personas máximas por turno (Servicio tipo 2)"
}, },
"inmediato": { "inmediato": {
"type": "string", "type": "string",
"description": "Indicador que muestra si puede tener inicio inmediato el turno (dentro de los siguientes 5, 10 o 15 min)" "description": "Indicador que muestra si puede tener inicio inmediato el turno (dentro de los siguientes 5, 10 o 15 min) (Servicio tipo 2)"
}, },
"intervalo": { "intervalo": {
"type": "string", "type": "string",
"description": "Duración en minutos de cada cuanto se puede obtener turnos" "description": "Duración en minutos de cada cuanto se puede obtener turnos (Servicio tipo 2)"
}, },
"duracion": { "duracion": {
"type": "string", "type": "string",
"description": "Duración en minutos del turno" "description": "Duración en minutos del turno (Servicio tipo 2)"
}, },
"reserva": { "reserva": {
"type": "string", "type": "string",
"description": "Requiere reservar todos los turnos al momento de comprar. Por ejemplo para un pasadía" "description": "Requiere reservar todos los turnos al momento de comprar. Por ejemplo para un pasadía (Servicio tipo 3)"
} }
} }
}, },
...@@ -1424,11 +1570,11 @@ ...@@ -1424,11 +1570,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Id del centro de entrenamiento" "description": "Id del centro de entrenamiento (Servicio tipo 2-3-4)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre del centro de entrenamiento" "description": "Nombre del centro de entrenamiento (Servicio tipo 2-3-4) "
} }
} }
}, },
...@@ -1438,22 +1584,22 @@ ...@@ -1438,22 +1584,22 @@
"fechaInicioAntiguos": { "fechaInicioAntiguos": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha inicio de inscripcion para antiguos." "description": "Fecha inicio de inscripcion para antiguos (Servicio tipo 1)."
}, },
"fechaFinAntiguos": { "fechaFinAntiguos": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha fin de inscripcion para antiguos." "description": "Fecha fin de inscripcion para antiguos (Servicio tipo 1)."
}, },
"fechaInicioNuevos": { "fechaInicioNuevos": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha inicio de inscripcion para nuevos." "description": "Fecha inicio de inscripcion para nuevos (Servicio tipo 1)."
}, },
"fechaFinNuevos": { "fechaFinNuevos": {
"type": "string", "type": "string",
"format": "date-time", "format": "date-time",
"description": "Fecha fin de inscripcion para nuevos." "description": "Fecha fin de inscripcion para nuevos (Servicio tipo 1)."
}, },
} }
}, },
...@@ -1462,11 +1608,11 @@ ...@@ -1462,11 +1608,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador del área asociada al servicio tipo escuela" "description": "Identificador del área asociada al servicio tipo escuela (Servicio tipo 1)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre del área" "description": "Nombre del área (Servicio tipo 1)"
} }
} }
}, },
...@@ -1475,11 +1621,11 @@ ...@@ -1475,11 +1621,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador del nivel asociado al servicio tipo escuela" "description": "Identificador del nivel asociado al servicio tipo escuela (Servicio tipo 1)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre del nivel" "description": "Nombre del nivel (Servicio tipo 1)"
} }
} }
}, },
...@@ -1488,11 +1634,11 @@ ...@@ -1488,11 +1634,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador de la categoria asociada a servicio tipo escuela" "description": "Identificador de la categoria asociada a servicio tipo escuela (Servicio tipo 1)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre de la categoría de edad" "description": "Nombre de la categoría de edad (Servicio tipo 1)"
} }
} }
}, },
...@@ -1501,11 +1647,11 @@ ...@@ -1501,11 +1647,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador del ciclo de inscripción del servicio" "description": "Identificador del ciclo de inscripción del servicio (Servicio tipo 1)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre del ciclo de inscripción" "description": "Nombre del ciclo de inscripción (Servicio tipo 1)"
} }
} }
}, },
...@@ -1514,11 +1660,11 @@ ...@@ -1514,11 +1660,11 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador de la sede del servicio de tipo escuela" "description": "Identificador de la sede del servicio de tipo escuela (Servicio tipo 1)"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre de la sede del servicio" "description": "Nombre de la sede del servicio (Servicio tipo 1)"
} }
} }
}, },
...@@ -1527,15 +1673,15 @@ ...@@ -1527,15 +1673,15 @@
"properties":{ "properties":{
"id": { "id": {
"type": "string", "type": "string",
"description": "Identificador o id del material" "description": "Identificador o id del material (Servicio tipo 5)"
}, },
"tipo": { "tipo": {
"type": "string", "type": "string",
"description": "Tipo del material:\n * 1) Referencia\n * 2) Transporte\n * 3) Turno\n * 4) Articulo" "description": "Tipo del material (Servicio tipo 5):\n * 1) Referencia\n * 2) Transporte\n * 3) Turno\n * 4) Articulo"
}, },
"descripcion": { "descripcion": {
"type": "string", "type": "string",
"description": "Nombre del material" "description": "Nombre del material (Servicio tipo 5)"
} }
} }
}, },
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment