Skip to content

S
swagger
Commit 2b1bfc8f by Edgar Rosas
Options

Merge branch 'developer' of http://172.16.95.38:8081/gitlab/external/swagger into developer

parents 354e3a08 693fca72
Showing with 279 additions and 19 deletions
apigee/recreacionyturismo-afiliados.json
...@@ -27,9 +27,127 @@ ...@@ -27,9 +27,127 @@
{ {
"name": "cols-recreacionyturismo-afiliados", "name": "cols-recreacionyturismo-afiliados",
"description": "Informacion de afiliados." "description": "Informacion de afiliados."
},
{
"name": "cols-recreacionyturismo-gestionclientes",
"description": "Servicios para el manejo de clientes y sus membresías"
} }
], ],
"paths": { "paths": {
"/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"
}
},
"post": {
"tags": [
"cols-recreacionyturismo-gestionclientes"
],
"summary": "Registrar membresía",
"description": "Registrar la membresía de un cliente",
"operationId": "registrarMembresia.v1",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/registrarMembresiaResponse"
}
}
}
},
"400": {
"description": "Solicitud inválida"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/registrarMembresiaRequestBody"
}
},
"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": { "/v1/recreacionyturismo/afiliados/clientes": {
"post": { "post": {
"tags": [ "tags": [
...@@ -436,7 +554,7 @@ ...@@ -436,7 +554,7 @@
"required": true, "required": true,
"description": "Numero de documento de identificacion de la persona que se consulta el turno.", "description": "Numero de documento de identificacion de la persona que se consulta el turno.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -445,7 +563,7 @@ ...@@ -445,7 +563,7 @@
"required": true, "required": true,
"description": "cancelable.", "description": "cancelable.",
"schema": { "schema": {
"type": "boolean", "type": "boolean"
} }
}, },
{ {
...@@ -454,7 +572,7 @@ ...@@ -454,7 +572,7 @@
"required": true, "required": true,
"description": "Activo.", "description": "Activo.",
"schema": { "schema": {
"type": "boolean", "type": "boolean"
} }
}, },
{ {
...@@ -485,9 +603,9 @@ ...@@ -485,9 +603,9 @@
"required": false, "required": false,
"description": "Numero de identificacion del centro de entrenamiento.", "description": "Numero de identificacion del centro de entrenamiento.",
"schema": { "schema": {
"type": "integer", "type": "integer"
}
} }
},
], ],
"responses": { "responses": {
"200": { "200": {
...@@ -529,7 +647,7 @@ ...@@ -529,7 +647,7 @@
"required": true, "required": true,
"description": "Numero de documento de identificacion de la persona que se consulta la suscripcion.", "description": "Numero de documento de identificacion de la persona que se consulta la suscripcion.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -547,7 +665,7 @@ ...@@ -547,7 +665,7 @@
"required": false, "required": false,
"description": "Incluir suscripciones vencidas.", "description": "Incluir suscripciones vencidas.",
"schema": { "schema": {
"type": "boolean", "type": "boolean"
} }
} }
], ],
...@@ -591,7 +709,7 @@ ...@@ -591,7 +709,7 @@
"required": true, "required": true,
"description": "Numero de documento de identificacion de la reserva.", "description": "Numero de documento de identificacion de la reserva.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -600,7 +718,7 @@ ...@@ -600,7 +718,7 @@
"required": false, "required": false,
"description": "tipo de referencia.", "description": "tipo de referencia.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -609,7 +727,7 @@ ...@@ -609,7 +727,7 @@
"required": false, "required": false,
"description": "estado de la reserva.", "description": "estado de la reserva.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
} }
], ],
...@@ -653,7 +771,7 @@ ...@@ -653,7 +771,7 @@
"required": true, "required": true,
"description": "Numero de documento de identificacion.", "description": "Numero de documento de identificacion.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -662,7 +780,7 @@ ...@@ -662,7 +780,7 @@
"required": true, "required": true,
"description": "codigo de categoria.", "description": "codigo de categoria.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
}, },
{ {
...@@ -671,7 +789,7 @@ ...@@ -671,7 +789,7 @@
"required": false, "required": false,
"description": "estado de la reserva.", "description": "estado de la reserva.",
"schema": { "schema": {
"type": "string", "type": "string"
} }
} }
], ],
...@@ -911,9 +1029,7 @@ ...@@ -911,9 +1029,7 @@
"descripcion":{ "descripcion":{
"type": "string", "type": "string",
"description": "Descripcion de la Tarifa " "description": "Descripcion de la Tarifa "
}, }
} }
}, },
...@@ -1122,7 +1238,7 @@ ...@@ -1122,7 +1238,7 @@
} }
}, },
"direccionTitularDocumento":{ "direccionTitularDocumento":{
"type": "object", "type": "object",
"properties": { "properties": {
"tipo":{ "tipo":{
...@@ -1311,7 +1427,7 @@ ...@@ -1311,7 +1427,7 @@
}, },
"prestador": { "prestador": {
"$ref": "#/components/schemas/prestador" "$ref": "#/components/schemas/prestador"
}, }
} }
}, },
"centroEntrenamiento": { "centroEntrenamiento": {
...@@ -1576,7 +1692,7 @@ ...@@ -1576,7 +1692,7 @@
} }
} }
} }
}, }
} }
}, },
"reserva": { "reserva": {
...@@ -2254,6 +2370,31 @@ ...@@ -2254,6 +2370,31 @@
} }
} }
}, },
"actualizarMembresiaRequest": {
"type": "object",
"properties": {
"numeroCliente": {
"type": "string",
"description": "Número interno del cliente"
},
"estado": {
"type": "string",
"description": "<table border='1' width='10px'> <thead> <tr> <td colspan='2'><center>Tipos de estado</center></td> </tr> </thead> <tr> <th>Id</th> <th>Descripción</th> </tr> <tr> <td>ACTIVO</td> <td>Activa la membresía</td> </tr> <tr> <td>INACTIVO</td> <td>Inactiva la membresía</td></tr> </table>"
}
}
},
"registrarMembresiaRequest": {
"type": "object",
"properties": {
"numeroCliente": {
"type": "string",
"description": "Número interno del cliente"
},
"membresia": {
"$ref": "#/components/schemas/membresia"
}
}
},
"consultarDatosClienteResponse": { "consultarDatosClienteResponse": {
"type": "object", "type": "object",
"required": [ "required": [
...@@ -2300,6 +2441,64 @@ ...@@ -2300,6 +2441,64 @@
} }
} }
}, },
"actualizarMembresiaResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"registrarMembresiaResponse": {
"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": { "obtenerCliente": {
"type": "object", "type": "object",
"properties": { "properties": {
...@@ -2552,6 +2751,45 @@ ...@@ -2552,6 +2751,45 @@
} }
} }
}, },
"membresia": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identificador de la membresia"
},
"tipo": {
"type": "string",
"description": "Tipo de la membresía (A, B, C, D)"
},
"nombre": {
"type": "string",
"description": "Nombre del cliente de la membresía"
},
"fechaCaducidad": {
"type": "string",
"format": "date-time",
"description": "Fecha de caducidad de 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":"<table border='1' width='10px'> <thead> <tr> <td colspan='2'><center>Tipos de estado</center></td> </tr> </thead> <tr> <th>Id</th> <th>Descripción</th> </tr> <tr> <td>ACTIVO</td> <td>Activa la membresía</td> </tr> <tr> <td>INACTIVO</td> <td>Inactiva la membresía</td></tr> </table>"
}
}
},
"consultaCotizacionIdResponse": { "consultaCotizacionIdResponse": {
"type": "object", "type": "object",
"required": [ "required": [
...@@ -3502,6 +3740,28 @@ ...@@ -3502,6 +3740,28 @@
"description": "Informacion para registrar clientes", "description": "Informacion para registrar clientes",
"required": true "required": true
}, },
"actualizarMembresiaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actualizarMembresiaRequest"
}
}
},
"description": "Informacion para actualizar clientes",
"required": true
},
"registrarMembresiaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/registrarMembresiaRequest"
}
}
},
"description": "Informacion para registrar clientes",
"required": true
},
"inscribirMembresiaRequestBody": { "inscribirMembresiaRequestBody": {
"content": { "content": {
"application/json": { "application/json": {
......
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